R/esearch-count-int.R

In allanvc/mRpostman: An IMAP Client for R

#' Count the number of messages with an specific flag(s) in a
#'   folder (depend on ESEARCH capability) (INTERNAL HELPER)
#' @param flag Mandatory parameter that specifies one or more flags as a
#'   filter to the counting operation. Use \href{#method-list_flags}{\code{ImapCon$list_flags()}}
#'   to list the flags in a selected mail folder.
#' @param use_uid Default is \code{FALSE}. In this case, results will be
#'   presented as message's sequence numbers. A message sequence number is a
#'   message's relative position to the oldest message in the mailbox. It may
#'   change after deleting or moving messages. If a message is deleted,
#'   sequence numbers are reordered to fill the gap. If \code{TRUE}, the
#'   command will be performed using the \code{"UID"} or unique identifier,
#'   and results are presented as such. UIDs are always the same during the
#'   life cycle of a message.
#' @param retries Number of attempts to connect and execute the command.
#'   Default is \code{1}.
#' @noRd
esearch_count_int <- function(self, flag, use_uid = FALSE, retries = 1) {

  # checks
  check_args(flag = flag, use_uid = use_uid, retries = retries)

  # flag/name (especial)
  # if (!is.null(flag)) {
  flag_string <- paste(flag, collapse = " ") #v0.9.0 (for more than one flag passed)
  flag_string = paste0(flag_string, "") # different here because flag is the main parameter of search
  # } else {
  #   flag_string = NULL
  # }

  # forcing retries as an integer
  retries <- as.integer(retries)

  url <- self$con_params$url

  h <- self$con_handle

  # adding the SEARCH id RETURN COUNT customrequest
  if (isTRUE(use_uid)) {

    customrequest <- paste0("UID SEARCH RETURN (COUNT) ", flag_string)

  } else {

    customrequest <- paste0("SEARCH RETURN (COUNT) ", flag_string)

  }

  response <- execute_complementary_operations(self, url, handle = h, customrequest,
                                             retries)


  response <- as.numeric(as.character(
    stringr::str_match_all(
      string = rawToChar(response$content),
      pattern = "COUNT ([\\d]+)\r\n")[[1]][,2]))

  names(response) <- c("COUNT")
  # handle sanitizing
  rm(h)
  return(response)

}