R/select.R

Defines functions SELECT

Documented in SELECT

#' SELECT
#'
#' Select mailbox.
#'
#' @param imap imap object
#' @param folder mailbox name
#'
#' @return updated imap object
#' @export
#'
#' @examples
#' imap <- IMAP("imaps://imap.gmail.com") %>%
#'    SELECT("INBOX")
#'
#' \dontrun{
#'    imap %>% SEARCH("UNSEEN") %>% execute()
#' }
#'
SELECT <- function(imap, folder){
  imap$path <- escape_url_(folder)
  imap
}
crazycapivara/imapr documentation built on May 14, 2019, 11:32 a.m.