diff --git a/_pkgdown.yml b/_pkgdown.yml index d71acfb..cf207f8 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,4 +1,2 @@ url: ~ -template: - bootstrap: 5 diff --git a/docs/articles/basics.html b/docs/articles/basics.html index b8698c7..6cba432 100644 --- a/docs/articles/basics.html +++ b/docs/articles/basics.html @@ -4,8 +4,7 @@ - - + mRpostman basics • mRpostman @@ -13,11 +12,12 @@ - - - + + + - + + - - Skip to contents - - -
- - + +
+ + -
-
-

mRpostman basics

+
+
+
+

mRpostman basics

- Source: vignettes/basics.Rmd -
basics.Rmd
+ Source: vignettes/basics.Rmd + +
-
-

Introduction -

+
+

+Introduction

mRpostman is an easy-to-use IMAP client that provides tools for message searching, selective fetching of message attributes, mailbox management, attachment extraction, and several other IMAP @@ -106,26 +122,26 @@

Introduction“Migrating +syntax is available at “Migrating old code to the new mRpostman’s syntax”.

  • Old versions of the libcurl C library ({curl}’s main engine) will cause malfunctioning of this package. If your libcurl’s version is above 7.58.0, you should be fine. If you intend to use OAuth 2.0 authentication, then you will need libcurl >= 7.65.0. To know more -about the OAuth 2.0 authentication in this package, refer to the “Using +about the OAuth 2.0 authentication in this package, refer to the “Using IMAP OAuth2.0 authentication in mRpostman” vignette.

    • -
    -

    Authentication -

    +
    +

    +Authentication

    There are two ways of connecting to your IMAP server: using plain or OAuth2.0 authentication. In this vignette, we only describe the plain authentication process. If you want to use OAuth2.0 authentication, please read the aforementioned vignette.

    -
    -

    Allowing less secure apps access -

    +
    +

    +Allowing less secure apps access

    When using plain authentication, most of the mail providers will require the user to enable less secure apps access. Once it is done, you will be able to access your mailbox using a “third @@ -136,9 +152,9 @@

    Allowing less secure apps access

    -
    -

    Package Structure -

    +
    +

    +Package Structure

    The package is now implemented under a OO framework, using an R6 class. The main functionalities of mRpostman are implemented as methods of the R6 class called ImapCon. @@ -172,7 +188,7 @@

    Package Structuresearch(); +search();
    • relational operators functions: AND(), OR();
      • @@ -203,14 +219,14 @@

      Package Structure -

      1) How do I start? (Connection configuration) -

      +
      +

      +1) How do I start? (Connection configuration)

      After enabling (if needed) “less secure apps access” in your mail provider or obtaining an OAuth2.0 token, you have to configure an IMAP connection:

      -library(mRpostman)
+library(mRpostman)
 
 # IMAP settings
 
@@ -218,42 +234,42 @@ 
      1) How do I start? (Connection
 con <- configure_imap(
   url="imaps://outlook.office365.com",
   username="user@your_company.com",
-  password=rstudioapi::askForPassword()
+  password=rstudioapi::askForPassword()
   )
 
 # Gmail
 con <- configure_imap(
   url = "imaps://imap.gmail.com",
   username = "user",
-  password = rstudioapi::askForPassword()
+  password = rstudioapi::askForPassword()
   )
 
 # Hotmail
 con <- configure_imap(
   url = "imaps://imap-mail.outlook.com",
   username = "user@hotmail.com",
-  password = rstudioapi::askForPassword()
+  password = rstudioapi::askForPassword()
   )
 
 # Yahoo Mail
 con <- configure_imap(
   url="imaps://imap.mail.yahoo.com/",
   username="your_user",
-  password=rstudioapi::askForPassword()
+  password=rstudioapi::askForPassword()
   )
 
 # AOL Mail
 con <- configure_imap(
   url="imaps://export.imap.aol.com/",
   username="your_user",
-  password=rstudioapi::askForPassword()
+  password=rstudioapi::askForPassword()
   )
 
 # Yandex Mail
 con <- configure_imap(
   url="imaps://imap.yandex.com",
   username="your_user",
-  password=rstudioapi::askForPassword()
+  password=rstudioapi::askForPassword()
   )
 
 # ... and any other mail provider with IMAP support
      @@ -261,7 +277,7 @@

      1) How do I start? (Connection verbose = TRUE, buffersize. Further {curl} options related to IMAP functionalities can be passed to configure_imap(), but you probably won’t need it. See -curl::curl_options().

      +curl::curl_options().

      Since version 0.9.0.0, this package provides more flexibility to the user in the sense that you can modify the connection parameters for specific commands or parts of a script, using the @@ -283,9 +299,9 @@

      1) How do I start? (Connection this together provides an elegant way of accessing your IMAP provider, searching and fetching emails, and managing your mailbox as well.

      -
      -

      2) Server capabilities -

      +
      +

      +2) Server capabilities

      Once the connection is configured, it is important to know which capabilities your IMAP provider offers to users. This impacts on which type of operations you are allowed to perform. For example, if your @@ -301,27 +317,27 @@

      2) Server capabilities
       con$list_server_capabilities()

      -
      -

      3) Mailbox commands -

      -
      -

      3.1) Listing folders -

      +
      +

      +3) Mailbox commands

      +
      +

      +3.1) Listing folders

       con$list_mail_folders()
      -
      -

      3.2) Creating a new folder -

      +
      +

      +3.2) Creating a new folder

       con$create_folder(name = "New Folder")

      Except for examine_folder() and rename_folder(), from now on, you will have to select a folder to issue further commands.

      -
      -

      3.3) Selecting a folder -

      +
      +

      +3.3) Selecting a folder

       con$select_folder(name = "INBOX")

      Probably, the main folder in your mailbox will be the @@ -329,9 +345,9 @@

      3.3) Selecting a folder

      -
      -

      3.4) Examining a folder -

      +
      +

      +3.4) Examining a folder

      Count the number of existent and recent messages in the previously selected folder.

      @@ -344,9 +360,9 @@ 
      3.4) Examining a folder
       con$examine_folder(name = "Sent")
      -
      -

      3.5) Renaming a folder -

      +
      +

      +3.5) Renaming a folder

      The following will rename the selected folder.

       con$select_folder(name = "CRAN Messages")
@@ -361,9 +377,9 @@ 
      3.5) Renaming a folder
       con$rename_folder(name = "Sent", new_name = "Sent2")
      -
      -

      3.6) Flags listing -

      +
      +

      +3.6) Flags listing

      Flags work like tags or labels attached to messages. After a mail folder is selected, you can check which flags are available, and if you are allowed to set custom flags of your own in this folder with @@ -372,9 +388,9 @@

      3.6) Flags listingcon$list_flags()

      -
      - +

    +
    + -
    -

    -

    Developed by Allan Quadros.

    + +
    +

    Developed by Allan Quadros.

    -
    -

    -

    Site built with pkgdown 2.0.7.

    +
    +

    Site built with pkgdown 1.6.1.

    -
    +
    - diff --git a/docs/articles/code_migration.html b/docs/articles/code_migration.html index 240880b..5620ee5 100644 --- a/docs/articles/code_migration.html +++ b/docs/articles/code_migration.html @@ -4,8 +4,7 @@ - - + Migrating old code to the new mRpostman's syntax • mRpostman @@ -13,11 +12,12 @@ - - - + + + - + + - - Skip to contents - - -
    - - + +
    + + -
    -
    -

    Migrating old code to the new mRpostman's syntax

    +
    +
    +
    +

    Migrating old code to the new mRpostman’s +syntax

    - Source: vignettes/code_migration.Rmd -
    code_migration.Rmd
    + Source: vignettes/code_migration.Rmd + +
    @@ -101,9 +118,9 @@ -
    -

    Introduction -

    +
    +

    +Introduction

    This vignette aims to provide an easy source of code migration examples so old mRpostman users can transition between the old version and the new format which implements an OO approach trough @@ -140,18 +157,18 @@

    Introduction -

    1) Configuring the IMAP connection -

    +
    +

    +1) Configuring the IMAP connection

    Previous code:

    -library(mRpostman)
+library(mRpostman)
 
 # Outlook - Office 365
 imapconf <- configure_imap(url="imaps://outlook.office365.com",
                            username="your_user@company.com",
-                           password=rstudioapi::askForPassword())
+                           password=rstudioapi::askForPassword())
 
 # other mail providers that were tested: Gmail (imaps://imap.gmail.com), 
 #   Hotmail ("imaps://imap-mail.outlook.com"), Yahoo (imaps://imap.mail.yahoo.com/), 
@@ -159,17 +176,17 @@ 
    1) Configuring the IMAP connection
    
 
    New format:
    
 
    -library(mRpostman)
+library(mRpostman)
 
 # Outlook - Office 365
 con <- configure_imap(url="imaps://outlook.office365.com",
                       username="your_user@company.com",
-                      password=rstudioapi::askForPassword())
+                      password=rstudioapi::askForPassword())
 
 # alternative
 con <- ImapCon$new(url="imaps://outlook.office365.com",
                    username="your_user@company.com",
-                   password=rstudioapi::askForPassword())
    
+                   password=rstudioapi::askForPassword())

    Although the object that is created is different (now we have an R6 ImapCon class), the code to create a connection object is @@ -179,36 +196,36 @@

    1) Configuring the IMAP connectionverbose = TRUE, and buffersize. Further ‘curl’ options related to IMAP functionalities can be passed to configure_imap(), depending on the libcurl version -installed on the user’s machine. See curl::curl_options(). +installed on the user’s machine. See curl::curl_options(). In this new version, there is an important curl parameter exposed, xoauth2_bearer, which enables OAuth2.0 authentication. For -more details, check the “IMAP +more details, check the “IMAP OAuth2.0 authentication in mRpostman” vignette.

    -
    -

    2) Listing Server Capabilities -

    +
    +

    +2) Listing Server Capabilities

    Previous code:

    -imapconf %>%
+imapconf %>%
   list_server_capabilities()

    New format:

     con$list_server_capabilities()
    -
    -

    3) Mailbox Commands -

    -
    -

    3.1) Listing mail folders -

    +
    +

    +3) Mailbox Commands

    +
    +

    +3.1) Listing mail folders

    Previous code:

     # Listing
-imapconf %>%
+imapconf %>%
   list_mailboxes()

    New format:

    @@ -216,27 +233,27 @@ 
    3.1) Listing mail folderscon$list_folders()
    -
    -

    3.2) Folder selection -

    +
    +

    +3.2) Folder selection

    Previous code:

    -imapconf %>%
+imapconf %>%
   select_mailbox(mbox = "INBOX") # only INBOX is case sensitive

    New format:

     con$select_folder(name = "INBOX")
    -
    -

    3.3) Examining a mail folder -

    +
    +

    +3.3) Examining a mail folder

    Previous code:

    -imapconf %>%
-  select_mailbox(mbox = "K-State") %>%
+imapconf %>%
+  select_mailbox(mbox = "K-State") %>%
   examine_mailbox()

    New format:

    -
    -

    3.4) Renaming a mail folder -

    +
    +

    +3.4) Renaming a mail folder

    Previous code:

    -imapconf %>%
-  select_mailbox(mbox = "CRAN messages") %>%
-  rename_mailbox(new_name = "CRAN messages2") %>%
+imapconf %>%
+  select_mailbox(mbox = "CRAN messages") %>%
+  rename_mailbox(new_name = "CRAN messages2") %>%
   list_mailboxes() # and list again to check



    New format:

    @@ -268,15 +285,15 @@

    3.4) Renaming a mail folder

    -
    - +

    +
    - diff --git a/docs/articles/index.html b/docs/articles/index.html index 9ce08a5..5a4c26d 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -1,83 +1,177 @@ + -Articles • mRpostman - Skip to contents - + + + + + + +Articles • mRpostman + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -
    -
    -

    Articles

    +
    +
    +

    Articles

    All vignettes

    -
    mRpostman basics
    -
    -
    Migrating old code to the new mRpostman's syntax
    -
    -
    IMAP OAuth2.0 authentication in mRpostman
    -
    -
    -
    +
    +
    mRpostman basics
    +
    +
    Migrating old code to the new mRpostman's syntax
    +
    +
    IMAP OAuth2.0 authentication in mRpostman
    +
    +
    +
    + + -
    -

    Developed by Allan Quadros.

    +
    +
    +

    Developed by Allan Quadros.

    -
    -

    Site built with pkgdown 2.0.7.

    +
    +

    Site built with pkgdown 1.6.1.

    -
    +
    + - - + + + diff --git a/docs/articles/xoauth2.0.html b/docs/articles/xoauth2.0.html index 0f25f4b..951df74 100644 --- a/docs/articles/xoauth2.0.html +++ b/docs/articles/xoauth2.0.html @@ -4,8 +4,7 @@ - - + IMAP OAuth2.0 authentication in mRpostman • mRpostman @@ -13,11 +12,12 @@ - - - + + + - + + - - Skip to contents - - -
    - - + +
    + + -
    -
    -

    IMAP OAuth2.0 authentication in mRpostman

    +
    +
    +
    +

    IMAP OAuth2.0 authentication in mRpostman

    - Source: vignettes/xoauth2.0.Rmd -
    xoauth2.0.Rmd
    + Source: vignettes/xoauth2.0.Rmd + +
    @@ -101,9 +117,9 @@ -
    -

    Introduction -

    +
    +

    +Introduction

    More and more mail providers are adopting the OAuth2.0 authentication as for their preferred method. Although there may be some pain involved in the process of configuring and obtaining an access token, it is a @@ -121,38 +137,38 @@

    Introduction< or above installed, you should be fine. Therefore, we recommend checking to which libcurl version, the curl R package is linked by executing:

     -
    ## $version
-## [1] "7.68.0"
-## 
-## $ssl_version
-## [1] "OpenSSL/1.1.1f"
-## 
-## $libz_version
-## [1] "1.2.11"
-## 
-## $libssh_version
-## [1] "libssh/0.9.3/openssl/zlib"
-## 
-## $libidn_version
-## [1] "2.2.0"
-## 
-## $host
-## [1] "x86_64-pc-linux-gnu"
-## 
-## $protocols
-##  [1] "dict"   "file"   "ftp"    "ftps"   "gopher" "http"   "https"  "imap"  
-##  [9] "imaps"  "ldap"   "ldaps"  "pop3"   "pop3s"  "rtmp"   "rtsp"   "scp"   
-## [17] "sftp"   "smb"    "smbs"   "smtp"   "smtps"  "telnet" "tftp"  
-## 
-## $ipv6
-## [1] TRUE
-## 
-## $http2
-## [1] TRUE
-## 
-## $idn
-## [1] TRUE
    +curl::curl_version()

    +
    ## $version
+## [1] "7.68.0"
+## 
+## $ssl_version
+## [1] "OpenSSL/1.1.1f"
+## 
+## $libz_version
+## [1] "1.2.11"
+## 
+## $libssh_version
+## [1] "libssh/0.9.3/openssl/zlib"
+## 
+## $libidn_version
+## [1] "2.2.0"
+## 
+## $host
+## [1] "x86_64-pc-linux-gnu"
+## 
+## $protocols
+##  [1] "dict"   "file"   "ftp"    "ftps"   "gopher" "http"   "https"  "imap"  
+##  [9] "imaps"  "ldap"   "ldaps"  "pop3"   "pop3s"  "rtmp"   "rtsp"   "scp"   
+## [17] "sftp"   "smb"    "smbs"   "smtp"   "smtps"  "telnet" "tftp"  
+## 
+## $ipv6
+## [1] TRUE
+## 
+## $http2
+## [1] TRUE
+## 
+## $idn
+## [1] TRUE

    The steps involved in configuring and obtaining an OAuth2.0 access token can be summarized as follows:

      @@ -176,10 +192,10 @@

      Introduction<

    -
    -

    Step 1 - Creating a new API project -

    -

    Using your web browser, log into the page: https://console.developers.google.com/apis/. Assuming +

    +

    +Step 1 - Creating a new API project

    +

    Using your web browser, log into the page: https://console.developers.google.com/apis/. Assuming that you don’t have any pre-existent project, you should see this page:

    @@ -190,9 +206,9 @@

    Step 1 - Creating a new API project

    After a few seconds, the project is created.

    -
    -

    Step 2 - Creating new credentials -

    +
    +

    +Step 2 - Creating new credentials

    Once the project is created, we move to the credentials part.

    Click on “CREDENTIALS” in the menu on the left:

    @@ -211,9 +227,9 @@

    Step 2 - Creating new credentials

    Scroll down the page and click “CREATE”.

    -
    -

    Step 3 - Saving the credentials -

    +
    +

    +Step 3 - Saving the credentials

    On the following page, you have your key and client information.

    Copy the information above to an R script:

    @@ -224,18 +240,18 @@

    Step 3 - Saving the credentialsIn this same script, we use the httr package to configure and obtain our token.

    -
    -

    Step 4 - Using the httr package to retrieve the -token -

    +
    +

    +Step 4 - Using the httr package to retrieve the +token

    Now, we need an endpoint, an app configuration, and a scope, which is circumscribed to Gmail. The httr package has some pre-set endpoints for Google, Yahoo, and other APIs. So, it is very straightforward to define one with httr.

    -endpoint <- httr::oauth_endpoints("google")
+endpoint <- httr::oauth_endpoints("google")
 
-gmail_app <- httr::oauth_app(
+gmail_app <- httr::oauth_app(
   "xpto-allan",
   key = key,
   secret = secret
@@ -243,7 +259,7 @@ 
    Step 4 - Using th
 
 scope <- "https://mail.google.com/"
 
-auth_code <- httr::oauth2.0_token(endpoint, app = gmail_app, scope = scope)
    +auth_code <- httr::oauth2.0_token(endpoint, app = gmail_app, scope = scope)

    As it is the first time you are trying to access your account using the OAuth2.0 token, you’ll be prompted about caching your credentials on a local file.

    @@ -258,9 +274,9 @@

    Step 4 - Using th “Authentication complete. Please close this page and return to R”.

    -
    -

    Step 5 - Testing the IMAP connection -

    +
    +

    +Step 5 - Testing the IMAP connection

    Now we can test our IMAP connection with mRpostman, using the xoauth2_bearer argument in configure_imap():

    @@ -274,7 +290,7 @@

    Step 5 - Testing the IMAP connecti token <- auth_code$credentials$access_token

    Finally, we configure an IMAP connection and test it:

    -library(mRpostman)
+library(mRpostman)
 con <- configure_imap(url="imaps://imap.gmail.com",
                       username = "user@gmail.com",
                       use_ssl = TRUE,
@@ -283,13 +299,13 @@ 
    Step 5 - Testing the IMAP connecti
                       )
 
 con$list_server_capabilities()
    -
    ##  [1] "IMAP4rev1"            "UNSELECT"             "IDLE"                
-##  [4] "NAMESPACE"            "QUOTA"                "ID"                  
-##  [7] "XLIST"                "CHILDREN"             "X-GM-EXT-1"          
-## [10] "UIDPLUS"              "COMPRESS=DEFLATE"     "ENABLE"              
-## [13] "MOVE"                 "CONDSTORE"            "ESEARCH"             
-## [16] "UTF8=ACCEPT"          "LIST-EXTENDED"        "LIST-STATUS"         
-## [19] "LITERAL-"             "SPECIAL-USE"          "APPENDLIMIT=35651584"
    +
    ##  [1] "IMAP4rev1"            "UNSELECT"             "IDLE"                
+##  [4] "NAMESPACE"            "QUOTA"                "ID"                  
+##  [7] "XLIST"                "CHILDREN"             "X-GM-EXT-1"          
+## [10] "UIDPLUS"              "COMPRESS=DEFLATE"     "ENABLE"              
+## [13] "MOVE"                 "CONDSTORE"            "ESEARCH"             
+## [16] "UTF8=ACCEPT"          "LIST-EXTENDED"        "LIST-STATUS"         
+## [19] "LITERAL-"             "SPECIAL-USE"          "APPENDLIMIT=35651584"

    If you got some kind of “SASL …” error in the information flow between the server and mRpostman, your libcurl version may be older than the 7.65 we mentioned in the Introduction. @@ -298,27 +314,27 @@

    Step 5 - Testing the IMAP connecti curl R package is pointing to an older version of libcurl in your disk. In this case, you’ll have to dig on the internet how to solve it.

    -
    -

    Step 6 - Refreshing the token -

    +
    +

    +Step 6 - Refreshing the token

    For future sessions (or after a considerable span of time) you’ll need to refresh the previous token. You can use the following function below to achieve that:

     # thanks to jdeboer code at https://github.com/r-lib/httr/issues/31
 oauth2.0_refresh <- function(endpoint, app, auth_code, type = NULL) {
-  req <- httr::POST(
+  req <- httr::POST(
     url = endpoint$access,
     multipart = FALSE,
-    body = list(
+    body = list(
       client_id = app$key,
       client_secret = app$secret,
       grant_type = "refresh_token",
       refresh_token = auth_code$credentials$refresh_token
     )
   )
-  content_out <- httr::content(req, type = type)
-  content_out <- c(content_out, auth_code$credentials$access_token)
+  content_out <- httr::content(req, type = type)
+  content_out <- c(content_out, auth_code$credentials$access_token)
 }
 
 auth_code_new <- oauth2.0_refresh(endpoint, app=gmail_app, auth_code=auth_code)
@@ -327,28 +343,31 @@ 
    Step 6 - Refreshing the tokenconfigure_imap() and you are done.
    -
    +
    + + + -
    -

    -

    Developed by Allan Quadros.

    +
    +

    Developed by Allan Quadros.

    -
    -

    -

    Site built with pkgdown 2.0.7.

    +
    +

    Site built with pkgdown 1.6.1.

    -
    +
    - diff --git a/docs/authors.html b/docs/authors.html index 24773b1..5c9bceb 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -1,98 +1,173 @@ + -Authors and Citation • mRpostman - Skip to contents - + + + + + + +Authors • mRpostman + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -
    -
    -

    Authors and Citation

    +
    +
    +

    Authors

    -
    -

    Authors

    - -
    • -

      Allan Quadros. Author, maintainer. -

      -
      • -
    - -
    -

    Citation

    -

    Source: DESCRIPTION

    - -

    Quadros A (2023). -mRpostman: An IMAP Client for R. -R package version 1.1.1, https://allanvc.github.io/mRpostman/. -

    - 
    @Manual{,
-  title = {mRpostman: An IMAP Client for R},
-  author = {Allan Quadros},
-  year = {2023},
-  note = {R package version 1.1.1},
-  url = {https://allanvc.github.io/mRpostman/},
-}
    -
    -
    +
      +
    • +

      Allan Quadros. Author, maintainer. +

      +
      • +
    + +
    + + + -
    -

    Developed by Allan Quadros.

    +
    +
    +

    Developed by Allan Quadros.

    -
    -

    Site built with pkgdown 2.0.7.

    +
    +

    Site built with pkgdown 1.6.1.

    -
    +
    + - - + + + diff --git a/docs/index.html b/docs/index.html index 3e877ef..532e58e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -4,10 +4,7 @@ - - + An IMAP Client for R • mRpostman @@ -15,11 +12,12 @@ - - - + + + - + + @@ -29,61 +27,80 @@ - - Skip to contents - - -
    -
    -
    -
    -

    mRpostman -

    +
    + + + + +
    +
    +
    +

    +mRpostman + +

    @@ -91,146 +108,203 @@

    An IMAP Client for R

    -
    -

    Overview -

    -

    mRpostman is an easy-to-use IMAP client that provides tools for message searching, selective fetching of message attributes, mailbox management, attachment extraction, and several other IMAP features. The aim of this package is to pave the way for email data analysis in R. To do so, mRpostman makes extensive use of the {curl} package and the libcurl C library.

    -

    mRpostman’s official website: https://allanvc.github.io/mRpostman/

    +
    +

    +Overview

    +

    mRpostman is an easy-to-use IMAP client that provides +tools for message searching, selective fetching of message attributes, +mailbox management, attachment extraction, and several other IMAP +features. The aim of this package is to pave the way for email data +analysis in R. To do so, mRpostman makes extensive use of +the {curl} package and the libcurl C library.

    +

    mRpostman’s official website: https://allanvc.github.io/mRpostman/

    IMPORTANT:

    -
      -

    1. In version 0.9.0.0, mRpostman went trough substantial changes, including ones that have no backward compatibility with versions <= 0.3.1. A detailed vignette on how to migrate your mRpostman’s deprecated code to the new syntax is available at “Migrating old code to the new mRpostman’s syntax”.

      2. -

    2. Old versions of the libcurl C library ({curl}’s main engine) will cause the malfunction of this package. If your libcurl’s version is above 7.58.0, you should be fine. In case you intend to use OAuth 2.0 authentication, then you will need libcurl >= 7.65.0. To learn more about the OAuth 2.0 authentication in this package, refer to the “Using IMAP OAuth2.0 authentication in mRpostman” vignette.

      3. +
        +

      1. In version 0.9.0.0, mRpostman went +trough substantial changes, including ones that have no backward +compatibility with versions <= 0.3.1. A detailed +vignette on how to migrate your mRpostman’s deprecated code to the new +syntax is available at “Migrating +old code to the new mRpostman’s syntax”.

        2. +

      2. Old versions of the libcurl C library ({curl}’s main engine) will +cause the malfunction of this package. If your libcurl’s version is +above 7.58.0, you should be fine. In case you intend to use OAuth 2.0 +authentication, then you will need libcurl >= 7.65.0. To learn more +about the OAuth 2.0 authentication in this package, refer to the “Using +IMAP OAuth2.0 authentication in mRpostman” vignette.

    -
    -

    Authentication -

    -

    There are two ways of connecting to your IMAP server: using plain or OAuth2.0 authentication. Here, we only describe the plain authentication process. If you want to use OAuth2.0 authentication, please read the aforementioned vignette.

    -
    -

    Allowing less secure apps access -

    -

    When using plain authentication, most of the mail providers will require the user to enable less secure apps access. Once it is done, you will be able to access your mailbox using a “third party app” as mRpostman.

    -
    -
    -

    Plain authentication -

    -

    Before using mRpostman, it is essential to configure the access to your email account. Various mail providers require that you enable “less secure apps” access to accept plain authentication between the IMAP server and a third-party app.

    -

    Let’s see how to configure simple plain authentication for Gmail, Yahoo Mail, AOL Mail, Hotmail, and Office 365.

    -
    -

    Outlook - Office 365 -

    -

    There is no need to execute any external configuration. Please, note that the url parameter in configure_imap() should be set as url = "imaps://outlook.office365.com", and the username should be set as user@yourcompany.com.

    -
    -
    -

    Hotmail -

    -

    There is no need to execute any external configuration. Please, note that the url parameter in configure_imap() should be set as url = "imaps://imap-mail.outlook.com", and the username should be set as user@hotmail.com.

    -
    -
    -

    Gmail -

    -
      -

    1. Go to the Gmail website and log in with your credentials.

      2. -

    2. Then, go to https://myaccount.google.com/u/1/lesssecureapps?pageId=none

      3. -
    +
    +

    +Authentication

    +

    There are two ways of connecting to your IMAP server: using plain or +OAuth2.0 authentication. Here, we only describe the plain authentication +process. If you want to use OAuth2.0 authentication, please read the +aforementioned vignette.

    +
    +

    +Allowing less secure apps access

    +

    When using plain authentication, most of the mail providers will +require the user to enable less secure apps access. +Once it is done, you will be able to access your mailbox using a “third +party app” as mRpostman.

    +
    +
    +

    +Plain authentication

    +

    Before using mRpostman, it is essential to configure the +access to your email account. Various mail providers require that you +enable “less secure apps” access to accept plain +authentication between the IMAP server and a third-party app.

    +

    Let’s see how to configure simple plain authentication for Gmail, +Yahoo Mail, AOL Mail, Hotmail, and Office 365.

    +
    +

    +Outlook - Office 365

    +

    There is no need to execute any external configuration. Please, note +that the url parameter in configure_imap() +should be set as url = "imaps://outlook.office365.com", and +the username should be set as +user@yourcompany.com.

    +
    +
    +

    +Hotmail

    +

    There is no need to execute any external configuration. Please, note +that the url parameter in configure_imap() +should be set as url = "imaps://imap-mail.outlook.com", and +the username should be set as +user@hotmail.com.

    +
    +
    +

    +Gmail

    +

    1) Go to the Gmail website and log in with your credentials.

    +

    2) Then, go to https://myaccount.google.com/u/1/lesssecureapps?pageId=none

    -
      -
    1. Set “Allow less secure apps” to ON.
      2. -
    +

    3) Set “Allow less secure apps” to ON.

    -
    -

    Yahoo Mail -

    -
      -

    1. Go to the Yahoo Mail website and log in with your credentials.

      2. -

    2. Click on “Account Info”.

      3. -
    +
    +

    +Yahoo Mail

    +

    1) Go to the Yahoo Mail website and log in with your credentials.

    +

    2) Click on “Account Info”.

    -
      -
    1. Click on “Account Security” on the left menu.
      2. -
    +

    3) Click on “Account Security” on the left menu.

    -
      -
    1. Then, set “Allow apps that use less secure sign in” ON -
      2. -
    +

    4) Then, set “Allow apps that use less secure sign in” +ON

    -
    -

    AOL Mail -

    -
      -

    1. Go to the AOL Mail website and log in with your credentials.

      2. -

    2. Click on “Options” and then on “Account Info”.

      3. -
    +
    +

    +AOL Mail

    +

    1) Go to the AOL Mail website and log in with your credentials.

    +

    2) Click on “Options” and then on “Account Info”.

    -
      -
    1. Click on “Account Security” on the left menu.
      2. -
    +

    3) Click on “Account Security” on the left menu.

    -
      -
    1. After, set “Allow apps that use less secure sign in” ON -
      2. -
    +

    4) After, set “Allow apps that use less secure sign in” +ON

    -
    -

    Introduction -

    -

    From version 0.9.0.0 onward, mRpostman is implemented under the OO paradigm, based on an R6 class called ImapCon. Its derived methods, and a few independent functions enable the R user to perform a myriad of IMAP commands.

    -

    The package is divided in 8 groups of operations. Below, we present all the available methods and functions:

    +
    +

    +Introduction

    +

    From version 0.9.0.0 onward, mRpostman is implemented +under the OO paradigm, based on an R6 class called ImapCon. +Its derived methods, and a few independent functions enable the R user +to perform a myriad of IMAP commands.

    +

    The package is divided in 8 groups of operations. Below, we present +all the available methods and functions:

    • -configuration methods: configure_imap(), reset_url(), reset_username(), reset_password(), reset_verbose(), reset_use_ssl(), reset_buffersize(), reset_timeout_ms(), reset_xoauth2_bearer();
      • +configuration methods: +configure_imap(), reset_url(), +reset_username(), reset_password(), +reset_verbose(), reset_use_ssl(), +reset_buffersize(), reset_timeout_ms(), +reset_xoauth2_bearer();
    • -server capabilities method: list_server_capabilities();
      • +server capabilities method: +list_server_capabilities();
    • -mailbox operations methods: list_mail_folders(), select_folder(), examine_folder(), rename_folder(), create_folder(), list_flags();
      • +mailbox operations methods: +list_mail_folders(), select_folder(), +examine_folder(), rename_folder(), +create_folder(), list_flags();
    • -single-search methods: search_before(), search_since(), search_period(), search_on(), search_sent_before(),search_sent_since(), search_sent_period(), search_sent_on(), search_string(), search_flag(), search_smaller_than(), search_larger_than(), search_younger_than(), search_older_than();
      • +single-search methods: +search_before(), search_since(), +search_period(), search_on(), +search_sent_before(),search_sent_since(), +search_sent_period(), search_sent_on(), +search_string(), search_flag(), +search_smaller_than(), search_larger_than(), +search_younger_than(), +search_older_than();
    • -the custom-search method and its helper functions: search(); +the custom-search method and its helper functions: +search();
    • -fetch methods: fetch_body(), fetch_header(), fetch_text(), fetch_metadata(), fetch_attachments_list(), fetch_attachments();
      • +fetch methods: fetch_body(), +fetch_header(), fetch_text(), +fetch_metadata(), fetch_attachments_list(), +fetch_attachments();
    • -attachments methods: list_attachments(), get_attachments(), fetch_attachments_list(), fetch_attachments();
      • +attachments methods: +list_attachments(), get_attachments(), +fetch_attachments_list(), +fetch_attachments();
    • -complementary methods: copy_msg(), move_msg(), esearch_min_id(), esearch_max_id(), esearch_count_msg(), delete_msg(), expunge(), add_flags(), remove_flags(), replace_flags().
      • +complementary methods: copy_msg(), +move_msg(), esearch_min_id(), +esearch_max_id(), esearch_count_msg(), +delete_msg(), expunge(), +add_flags(), remove_flags(), +replace_flags().
    -
    -

    Installation -

    +
    +

    +Installation

     # CRAN version
-install.packages("mRpostman")
+install.packages("mRpostman")
 
 # Dev version
-if (!require('remotes')) install.packages('remotes')
-remotes::install_github("allanvc/mRpostman")
    -
    -
    -

    Basic Usage -

    -
    -

    1) Configure an IMAP connection and list the server’s capabilities -

    +if (!require('remotes')) install.packages('remotes') +remotes::install_github("allanvc/mRpostman")
    +
    +
    +

    +Basic Usage

    +
    +

    +1) Configure an IMAP connection and list the server’s +capabilities

     
-library(mRpostman)
+library(mRpostman)
 
 # Outlook - Office 365
 con <- configure_imap(url="imaps://outlook.office365.com",
                       username="your_user@company.com",
-                      password=rstudioapi::askForPassword()
+                      password=rstudioapi::askForPassword()
 )
 
 # other IMAP providers that were tested: Hotmail ("imaps://imap-mail.outlook.com"),
@@ -241,9 +315,9 @@ 
    1)
 
 con$list_server_capabilities()
    -
    -

    2) List mail folders and select “INBOX” -

    +
    +

    +2) List mail folders and select “INBOX”

     
 # Listing
@@ -252,18 +326,18 @@ 
    2) List mail folders and select
 # Selecting
 con$select_folder(name = "INBOX")
    -
    -

    3) Search messages by date -

    +
    +

    +3) Search messages by date

     
 res1 <- con$search_on(date_char = "02-Jan-2020")
 
 res1
    -
    -

    4) Customizing a search with multiple criteria -

    +
    +

    +4) Customizing a search with multiple criteria

    Executing a search by string:

     
@@ -275,150 +349,164 @@ 
    4) Customizing a searc
 
 res2
    -
    -

    5) Fetch messages’ text using single-search results -

    +
    +

    +5) Fetch messages’ text using single-search results

     
-res3 <- con$search_string(expr = "Welcome!", where = "SUBJECT") %>%
+res3 <- con$search_string(expr = "Welcome!", where = "SUBJECT") %>%
   con$fetch_text(write_to_disk = TRUE) # also writes results to disk
 
 res3
    -
    -

    6) Attachments -

    +
    +

    +6) Attachments

    You can list the attachments of one or more messages with:

    -
      -
    1. the list_attachments() function:
      2. -
    +

    1) the list_attachments() function:

     
-con$search_since(date_char = "02-Jan-2020") %>%
-  con$fetch_text() %>% # or with fetch_body()
+con$search_since(date_char = "02-Jan-2020") %>%
+  con$fetch_text() %>% # or with fetch_body()
   list_attachments() # does not depend on the 'con' object

    … or more directly with:

    -
      -
    1. fetch_attachments_list()
      2. -
    +

    2) fetch_attachments_list()

     
-con$search_since(date_char = "02-Jan-2020") %>%
+con$search_since(date_char = "02-Jan-2020") %>%
   con$fetch_attachments_list()
    -

    If you want to download the attachments of one or more messages, there are also two ways of doing that.

    -
      -
    1. Using the get_attachments() method:
      2. -
    +

    If you want to download the attachments of one or more messages, +there are also two ways of doing that.

    +

    1) Using the get_attachments() method:

     
-con$search_since(date_char = "02-Jan-2020") %>%
-  con$fetch_text() %>% # or with fetch_body()
+con$search_since(date_char = "02-Jan-2020") %>%
+  con$fetch_text() %>% # or with fetch_body()
   con$get_attachments()

    … and more directly with the

    -
      -
    1. -fetch_attachments() method:
      2. -
    +

    2) fetch_attachments() method:

     
-con$search_since(date_char = "02-Jan-2020") %>%
+con$search_since(date_char = "02-Jan-2020") %>%
   con$fetch_attachments()
    -
    -

    Future Improvements -

    +
    +

    +Future Improvements

    • add further IMAP features;
    • eliminate the {stringr} dependency in REGEX;
    • implement a progress bar in fetch operations;
    -
    -

    Known bugs -

    +
    +

    +Known bugs

      -

    • search results truncation: This is a libcurl’s known bug which causes the search results to be truncated when there is a large number of message ids returned. To circumvent this problem, you can set a higher buffersize value, increasing the buffer capacity, and verbose = TRUE for monitoring the server response for truncated results when executing a search. When possible, mRpostman tries to issue a warning for possible truncated values.

      • -

    • verbose = TRUE malfunction on Windows: This seems to be related to the {curl} R package. When using the verbose = TRUE on Windows, the flow of information between the IMAP server and the R session presents an intermittent behavior, which causes it to not be shown on the console, or with a considerable delay.

      • -

    • shared mailbox access not working: This seems to be another libcurl’s bug, although more tests need to be done to confirm it. It does not allow the user to connect to a shared mailbox. To circumvent this, if the shared mailbox has a password associated with it, you can try a direct regular connection.

      • -

    • xoauth2_bearer SASL error: This is related to old libcurl’s versions which causes the access token to not be properly passed to the server. This bug was fixed in libcurl 7.65.0. The problem is that many Linux distributions, such as Ubuntu 18.04, still provide libcurl 7.58.0 in their official distribution (libcurl4-openssl-dev). If you use a newer Linux distro such as Ubuntu 20.04, you should be fine as the distributed libcurl’s version will be above 7.65.0. Another alternative is to use plain authentication instead of OAuth2.0.

      • +

    • search results truncation: This is a libcurl’s +known bug which causes the search results to be truncated when there +is a large number of message ids returned. To circumvent this problem, +you can set a higher buffersize value, increasing the +buffer capacity, and verbose = TRUE for monitoring the +server response for truncated results when executing a search. When +possible, mRpostman tries to issue a warning for possible +truncated values.

      • +

    • verbose = TRUE malfunction on Windows: This +seems to be related to the {curl} R package. +When using the verbose = TRUE on Windows, the flow of +information between the IMAP server and the R session presents an +intermittent behavior, which causes it to not be shown on the console, +or with a considerable delay.

      • +

    • shared mailbox access not working: This seems to be +another libcurl’s bug, +although more tests need to be done to confirm it. It does not allow the +user to connect to a shared mailbox. To circumvent this, if the shared +mailbox has a password associated with it, you can try a direct regular +connection.

      • +

    • xoauth2_bearer SASL error: This is related +to old libcurl’s versions +which causes the access token to not be properly passed to the server. +This bug was fixed in libcurl 7.65.0. The problem is that many Linux +distributions, such as Ubuntu 18.04, still provide libcurl 7.58.0 in +their official distribution (libcurl4-openssl-dev). If you use a newer +Linux distro such as Ubuntu 20.04, you should be fine as the distributed +libcurl’s version will be above 7.65.0. Another alternative is to use +plain authentication instead of OAuth2.0.

    -
    -

    License -

    +
    +

    +License

    This package is licensed under the terms of the GPL-3 License.

    -
    -

    References -

    -

    Crispin, M. (2003), INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1, RFC 3501, March 2003, https://www.rfc-editor.org/rfc/rfc3501.

    -

    Heinlein, P. and Hartleben, P. (2008). The Book of IMAP: Building a Mail Server with Courier and Cyrus. No Starch Press. ISBN 978-1-59327-177-0.

    -

    Ooms, J. (2020), curl: A Modern and Flexible Web Client for R. R package version 4.3, https://CRAN.R-project.org/package=curl

    -

    Stenberg, D. Libcurl - The Multiprotocol File Transfer Library, https://curl.se/libcurl/

    +
    +

    +References

    +

    Crispin, M. (2003), INTERNET MESSAGE ACCESS PROTOCOL - VERSION +4rev1, RFC 3501, March 2003, https://www.rfc-editor.org/rfc/rfc3501.

    +

    Heinlein, P. and Hartleben, P. (2008). The Book of IMAP: Building +a Mail Server with Courier and Cyrus. No Starch Press. ISBN +978-1-59327-177-0.

    +

    Ooms, J. (2020), curl: A Modern and Flexible Web Client for +R. R package version 4.3, https://CRAN.R-project.org/package=curl

    +

    Stenberg, D. Libcurl - The Multiprotocol File Transfer +Library, https://curl.se/libcurl/

    -
    -
    -

    License

    + - diff --git a/docs/news/index.html b/docs/news/index.html index f197f7c..39c6466 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -1,230 +1,502 @@ + -Changelog • mRpostman + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Skip to contents - - -
    + + + + - -
    -
    -
    -

    Changelog

    - Source: NEWS.md +
    +
    +

    Changelog

    + Source: NEWS.md
    -
    -

    mRpostman 1.1.1 (2023-07-27 Github patch)

    -
    -

    Documentation

    -
    • changed unit test to Github Actions CI/CD
      • -
    -
    -
    -

    mRpostman 1.1.0 (2022-10-25 CRAN fix bump)

    CRAN release: 2022-10-27

    -
    -

    Documentation

    -
    • removed ‘LazyData’ line to fix CRAN check issue
      • -
    • added “\dontrun{}” to decode_mime_headers() in order to fix CRAN check issues
      • -
    • fixed bad URLs everywhere (tools.ietf.org/html/… ===> www.rfc-editor.org/rfc/…)
      • -
    -
    -

    Methods & Functions

    -
    • updated completion msg in all fetch methods to: "\n::mRpostman: fetch operation is complete.\n" -
      • -
    -
    -
    -

    mRpostman 1.0.2 (2021-04-14 Github patch)

    -
    -

    Documentation

    -
    • typos in list_attachments() +
      +

      +mRpostman 1.1.1 (2023-07-27 Github patch)

      +
      +

      +Documentation

      +
        +
      • changed unit test to Github Actions CI/CD
        • +
      +
      +
      +
      +
      +

      +mRpostman 1.1.0 (2022-10-25 CRAN fix bump)

      +
      +

      +Documentation

      +
        +
      • removed ‘LazyData’ line to fix CRAN check issue
        • +
      • added “\dontrun{}” to decode_mime_headers() in order to +fix CRAN check issues
        • +
      • fixed bad URLs everywhere (tools.ietf.org/html/… ===> +www.rfc-editor.org/rfc/…)
        • +
      +
      +
      +

      +Methods & Functions

      +
        +
      • updated completion msg in all fetch methods to: +"\n::mRpostman: fetch operation is complete.\n" +
        • +
      +
      +
      +
      +
      +

      +mRpostman 1.0.2 (2021-04-14 Github patch)

      +
      +

      +Documentation

      +
      -
      -

      Methods & Functions

      -
      • updated completion msg in all fetch methods to: "\n::mRpostman: fetch operation is complete.\n" +
      +
      +
      +

      +Methods & Functions

      +
        +
      • updated completion msg in all fetch methods to: +"\n::mRpostman: fetch operation is complete.\n"
        • -
      +
    +
    +
    -
    -

    mRpostman 1.0.1 (2021-01-13 Github patch)

    -
    -

    Documentation

    -
    • typos in documentation (“Basics” vignette)
      • +
      +

      +mRpostman 1.0.1 (2021-01-13 Github patch)

      +
      +

      +Documentation

      +
        +
      • typos in documentation (“Basics” vignette)
      • typos in the methods and functions documentation
      • updated figures in “Basics” vignette
        • -
      -
      -
      -

      mRpostman 1.0.0 (2020-11-29 CRAN update)

      CRAN release: 2020-11-30

      -
      -

      Changes

      -
      • incorporates all the changes/updates from GitHub patches 0.9.1-1 to 0.9.1-6.
        • -
      -
      -
      -

      mRpostman 0.9.1-6 (2020-11-28 Github patch)

      -
      -

      Changes

      -
      • modifies the behaviour for assigning names to the local folders. Instead of using the url, now the package uses the “/username/mailbox” as the ‘root’ directory for saving messages and attachments. For example: ./allanvcq@gmail.com/INBOX/UID1430/ instead of “imap.gmail.com/INBOX/UID1430”. This will allow users to better differentiate between local folders, when using different mailboxes in the same server.
        • -
      -
      -
      -

      mRpostman 0.9.1-5 (2020-11-18 Github patch)

      -
      -

      Bug fixes

      -
      • fixed the pattern8 regex in clean_fetch_results().
        • -
      -
      -
      -

      mRpostman 0.9.1-4 (2020-11-12 Github patch)

      -
      -

      New features

      -
      • changes the default value of the timeout_ms parameter to 0, which is the default value in libcurl, meaning that no timeout is specified.
        • -
      -
      -
      -

      mRpostman 0.9.1-3 (2020-11-08 Github patch)

      -
      -

      New features

      -

      • added the clean_msg_text() function. It will be particularly useful for cleaning and preparing message text retrieved with fetch_body(..., mime_level = 1). These texts can be used for sentiment analysis and other text mining tasks;

        • -

      • added internal functions decode_mime_text() and decode_quoted_printable_text(). The second is called by the first one;

        • -

      • renamed the original decode_quoted_printable called from decode_mime_header() to decode_quoted_printable_text();

        • -

      • included the xml2 and the rvest packages as dependencies because of the addition of the clean_msg_text().

        • -
      -
      -
      -

      mRpostman 0.9.1-2 (2020-11-01 Github patch)

      -
      -

      New features

      -
      • added the mime_level argument to the fetch_body() method. Now, the user can choose whether the fetch will retrieve the full body content or an specific one. This is particularly helpful for retrieving clean text parts without inline and regular attachments for instance.
        • -
      -
      -

      Bug fixes

      -

      • adapts to the new return pattern of MS Exchange IMAP servers without losing the compatibility with others;

        • -

      • fixed the misbehavior for the attachment fetching of message in message attachments. Now, either fetch_attachments() and fetch_text/body() + get_attachments() combo can handle this specific case;

        • -

      • changed the attachment identification to the “name” field instead of the “filename”. In very rare cases, the “filename” field identification fails because of encoding errors on the sender’s side;

        • -

      • incorrect decoding of ordinary words (such as “ResearchGate”, for instance) in decode_mime_header().

        • -
      -
      -

      Changes without backward compatibility

      -
      • The default argument in all reset_*() methods now are x in order to prevent wordy method calls and repetition. The older ones were deprecated in this version.
        • -
      -
      -
      -

      mRpostman 0.9.1-1 (2020-10-26 Github patch)

      -
      -

      Main features

      -
      • added RFC 2047 quoted-printable and base64 MIME header decoder
        • -
      -
      -

      Functions & methods

      -
      • added the decode_mime_header() function -
        • it is used inside get_attachments() and fetch_attachments() for correctly setting the filenames
          • -
        • it is also exported for the user in order to be used for a header decoding operation after fetching metadata, for example.
          • +
        +
        +
      +
      +
      +

      +mRpostman 1.0.0 (2020-11-29 CRAN update)

      +
      +

      +Changes

      +
        +
      • incorporates all the changes/updates from GitHub patches +0.9.1-1 to 0.9.1-6.
        • +
      +
      +
      +
      +
      +

      +mRpostman 0.9.1-6 (2020-11-28 Github patch)

      +
      +

      +Changes

      +
        +
      • modifies the behaviour for assigning names to the local folders. +Instead of using the url, now the package uses the “/username/mailbox” +as the ‘root’ directory for saving messages and attachments. For +example: ./allanvcq@gmail.com/INBOX/UID1430/ instead of +“imap.gmail.com/INBOX/UID1430”. This will allow users to better +differentiate between local folders, when using different mailboxes in +the same server.
        • +
      +
      +
      +
      +
      +

      +mRpostman 0.9.1-5 (2020-11-18 Github patch)

      +
      +

      +Bug fixes

      +
        +
      • fixed the pattern8 regex in +clean_fetch_results().
        • +
      +
      +
      +
      +
      +

      +mRpostman 0.9.1-4 (2020-11-12 Github patch)

      +
      +

      +New features

      +
        +
      • changes the default value of the timeout_ms parameter +to 0, which is the default value in libcurl, meaning that +no timeout is specified.
        • +
      +
      +
      +
      +
      +

      +mRpostman 0.9.1-3 (2020-11-08 Github patch)

      +
      +

      +New features

      +
        +

      • added the clean_msg_text() function. It will be +particularly useful for cleaning and preparing message text retrieved +with fetch_body(..., mime_level = 1). These texts can be +used for sentiment analysis and other text mining tasks;

        • +

      • added internal functions decode_mime_text() and +decode_quoted_printable_text(). The second is called by the +first one;

        • +

      • renamed the original decode_quoted_printable called +from decode_mime_header() to +decode_quoted_printable_text();

        • +

      • included the xml2 and the rvest +packages as dependencies because of the addition of the +clean_msg_text().

        • +
      +
      +
      +
      +
      +

      +mRpostman 0.9.1-2 (2020-11-01 Github patch)

      +
      +

      +New features

      +
        +
      • added the mime_level argument to the +fetch_body() method. Now, the user can choose whether the +fetch will retrieve the full body content or an specific one. This is +particularly helpful for retrieving clean text parts without inline and +regular attachments for instance.
        • +
      +
      +
      +

      +Bug fixes

      +
        +

      • adapts to the new return pattern of MS Exchange IMAP servers +without losing the compatibility with others;

        • +

      • fixed the misbehavior for the attachment fetching of message in +message attachments. Now, either fetch_attachments() and +fetch_text/body() + get_attachments() combo +can handle this specific case;

        • +

      • changed the attachment identification to the “name” field instead +of the “filename”. In very rare cases, the “filename” field +identification fails because of encoding errors on the sender’s +side;

        • +

      • incorrect decoding of ordinary words (such as “ResearchGate”, for +instance) in decode_mime_header().

        • +
      +
      +
      +

      +Changes without backward compatibility

      +
        +
      • The default argument in all reset_*() methods now are +x in order to prevent wordy method calls and repetition. +The older ones were deprecated in this version.
        • +
      +
      +
      +
      +
      +

      +mRpostman 0.9.1-1 (2020-10-26 Github patch)

      +
      +

      +Main features

      +
        +
      • added RFC 2047 quoted-printable and base64 MIME header decoder
        • +
      +
      +
      +

      +Functions & methods

      +
        +
      • added the decode_mime_header() function +
          +
        • it is used inside get_attachments() and +fetch_attachments() for correctly setting the +filenames
          • +
        • it is also exported for the user in order to be used for a header +decoding operation after fetching metadata, for example.
        • it was necessary to add the {stringi} package as dependency
          • -
        • -
      -
      -

      Bug fixes

      -

      • list_mail_folders(): fixed the regex related to the hierarchy separator to accept the “|” separator. It was causing a misbehavior in Yandex accounts.

        • -

      • clean_fetch_results() (internal): fixed the regex responsible for cleaning the attachment content. It was causing a misbehavior in Yandex accounts. All calls to gsub() in this function now have ignore.case = TRUE.

        • -

      • reset_*() methods: Except by reset_password() and reset_xoauth2_bearer(), the other methods were not reflecting the changes in the ImapCon$con_params object, although they were succesfully modifying the ImapCon$con_handle, which was sufficient to work properly. It could cause the user to thing that the changes wouldn’t taking any effect.

        • -
      -
      -

      Minor changes

      -
      • The confirmation message in fetch_attahments() changed to “::mRpostman: the fetch operation is complete.”;
        • -
      • Fixed some minor typographic errors in the vignettes and the README file;
        • -
      • Adjusted the order of messages printed by rename_folder().
        • -
      -
      -

      Changes without backward compatibility

      -
      • The default argument in all reset_*() methods now are x in order to prevent wordy method calls and repetition. The older ones will be deprecated in version 0.9.1-2;
        • -
      • The reset_ssl() method had the name changed to reset_use_ssl() to better reflect the connection parameter to be reset.
        • -
      • the metadata argument in fetch_metadata now is attribute.
        • -
      -
      -
      -

      mRpostman 0.9.0.0 (2020-09-08 Github/2020-09-15 CRAN)

      CRAN release: 2020-09-16

      -
      -

      Important message

      -

      In this version, in order to drastically enhance the package usability, we had to adopt several profound changes with no backward compatibility. We are sorry that these changes will be painful for old users but it will certainly be strongly beneficial even in the short term. The primary update is that mRpostman now is built on an R6 class and its methods, providing a much more convenient and elegant way of usage. It is structured following an OO framework that works well either with the tidy style using pipes or under the base R approach. The syntax now will be ConnectionObject$method(), where the ConnectionObject is created with configure_imap() or ImapCon$new(). This completely modifies how the connection handle and other configuration information is passed among the methods/functions in mRpostman.

      +
    + + +
    +
    +

    +Bug fixes

    +
      +

    • list_mail_folders(): fixed the regex related to the +hierarchy separator to accept the “|” separator. It was causing a +misbehavior in Yandex accounts.

      • +

    • clean_fetch_results() (internal): fixed the regex +responsible for cleaning the attachment content. It was causing a +misbehavior in Yandex accounts. All calls to gsub() in this function now +have ignore.case = TRUE.

      • +

    • reset_*() methods: Except by +reset_password() and reset_xoauth2_bearer(), +the other methods were not reflecting the changes in the +ImapCon$con_params object, although they were succesfully +modifying the ImapCon$con_handle, which was sufficient to +work properly. It could cause the user to thing that the changes +wouldn’t taking any effect.

      • +
    +
    +
    +

    +Minor changes

    +
      +
    • The confirmation message in fetch_attahments() changed +to “\n::mRpostman: the fetch operation is complete.\n”;
      • +
    • Fixed some minor typographic errors in the vignettes and the README +file;
      • +
    • Adjusted the order of messages printed by +rename_folder().
      • +
    +
    +
    +

    +Changes without backward compatibility

    +
      +
    • The default argument in all reset_*() methods now are +x in order to prevent wordy method calls and repetition. +The older ones will be deprecated in version 0.9.1-2;
      • +
    • The reset_ssl() method had the name changed to +reset_use_ssl() to better reflect the connection parameter +to be reset.
      • +
    • the metadata argument in fetch_metadata +now is attribute.
      • +
    +
    +
    +
    +
    +

    +mRpostman 0.9.0.0 (2020-09-08 Github/2020-09-15 CRAN)

    +
    +

    +Important message

    +

    In this version, in order to drastically enhance the package +usability, we had to adopt several profound changes with no backward +compatibility. We are sorry that these changes will be painful for old +users but it will certainly be strongly beneficial even in the short +term. The primary update is that mRpostman now is built on +an R6 class and its methods, providing a much more +convenient and elegant way of usage. It is structured following an OO +framework that works well either with the tidy style using pipes or +under the base R approach. The syntax now will be +ConnectionObject$method(), where the +ConnectionObject is created with +configure_imap() or ImapCon$new(). This +completely modifies how the connection handle and other configuration +information is passed among the methods/functions in +mRpostman.

    This is a summary of the main modifications in the package:

    -

    • The package title has changed to mRpostman: An IMAP client for R

      • -

    • All the main functions, except by list_attachments and the custom-search helper functions, now are methods of the R6 class ImapConf;

      • -

    • The way the connection token is passed between the functions has changed. The connection handle is created only inside configure_imap() (or ImapCon$new()) and only modified with custom requests inside the methods. As a consequence, the password, username, and other connection parameters are hidden inside the curl handle C pointer, resulting in a more secure token chain. This resulted in changes in every request-functions. They do not use config_handle() anymore, and a call to curl::set_opt() is made in every request function so that a custom request is supplied or replaced by a new one in the original handle.

      • -

    • the argument “by” used in search and fetch functions was replaced by use_uid, which is a logical with default value set as FALSE. This is equivalent to the former by = MSN default configuration.

      • -

    • all functions that returned invisible(0L) now return invisible(TRUE)

      • -
    -
    -

    Changes without backward compatibility

    -
    -

    More appropriate function names [old function -> new method]:

    -
    • -list_mailboxes() -> list_mail_folders() +
        +

      • The package title has changed to mRpostman: An IMAP client for +R

        • +

      • All the main functions, except by list_attachments +and the custom-search helper functions, now are methods of the R6 class +ImapConf;

        • +

      • The way the connection token is passed between the functions has +changed. The connection handle is created only inside +configure_imap() (or ImapCon$new()) and only +modified with custom requests inside the methods. As a consequence, the +password, username, and other connection parameters are hidden inside +the curl handle C pointer, resulting in a more secure token chain. This +resulted in changes in every request-functions. They do not use +config_handle() anymore, and a call to +curl::set_opt() is made in every request function so that a +custom request is supplied or replaced by a new one in the original +handle.

        • +

      • the argument “by” used in search and fetch functions was replaced +by use_uid, which is a logical with default value set as +FALSE. This is equivalent to the former +by = MSN default configuration.

        • +

      • all functions that returned invisible(0L) now return +invisible(TRUE)

        • +
      +
    +
    +

    +Changes without backward compatibility

    +
    +

    +More appropriate function names [old function -> new +method]:

    +
      +
    • +list_mailboxes() -> +list_mail_folders()
    • -select_mailbox() -> select_folder() +select_mailbox() -> +select_folder()
    • -examine_mailbox() -> examine_folder() +examine_mailbox() -> +examine_folder()
    • -custom_search() -> search() +custom_search() -> search()
    • fetch_full_msg() -> fetch_body()
    • -fetch_msg_header() -> fetch_header() +fetch_msg_header() -> +fetch_header()
    • fetch_msg_text() -> fetch_text()
    • -fetch_msg_metadata() -> fetch_metadata() +fetch_msg_metadata() -> +fetch_metadata()
    • get_min_id() -> esearch_min_id() @@ -235,395 +507,766 @@

      More
    • count_msg() -> esearch_count()
      • -

    -
    -

    Functions that were removed:

    -

    • section_or_fields()

      • +
    +
    +
    +

    +Functions that were removed:

    +
      +

    • section_or_fields()

    • flag_options()

      • -
    -
    -

    More appropriate argument names [old - > new]:

    -
    • +
    +
    +
    +

    +More appropriate argument names [old - > new]:

    +
      +

    • mbox -> name:

      -

      • OBS: type has not changed, still a character string

        • -

      • Affected functions: select_folder() (former select_mailbox), examine_folder() (former select_mailbox), rename_folder() (former rename_mailbox)

        • -
      • +
        +

      • OBS: type has not changed, still a character string

        • +

      • Affected functions: select_folder() (former +select_mailbox), examine_folder() (former select_mailbox), +rename_folder() (former rename_mailbox)

        • +
      +

    • reselect_mbox -> reselect:

      -

      • OBS: type has not changed, still a logical with TRUE as default

        • -

      • Affected functions: rename_folder() (former rename_mailbox), copy_msg(), move_msg()

        • -
      • +
        +

      • OBS: type has not changed, still a logical with TRUE +as default

        • +

      • Affected functions: rename_folder() (former +rename_mailbox), copy_msg(), +move_msg()

        • +
      +

    • by -> use_uid:

      -

      • OBS: type HAS CHANGED from a character string with default value MSN to a logical with FALSE as default. Former by = "UID" now is equivalent to use_uid = TRUE

        • +
          +

        • OBS: type HAS CHANGED from a character string with default value +MSN to a logical with FALSE as default. Former +by = "UID" now is equivalent to +use_uid = TRUE

        • Affected functions:

          -

          • all search operations: search() (former custom search), search_before(), search_since(), search_on(), search_period(), search_sent_before(), search_sent_since(), search_sent_on(), search_sent_period(), search_larger_than(), search_smaller_than(), search_older_than(), search_younger_than(), search_flag(), search_string();

            • -

          • all fetch operations: fetch_body() (former fetch_full_msg), fetch_header() (former fetch_msg_text), fetch_text() (former fetch_msg_text), fetch_metadata() (former fetch_msg_metadata);

            • -

          • all complementary operations: copy_msg(), move_msg(), delete_msg(), esearch_max_id() (former get_max_id), esearch_min_id() (former get_min_id), esearch_count() (former count_msg), add/replace/remove_flags()

            • -
          • -
        +
          +

        • all search operations: search() (former custom +search), search_before(), search_since(), +search_on(), search_period(), +search_sent_before(), search_sent_since(), +search_sent_on(), search_sent_period(), +search_larger_than(), search_smaller_than(), +search_older_than(), search_younger_than(), +search_flag(), search_string();

          • +

        • all fetch operations: fetch_body() (former +fetch_full_msg), fetch_header() (former fetch_msg_text), +fetch_text() (former fetch_msg_text), +fetch_metadata() (former fetch_msg_metadata);

          • +

        • all complementary operations: copy_msg(), +move_msg(), delete_msg(), +esearch_max_id() (former get_max_id), +esearch_min_id() (former get_min_id), +esearch_count() (former count_msg), +add/replace/remove_flags()

          • +
        + +
      +

    • flag -> name:

      -

      • OBS: type has not changed, still a character string containing the flag name

        • -

      • Affected functions: search_flag(), flag() (custom search helper function)

        • -
      • +
        +

      • OBS: type has not changed, still a character string containing +the flag name

        • +

      • Affected functions: search_flag(), +flag() (custom search helper function)

        • +
      +

    • string -> expr:

      -

      • OBS: type has not changed, still a character string containing the string or expression to be searched; shifted to the first position of the arguments in the functions/methods.

        • -

      • Affected functions: search_string(), string() (custom search helper function)

        • -
      • +
        +

      • OBS: type has not changed, still a character string containing +the string or expression to be searched; shifted to the first position +of the arguments in the functions/methods.

        • +

      • Affected functions: search_string(), +string() (custom search helper function)

        • +
      +

    • section_or_fields -> where:

      -

      • OBS: type has not changed, still a character string containing the name of the message section or the header field in which to execute the search for the informed expression;

        • -

      • Affected functions: search_string(), string() (custom search helper function)

        • -
      • +
        +

      • OBS: type has not changed, still a character string containing +the name of the message section or the header field in which to execute +the search for the informed expression;

        • +

      • Affected functions: search_string(), +string() (custom search helper function)

        • +
      +

    • specific_UID -> msg_uid:

      -

      • OBS: type has not changed, still a numeric vector containing message uids

        • +
          +

        • OBS: type has not changed, still a numeric vector containing +message uids

        • Affected functions: expunge()

          • -
        +
      +

    • to_mbox -> to_folder:

      -

      • OBS: type has not changed, still a character vector containing the folder name

        • -

      • Affected functions: copy_msg(), move_msg()

        • -
      • +
        +

      • OBS: type has not changed, still a character vector containing +the folder name

        • +

      • Affected functions: copy_msg(), +move_msg()

        • +
      +

    • try_b64decode -> base64_decode:

      -

      • OBS: type has not changed, still a logical with default value FALSE

        • -

      • Affected functions: fetch_text() (former fetch_msg_text)

        • -
      • +
        +

      • OBS: type has not changed, still a logical with default value +FALSE

        • +

      • Affected functions: fetch_text() (former +fetch_msg_text)

        • +
      +

    • show_pass -> removed:

      -

      • OBS: This argument is not available anymore.

        • +
          +

        • OBS: This argument is not available anymore.

        • Affected functions: configure_imap()

          • -
        +
      +

    • fresh_connect -> removed:

      -

      • OBS: This curl argument is not accepted by mRpostman anymore.

        • +
          +

        • OBS: This curl argument is not accepted by mRpostman +anymore.

        • Affected functions: configure_imap()

          • -
        +
      +

    • return_imapconf -> removed:

      -

      • OBS: This argument is not available anymore.

        • +
          +

        • OBS: This argument is not available anymore.

        • Affected functions: all search methods.

          • -
        -
    -
    -

    Changes in the arguments’ position

    -
    • in search_string() and string(): -
      • `expr (former string) now is 1st; where (former section or fields)` now is 2nd
        • -
      • -
    • in esearch_count() (former count_msgs), esearch_max_id() (former get_max_id), esearch_min_id() (former get_min_id): -
      • swapped the order between the arguments use_uid (former by) and flag -
        • -
      • -
    -
    -

    Behaviour changes

    -
    • +
    + + +
    +
    +

    +Changes in the arguments’ position

    +
      +
    • in search_string() and string(): +
        +
      • `expr (former string) now is 1st; where +(former section or fields)` now is 2nd
        • +
      +
      • +
    • in esearch_count() (former count_msgs), +esearch_max_id() (former get_max_id), +esearch_min_id() (former get_min_id): +
        +
      • swapped the order between the arguments use_uid (former +by) and flag +
        • +
      +
      • +
    +
    +
    +

    +Behaviour changes

    +
      +

    • default value of arguments:

      -
      • -reselect_mbox = FALSE -> reselect = TRUE (former reselect_mbox) in move_msg() and copy_msg() +
          +
        • +reselect_mbox = FALSE -> +reselect = TRUE (former reselect_mbox) in +move_msg() and copy_msg()
          • -
        • -
    + + + +
    -
    -

    Changes that should not cause any break

    -
    -

    Default behavior changes:

    -
    • +
      +

      +Changes that should not cause any break

      +
      +

      +Default behavior changes:

      +
        +

      • returned object:

        -

        • functions/methods that returned invisible(0L) in the previous version, now return invisible(TRUE). Applied to: select_folder(), create_folder(), rename_folder(), get_attachments(), fetch_attachments(), expunge()

          • -

        • all search functions now return NA when there is no match. The previous behavior was to return 0.

          • -

        • add/replace/remove_flags() methods now invisibly return the msg_ids in case the user intends to chain any further operation (perhaps expunge) using the pipe.

          • -
        • +
          +

        • functions/methods that returned invisible(0L) in the +previous version, now return invisible(TRUE). Applied to: +select_folder(), create_folder(), +rename_folder(), get_attachments(), +fetch_attachments(), expunge()

          • +

        • all search functions now return NA when there is no +match. The previous behavior was to return 0.

          • +

        • add/replace/remove_flags() methods now invisibly +return the msg_ids in case the user intends to chain any further +operation (perhaps expunge) using the pipe.

          • +
        +

      • default value of arguments:

        -
        • -retries = 2 -> retries = 1 in all functions
          • -
        • -
      -
      -

      New methods:

      -

      • create_folder(): Create a new mail folder (New IMAP functionality!)

        • -

      • list_flags(): List flags in a selected mail folder (New IMAP functionality!)

        • -

      • fetch_attachments_list(): Fetch attachments’ list without the previously need to fetch a message’s text or body

        • -

      • fetch_attachments(): Fetch attachments without the previously need to fetch a message’s text or body

        • -

      • reset_*(): reset one (*) of the original parameter that were informed in configure_imap().

        • -
      -
      -

      New arguments:

      -
      • +
          +
        • +retries = 2 -> retries = 1 in all +functions
          • +
        +
        • +
      +
      +
      +

      +New methods:

      +
        +

      • create_folder(): Create a new mail folder (New IMAP +functionality!)

        • +

      • list_flags(): List flags in a selected mail folder +(New IMAP functionality!)

        • +

      • fetch_attachments_list(): Fetch attachments’ list +without the previously need to fetch a message’s text or body

        • +

      • fetch_attachments(): Fetch attachments without the +previously need to fetch a message’s text or body

        • +

      • reset_*(): reset one (*) of the original parameter +that were informed in configure_imap().

        • +
      +
      +
      +

      +New arguments:

      +
        +

      • mute:

        -

        • OBS: A logical. If TRUE, mutes the confirmation message when the command is successfully executed. Default is FALSE. In the case of the fetch_*() functions, it only has effect when write_to_disk = TRUE.

          • -

        • applied to methods/functions: select_folder(), create_folder(), rename_folder(), fetch_body(), fetch_header(), fetch_text(), fetch_metadata(), copy_msg(), move_msg(), delete_msg(), expunge(), add/replace/remove_flags(), get_attachments(), fetch_attachments()

          • -
        • +
          +

        • OBS: A logical. If TRUE, mutes the confirmation message when the +command is successfully executed. Default is FALSE. In the case of the +fetch_*() functions, it only has effect when +write_to_disk = TRUE.

          • +

        • applied to methods/functions: select_folder(), +create_folder(), rename_folder(), +fetch_body(), fetch_header(), +fetch_text(), fetch_metadata(), +copy_msg(), move_msg(), +delete_msg(), expunge(), +add/replace/remove_flags(), get_attachments(), +fetch_attachments()

          • +
        +

      • override:

        -

        • OBS: A logical. If TRUE, overrides existent files containing the same name in the local directory. Default is FALSE.

          • -

        • applied to methods/functions: get_attachments(), fetch_attachments().

          • -
        • +
          +

        • OBS: A logical. If TRUE, overrides existent files containing the +same name in the local directory. Default is FALSE.

          • +

        • applied to methods/functions: get_attachments(), +fetch_attachments().

          • +
        +

      • xoauth2_bearer:

        -

        • OBS: added the xoauth2_bearer parameter for oauth2.0 authentication (libcurl >= 7.70 is required because of bugs in previous versions). In Linux, if you use Ubuntu 20, you should be fine. Versions below this require updating libcurl if the user intends to use oauth2.0 authentication.

          • -

        • applied to methods/functions: configure_imap()

          • -
        • -
      -
      -

      New functionalities:

      -
      • in examine_folder() and rename_folder(): -
        • if a folder was previous selected, the user does not have to provide the folder name
          • -
        • if the user wants to examine or rename a folder different from the selected folder, he/she has just to inform the folder name argument
          • -
        • +
          +

        • OBS: added the xoauth2_bearer parameter for oauth2.0 +authentication (libcurl >= 7.70 is required because of bugs in +previous versions). In Linux, if you use Ubuntu 20, you should be fine. +Versions below this require updating libcurl if the user intends to use +oauth2.0 authentication.

          • +

        • applied to methods/functions: +configure_imap()

          • +
        + +
      +
      +
      +

      +New functionalities:

      +
        +
      • in examine_folder() and rename_folder(): +
          +
        • if a folder was previous selected, the user does not have to provide +the folder name
          • +
        • if the user wants to examine or rename a folder different from the +selected folder, he/she has just to inform the folder name +argument
          • +
        +
      • flag argument in all search functions: -
        • all search methods that have the optional argument flag now accept more than one flag as a filtering parameter
          • -
        • this is also applied to the name argument in search_flag -
          • -
        • the flag parameter was added to the search_string method
          • -
        • -
      • in get_attachments() and fetch_attachments(): -
        • -override argument was added and allows to control over the file writing process
          • -
        • -
      -
      -
      -

      Bug fixes

      -
      • -

        retry bug fixed: it was causing the loss of the search and fetch customrequest when executing a retry + selection operation or when there was a considerable period between two requests given that the second depends on a previous folder selection. When there was a considerable delay between the executions of two commands, the curl handle would establish a new connection to execute the last one, but without the mail folder selection. This was causing an error during the retry or the next IMAP command since the IMAP session would have lost the mail folder selection. This bug was happening mainly when the functions were used under the base R approach

        -
        • applied to: all request functions/methods, such as search, fetch, mailbox operations (except those that don’t need a previously folder selection), and complementary operations
          • -
        • -

      • fixed bug that was writing metadata .txt files as textUID*.txt

        • -
      -
      -

      Internal changes

      -
      • +
          +
        • all search methods that have the optional argument flag +now accept more than one flag as a filtering parameter
          • +
        • this is also applied to the name argument in +search_flag +
          • +
        • the flag parameter was added to the +search_string method
          • +
        +
        • +
      • in get_attachments() and +fetch_attachments(): +
          +
        • +override argument was added and allows to control over +the file writing process
          • +
        +
        • +
      +
      +
    +
    +

    +Bug fixes

    +
      +
    • +

      retry bug fixed: it was causing the loss of the search and fetch +customrequest when executing a retry + selection operation +or when there was a considerable period between two requests given that +the second depends on a previous folder selection. When there was a +considerable delay between the executions of two commands, the curl +handle would establish a new connection to execute the last one, but +without the mail folder selection. This was causing an error during the +retry or the next IMAP command since the IMAP session would have lost +the mail folder selection. This bug was happening mainly when the +functions were used under the base R approach

      +
        +
      • applied to: all request functions/methods, such as search, fetch, +mailbox operations (except those that don’t need a previously folder +selection), and complementary operations
        • +
      +
      • +

    • fixed bug that was writing metadata .txt files as +textUID*.txt

      • +
    +
    +
    +

    +Internal changes

    +
      +

    • Better error handling:

      -

      • An unique internal function called check_args() was created to check for the validity of the arguments of all methods and functions, replacing all the cheack_args_* specific functions

        • -

      • added the response_error_handling() function to catch operation/resolving timeout errors and login error as well

        • -
      • -

    • All methods work as wrappers for internal functions with similar names and suffix *_int

      • -

    • Search, Fetch and Complementary functions have a central internal function called execute_*() that is responsible for configuring and executing the requests towards the IMAP server

      • -

    • removed config_handle()as the connection token chain has changed

      • -

    • added config_conn_handle() which is called inside the iniliaze() method of the R6 ImapCon class.

      • -

    • added adjust_repeated_filenames(), serialize_filenames() and extract_MIME_level_and_filenames() as helper functions to the new attachments fetch operations

      • -

    • added adjust_folder_name() which is called in almost every request function

      • -

    • some regex adjustments were made to fix_search_stripping(), has_attachment(), and clear_fetch_results()

      • -

    • in list_server_capabilities(): changed IMAP command to “CAPABILITY” instead of establishing a new connection

      • -

    • REGEX structure replacement from stringr to base R in: list_server_capabalities(), examine_folder() (former examine_mailbox), list_mail_folders() (former list_mailboxes), select_folder() (former select_mailbox)

      • -
    -
    -

    Other general changes:

    -

    • fetch_attachments_list() and fetch_attachments() are a faster and smart way to respectively list and download messages’ attachments. They do not depend on a former fetching step, unlike list_attachments() and get_attachments(). the new methods use BODYSTRUCTURE metadata fetching to identify the attachments, and fetch_attachments() also issue a FETCH BODY[level.MIME] command to fetch only the parts of the messages that contain the attachments. This prevents unnecessary fetching when users are only interested in attachments. However, get_attachments() and list_attachments() are still available in the package.

      • -

    • All fetch_* methods, and get_attachments() now use a different path for saving the fetched files. The folder to be created now will have the following structure: imap_server > mail_folder > or .

      • -
    • -

      Fetched messages that are saved to disk will have different filename structures:

      -
      • if use_uid = FALSE: body.txt, header.txt, meta.txt, text.txt
        • -
      • if use_uid = TRUE: body.txt, header.txt, meta.txt, text.txt
        • -
      • -

    • Confirmation messages were added to methods: select_folder(), create_folder(), rename_folder(), copy_msg(), move_msg(), delete_msg(), expunge(), fetch_*(), add/replace/remove_flags(), get_attachments(), fetch_attachments()

      • -

    • A startup message informing about the breaking changes of the version were added by creating the zzz.R file

      • -

    • Besides the mRpostman Basics vignette, two more were added: Migrating old code to the new mRpostman’s syntax, and IMAP OAuth2.0 authentication in mRpostman

      • -
    -
    -
    -

    mRpostman 0.3.1 (2020-03-27 Github/ 2020-04-18 CRAN)

    CRAN release: 2020-04-20

    -
    -

    Features

    -
    • +
        +

      • An unique internal function called check_args() was +created to check for the validity of the arguments of all methods and +functions, replacing all the cheack_args_* specific functions

        • +

      • added the response_error_handling() function to +catch operation/resolving timeout errors and login error as +well

        • +
      +
      • +

    • All methods work as wrappers for internal functions with similar +names and suffix *_int

      • +

    • Search, Fetch and Complementary functions have a central internal +function called execute_*() that is responsible for +configuring and executing the requests towards the IMAP server

      • +

    • removed config_handle()as the connection token chain +has changed

      • +

    • added config_conn_handle() which is called inside +the iniliaze() method of the R6 ImapCon +class.

      • +

    • added adjust_repeated_filenames(), +serialize_filenames() and +extract_MIME_level_and_filenames() as helper functions to +the new attachments fetch operations

      • +

    • added adjust_folder_name() which is called in almost +every request function

      • +

    • some regex adjustments were made to +fix_search_stripping(), has_attachment(), and +clear_fetch_results()

      • +

    • in list_server_capabilities(): changed IMAP command +to “CAPABILITY” instead of establishing a new connection

      • +

    • REGEX structure replacement from stringr to base R +in: list_server_capabalities(), +examine_folder() (former examine_mailbox), +list_mail_folders() (former list_mailboxes), +select_folder() (former select_mailbox)

      • +
    +
    +
    +

    +Other general changes:

    +
      +

    • fetch_attachments_list() and +fetch_attachments() are a faster and smart way to +respectively list and download messages’ attachments. They do not depend +on a former fetching step, unlike list_attachments() and +get_attachments(). the new methods use BODYSTRUCTURE +metadata fetching to identify the attachments, and +fetch_attachments() also issue a FETCH BODY[level.MIME] +command to fetch only the parts of the messages that contain the +attachments. This prevents unnecessary fetching when users are only +interested in attachments. However, get_attachments() and +list_attachments() are still available in the +package.

      • +

    • All fetch_* methods, and +get_attachments() now use a different path for saving the +fetched files. The folder to be created now will have the following +structure: imap_server > mail_folder > or +.

      • +
    • +

      Fetched messages that are saved to disk will have different +filename structures:

      +
        +
      • if use_uid = FALSE: body.txt, header.txt, +meta.txt, text.txt +
        • +
      • if use_uid = TRUE: body.txt, header.txt, +meta.txt, text.txt +
        • +
      +
      • +

    • Confirmation messages were added to methods: +select_folder(), create_folder(), +rename_folder(), copy_msg(), +move_msg(), delete_msg(), +expunge(), fetch_*(), +add/replace/remove_flags(), get_attachments(), +fetch_attachments()

      • +

    • A startup message informing about the breaking changes of the +version were added by creating the zzz.R file

      • +

    • Besides the mRpostman Basics vignette, two +more were added: Migrating old code to the new mRpostman’s +syntax, and IMAP OAuth2.0 authentication in +mRpostman

      • +
    +
    +
    +
    +
    +

    +mRpostman 0.3.1 (2020-03-27 Github/ 2020-04-18 CRAN)

    +
    +

    +Features

    +
      +
    • get_attachments() function: -
      • added support to inline attachments: argument “content_disposition”
        • +
          +
        • added support to inline attachments: argument +“content_disposition”
        • changed REGEX for retrieving text and filenames
          • -
        +
      +
    • check_args_get_atatchments() helper function: -
      • added support to inline attachments: argument "content_disposition" +
          +
        • added support to inline attachments: argument +"content_disposition" +
          • +
        • -
    • list_attachments() function: -
      • added support to inline attachments: added a column "content_disposition" to output
        • +
          +
        • added support to inline attachments: added a column +"content_disposition" to output
        • changed REGEX for retrieving text and filenames
          • -
        +
      +
    • check_args_list_attachments() function: -
      • added helper function check_args_list_attachments() +
          +
        • added helper function +check_args_list_attachments() +
          • +
        • -
    • has_attachment() helper function: -
      • added support to inline attachments
        • -
      • +
        +
      • added support to inline attachments
        • +
      +
    • loop_fetch_msg_*() functions group: -
      • changed error message
        • -
      • -
    -
    -

    Documentation

    -
    • DESCRIPTION FILE: -
      • changed title to IMAP Toolkit
        • +
          +
        • changed error message
          • +
        + +
      +
    +
    +

    +Documentation

    +
      +
    • DESCRIPTION FILE: +
        +
      • changed title to IMAP Toolkit
      • changed Description field
        • -
      • +
    +
  • README.md: -
    • item 6) Attachments: added mention to inline attachments
      • +
        +
      • item 6) Attachments: added mention to inline attachments
      • changed description
      • added Outlook - Office 365 configuration example
        • -
      • changed all examples from UC Riverside to Kansas State University (sorry UCR!)
        • -
      +
    • changed all examples from UC Riverside to Kansas State University +(sorry UCR!)
      • +
    +
  • Basics Vigntte -
    • changed description
      • +
        +
      • changed description
      • added Outlook - Office 365 configuration example
        • -
      • changed all examples from UC Riverside to Kansas State University (sorry UCR!)
        • -
      +
    • changed all examples from UC Riverside to Kansas State University +(sorry UCR!)
      • +
    +
  • get_attachments(): -
    • added new note to explain Content-Disposition types
      • +
        +
      • added new note to explain Content-Disposition types
      • added reference to RFC2183
        • -
      +
    +
  • check_args_get_attachments(): -
    • added new argument "content_disposition" +
        +
      • added new argument "content_disposition" +
        • +
      • -
    • -
    -
    -

    Other

    -
    • removed garbage script environments_tests.R +
    +
    +
    +

    +Other

    +
      +
    • removed garbage script environments_tests.R
      • -
    + +
    -
    -

    mRpostman 0.3.0 (2019-10-07)

    CRAN release: 2019-10-17

    -
    -

    Features

    -
    • +
    +
    +

    +mRpostman 0.3.0 (2019-10-07)

    +
    +

    +Features

    +
      +

    • get_attachments() function:

      -
      • added get_attachments() +
          +
        • added get_attachments()
          • -
        • added helper functions: has_attachment(), check_args_get_attachments() +
        • added helper functions: has_attachment(), +check_args_get_attachments() +
          • +
        • -

    • list_attachments() function:

      -

    • loop_fetch_msg_*() functions:

      -
      • error msg: fixed from examineMailbox() to examine_mailbox() +
          +
        • error msg: fixed from examineMailbox() to +examine_mailbox() +
          • +
        • fixed “forbiden[_]char[s]” in +loop_fetch_full_msg()
          • -
        • fixed “forbiden[_]char[s]” in loop_fetch_full_msg() +
        • changed forbiden_chars to [\\/:*?\"<>|], +considering WIN-*NIX-OSX cases
          • +
        • -
      • changed forbiden_chars to [\\/:*?\"<>|], considering WIN-*NIX-OSX cases
        • -

    • fetch_full_msg():

      • -

    • added warning message related to get_attachments() when keep_in_mem = TRUE

      • +

    • added warning message related to get_attachments() +when keep_in_mem = TRUE

    • fetch_*() functions:

      • -

    • added attr(msg_list, which = 'mbox') = new_imapconf$mbox to all – to be used by get_attachments()

      • +

    • added +attr(msg_list, which = 'mbox') = new_imapconf$mbox to all – +to be used by get_attachments()

    • list_server_capabilities() function:

    • converted regex match/extraction from stringr to base R

    • examples:

      • -

    • fixed typo - from “configureIMAP” to “configure_imap” in the following functions examples: list_mailboxes(), list_server_capabilities()

      • -

    • changed all imaps://imap.gmail.com server examples to a generic one: imaps://your.imap.server.com

      • -
    -
    -

    Documentation

    -
    • DESCRIPTION FILE: -
      • changed title to IMAP Toolkit
        • +

      • fixed typo - from “configureIMAP” to “configure_imap” in the +following functions examples: list_mailboxes(), +list_server_capabilities()

        • +

      • changed all imaps://imap.gmail.com server examples to a generic +one: imaps://your.imap.server.com

        • +
      +
    +
    +

    +Documentation

    +
      +
    • DESCRIPTION FILE: +
        +
      • changed title to IMAP Toolkit
      • changed Description field
        • -
      • +
    +
  • README.md: -
    • changed dev installation example from devtools to remotes because the former depends on curl +
        +
      • changed dev installation example from devtools to +remotes because the former depends on +curl
        • -
      • fixed typo - from “configureIMAP” to “configure_imap” in README.md
        • -
      • fixed typo - two AOL examples instead of one AOL and one Yahoo configure_imap example
        • +
      • fixed typo - from “configureIMAP” to “configure_imap” in +README.md
        • +
      • fixed typo - two AOL examples instead of one AOL and one Yahoo +configure_imap example
      • added Yandex configure_imap() example
        • -
      • +
    +
  • basics.Rmd vignette: -
    • fixed typo - from “configureIMAP” to “configure_imap” in README.md
      • -
    • fixed typo - two AOL examples instead of one AOL and one Yahoo configure_imap example
      • +
        +
      • fixed typo - from “configureIMAP” to “configure_imap” in +README.md
        • +
      • fixed typo - two AOL examples instead of one AOL and one Yahoo +configure_imap example
      • added Yandex configure_imap() example
      • removed figures (already appear on README.md)
        • -
      +
    +
  • count_msgs(): -
    • changed title
      • -
    • -
    -
    -
    -

    mRpostman 0.2.1-X (2019-08-22 Github only)

    -
    -

    Features (0.2.1-2)

    -
    • +
        +
      • changed title
        • +
      +
      • +
    +
    +
    +
    +
    +

    +mRpostman 0.2.1-X (2019-08-22 Github only)

    +
    +

    +Features (0.2.1-2)

    +
      +
    • loop_fetch_msg_XXXX() functions for fetching msgs: -
      • added select_mailbox(imapconf = new_imapconf, mbox = new_imapconf$mbox) inside the tryCatch in the while loop – it prevents errors especially when messages have larger attachments taking too much time to fetch. In some IMAP servers (such as Yandex) it may lose the mbox selection. Other alternatives: set a larger timeout_ms in configure_imap().
        • -
      • +
        +
      • added +select_mailbox(imapconf = new_imapconf, mbox = new_imapconf$mbox) +inside the tryCatch in the while loop – it prevents errors especially +when messages have larger attachments taking too much time to fetch. In +some IMAP servers (such as Yandex) it may lose the mbox selection. Other +alternatives: set a larger timeout_ms in +configure_imap().
        • +
      +
    • list_mailboxes(): -
      • REGEX for cleaning mbox names from list_mailboxes() was modified to deal with the return of Yandex IMAP server: from .*\" \"*(.*?)\\"\r\n' to '.*\" \"*(.*?)[(\\"\r\n)|(\r\n\\*)] -
        • -
      • -
    -
    -

    Documentation (0.2.1-1)

    -
    • function configure_imap(): -
      • -@param retries description typo: from “retires” to “retries”
        • -
      • +
        +
      • REGEX for cleaning mbox names from list_mailboxes() was +modified to deal with the return of Yandex IMAP server: from +.*\" \"*(.*?)\\"\r\n' to '.*\" \"*(.*?)[(\\"\r\n)|(\r\n\\*)] +
        • +
      + +
    +
    +
    +

    +Documentation (0.2.1-1)

    +
      +
    • function configure_imap(): +
        +
      • +@param retries description typo: from “retires” to +“retries”
        • +
      +
    • internal function conifg_handle(): -
      • removed @family config, so it does not appear as “see also” in config_IMAP() +
          +
        • removed @family config, so it does not appear as “see +also” in config_IMAP() +
          • +
        • -
    • function flag_options(): -
      • updated @note to be more clear
        • -
      • +
        +
      • updated @note to be more clear
        • +
      +
    • all internal functions from @family check args search: -
      • -@param esearch typo: from code{1,2,3,4,5} to \code{1,2,3,4,5} +
          +
        • +@param esearch typo: from code{1,2,3,4,5} +to \code{1,2,3,4,5} +
          • +
        • -
    • pkg logo: -
      • improved logo with background transparency - better looking favicons
        • -
      • +
        +
      • improved logo with background transparency - better looking +favicons
        • +
      +
    • README.md: -
      • changed section “First Things First” to “Allowing Less Secure Apps Access”
        • -
      • -
    +
      +
    • changed section “First Things First” to “Allowing Less Secure Apps +Access”
      • +
    + + +
    +
    -
    -

    mRpostman 0.2.0 (2019-08-18 - CRAN submission)

    CRAN release: 2019-08-22

    -

    • changed function name patterns to those specified in the tidyverse style guide

      • +
      +

      +mRpostman 0.2.0 (2019-08-18 - CRAN submission)

      +
        +

      • changed function name patterns to those specified in the +tidyverse style guide

      • -

        changed return from mailboxes operation functions and some miscellanea functions:

        -
        • now select_mailbox(), rename_mailbox(), copy_msg(), move_msg(), delete_msg(), expunge(), add/remove/replace_flags() outputs are invisible and only return imapconf or a list (imapconf+msg_ids).
          • -
        • +

        changed return from mailboxes operation functions and some +miscellanea functions:

        +
          +
        • now select_mailbox(), rename_mailbox(), +copy_msg(), move_msg(), +delete_msg(), expunge(), +add/remove/replace_flags() outputs are invisible and only +return imapconf or a list (imapconf+msg_ids).
          • +
        +

      • changed package logo

        • -
      -
      -

      mRpostman 0.1.0 (2019-08-13 - Github release)

      +
    +
    -
    +
    +

    +mRpostman 0.1.0 (2019-08-13 - Github release)

    +
    +
    + -
    -

    Developed by Allan Quadros.

    -
    -

    Site built with pkgdown 2.0.7.

    + +
    +
    +

    Developed by Allan Quadros.

    -
    +
    +

    Site built with pkgdown 1.6.1.

    +
    - +
    + - + + + + diff --git a/docs/pkgdown.js b/docs/pkgdown.js index 5fccd9c..7e7048f 100644 --- a/docs/pkgdown.js +++ b/docs/pkgdown.js @@ -2,30 +2,70 @@ (function($) { $(function() { - $('nav.navbar').headroom(); + $('.navbar-fixed-top').headroom(); - Toc.init({ - $nav: $("#toc"), - $scope: $("main h2, main h3, main h4, main h5, main h6") + $('body').css('padding-top', $('.navbar').height() + 10); + $(window).resize(function(){ + $('body').css('padding-top', $('.navbar').height() + 10); }); - if ($('#toc').length) { - $('body').scrollspy({ - target: '#toc', - offset: $("nav.navbar").outerHeight() + 1 - }); + $('[data-toggle="tooltip"]').tooltip(); + + var cur_path = paths(location.pathname); + var links = $("#navbar ul li a"); + var max_length = -1; + var pos = -1; + for (var i = 0; i < links.length; i++) { + if (links[i].getAttribute("href") === "#") + continue; + // Ignore external links + if (links[i].host !== location.host) + continue; + + var nav_path = paths(links[i].pathname); + + var length = prefix_length(nav_path, cur_path); + if (length > max_length) { + max_length = length; + pos = i; + } } - // Activate popovers - $('[data-bs-toggle="popover"]').popover({ - container: 'body', - html: true, - trigger: 'focus', - placement: "top", - sanitize: false, - }); + // Add class to parent
  • , and enclosing
  • if in dropdown + if (pos >= 0) { + var menu_anchor = $(links[pos]); + menu_anchor.parent().addClass("active"); + menu_anchor.closest("li.dropdown").addClass("active"); + } + }); + + function paths(pathname) { + var pieces = pathname.split("/"); + pieces.shift(); // always starts with / + + var end = pieces[pieces.length - 1]; + if (end === "index.html" || end === "") + pieces.pop(); + return(pieces); + } + + // Returns -1 if not found + function prefix_length(needle, haystack) { + if (needle.length > haystack.length) + return(-1); - $('[data-bs-toggle="tooltip"]').tooltip(); + // Special case for length-0 haystack, since for loop won't run + if (haystack.length === 0) { + return(needle.length === 0 ? 0 : -1); + } + + for (var i = 0; i < haystack.length; i++) { + if (needle[i] != haystack[i]) + return(i); + } + + return(haystack.length); + } /* Clipboard --------------------------*/ @@ -38,9 +78,9 @@ if(ClipboardJS.isSupported()) { $(document).ready(function() { - var copyButton = ""; + var copyButton = ""; - $("div.sourceCode").addClass("hasCopyButton"); + $(".examples, div.sourceCode").addClass("hasCopyButton"); // Insert copy buttons: $(copyButton).prependTo(".hasCopyButton"); @@ -49,108 +89,20 @@ $('.btn-copy-ex').tooltip({container: 'body'}); // Initialize clipboard: - var clipboard = new ClipboardJS('[data-clipboard-copy]', { + var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', { text: function(trigger) { - return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, ""); + return trigger.parentNode.textContent; } }); - clipboard.on('success', function(e) { + clipboardBtnCopies.on('success', function(e) { changeTooltipMessage(e.trigger, 'Copied!'); e.clearSelection(); }); - clipboard.on('error', function() { + clipboardBtnCopies.on('error', function() { changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy'); }); - }); } - - /* Search marking --------------------------*/ - var url = new URL(window.location.href); - var toMark = url.searchParams.get("q"); - var mark = new Mark("main#main"); - if (toMark) { - mark.mark(toMark, { - accuracy: { - value: "complementary", - limiters: [",", ".", ":", "/"], - } - }); - } - - /* Search --------------------------*/ - /* Adapted from https://github.com/rstudio/bookdown/blob/2d692ba4b61f1e466c92e78fd712b0ab08c11d31/inst/resources/bs4_book/bs4_book.js#L25 */ - // Initialise search index on focus - var fuse; - $("#search-input").focus(async function(e) { - if (fuse) { - return; - } - - $(e.target).addClass("loading"); - var response = await fetch($("#search-input").data("search-index")); - var data = await response.json(); - - var options = { - keys: ["what", "text", "code"], - ignoreLocation: true, - threshold: 0.1, - includeMatches: true, - includeScore: true, - }; - fuse = new Fuse(data, options); - - $(e.target).removeClass("loading"); - }); - - // Use algolia autocomplete - var options = { - autoselect: true, - debug: true, - hint: false, - minLength: 2, - }; - var q; -async function searchFuse(query, callback) { - await fuse; - - var items; - if (!fuse) { - items = []; - } else { - q = query; - var results = fuse.search(query, { limit: 20 }); - items = results - .filter((x) => x.score <= 0.75) - .map((x) => x.item); - if (items.length === 0) { - items = [{dir:"Sorry 😿",previous_headings:"",title:"No results found.",what:"No results found.",path:window.location.href}]; - } - } - callback(items); -} - $("#search-input").autocomplete(options, [ - { - name: "content", - source: searchFuse, - templates: { - suggestion: (s) => { - if (s.title == s.what) { - return `${s.dir} >
    ${s.title}
    `; - } else if (s.previous_headings == "") { - return `${s.dir} >
    ${s.title}
    > ${s.what}`; - } else { - return `${s.dir} >
    ${s.title}
    > ${s.previous_headings} > ${s.what}`; - } - }, - }, - }, - ]).on('autocomplete:selected', function(event, s) { - window.location.href = s.path + "?q=" + q + "#" + s.id; - }); - }); })(window.jQuery || window.$) - - diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 6bc556c..dd638f0 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,9 +1,9 @@ pandoc: 2.19.2 -pkgdown: 2.0.7 +pkgdown: 1.6.1 pkgdown_sha: ~ articles: basics: basics.html code_migration: code_migration.html xoauth2.0: xoauth2.0.html -last_built: 2023-07-27T09:34Z +last_built: 2023-07-28T15:01Z diff --git a/docs/reference/AND.html b/docs/reference/AND.html index 50a66c9..3a9fa48 100644 --- a/docs/reference/AND.html +++ b/docs/reference/AND.html @@ -1,133 +1,223 @@ + -Relational-operator-function to construct a custom search statement — AND • mRpostman - Skip to contents - + + + + + -
    -
    -
    -

    Relational-operator-function to construct a custom search statement

    - Source: R/AND.R -
    AND.Rd
    -
    + + + -
    -

    Relational-operator-function to construct a custom search statement

    -
    + + + + + + + + + + + + + + -
    -

    Usage

    - 
    AND(..., negate = FALSE)
    -
    -
    -

    Arguments

    -
    ...
    -

    a combination of criteria constructor functions with its arguments.

    -
    negate
    -

    If TRUE, negates the search and seeks for -"NOT search_criterion". Default is FALSE.

    + + + -
    -
    -

    Value

    - -

    A search string to be used as a request parameter in

    -

    -

    ImapCon$search() function.

    + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    +

    Relational-operator-function to construct a custom search statement

    + Source: R/AND.R +
    -
    -

    Examples

    - 
    if (FALSE) {
-# select folder & search
-con$select_folder(name = "INBOX")
-# search for messages SINCE "30-Ago-2019" AND SMALLER than 512KB.
-res <- con$search(request = AND(sent_since(date_char = "30-Ago-2019"),
-                                smaller_than(size = 512000)))
-}
-
    +
    +

    Relational-operator-function to construct a custom search statement

    -
    + + 
    AND(..., negate = FALSE)
    + +

    Arguments

    + + + + + + + + + + +
    ...

    a combination of criteria constructor functions with its arguments.

    negate

    If TRUE, negates the search and seeks for +"NOT search_criterion". Default is FALSE.

    + +

    Value

    + +

    A search string to be used as a request parameter in + ImapCon$search() function.

    +

    See also

    + +

    Other custom search: +ImapCon, +OR(), +before(), +flag(), +larger_than(), +older_than(), +on(), +sent_before(), +sent_on(), +sent_since(), +since(), +smaller_than(), +string(), +younger_than()

    + +

    Examples

    + 
    if (FALSE) {
+# select folder & search
+con$select_folder(name = "INBOX")
+# search for messages SINCE "30-Ago-2019" AND SMALLER than 512KB.
+res <- con$search(request = AND(sent_since(date_char = "30-Ago-2019"),
+                                smaller_than(size = 512000)))
+}
+
    +
    + + -
    -

    Developed by Allan Quadros.

    +
    +
    +

    Developed by Allan Quadros.

    -
    -

    Site built with pkgdown 2.0.7.

    +
    +

    Site built with pkgdown 1.6.1.

    -
    +
    + - - + + + diff --git a/docs/reference/ImapCon.html b/docs/reference/ImapCon.html index 1dd01d9..5b51876 100644 --- a/docs/reference/ImapCon.html +++ b/docs/reference/ImapCon.html @@ -1,79 +1,168 @@ + -An IMAP Connection Class — ImapCon • mRpostman - Skip to contents - + + + + + -
    -
    -

    An IMAP Connection Class

    - Source: R/R6.R -
    ImapCon.Rd
    +
    +
    +

    An IMAP Connection Class

    + Source: R/R6.R +
    -
    +

    Configure an IMAP connection using the ImapCon R6 class.

    -
    -

    Note

    -

    ImapCon$new(): The configure_imap + +

    Note

    + +

    ImapCon$new(): The configure_imap should be preferred instead of ImapCon$new().

    -

    ImapCon$search(): IMAP queries follows +

    ImapCon$search(): IMAP queries follows Polish notation, i.e. operators such as OR come before arguments, e.g. "OR argument1 argument2". Therefore, the relational-operator-helper-functions in this package should be used like the following examples: OR(before("17-Apr-2015"), string("FROM", "John")). Even though there is no "AND" operator in IMAP, this package adds a helper function - AND to indicate multiples arguments that must be searched + AND to indicate multiples arguments that must be searched together, e.g. AND(since("01-Jul-2018"), smaller_than(16000)).

    -

    ImapCon$sent_before(): Search +

    ImapCon$sent_before(): Search operations that use the origination/RFC-2822 Header date tend to be "slower" than those that use the internal date. Although the overhead is minimum, the difference is due to the fact that the internal date @@ -81,7 +170,7 @@

    Note

    inside the message. Therefore, the server needs to access each message when executing this type of search. Despite this fact, both dates tend to be the same.

    -

    ImapCon$search_sent_since(): Search +

    ImapCon$search_sent_since(): Search operations that use the origination/RFC-2822 Header date tend to be "slower" than those that use the internal date. Although the overhead is minimum, the difference is due to the fact that the internal date @@ -89,7 +178,7 @@

    Note

    inside the message. Therefore, the server needs to access each message when executing this type of search. Despite this fact, both dates tend to be the same.

    -

    ImapCon$search_sent_on(): Search +

    ImapCon$search_sent_on(): Search operations that use the origination/RFC-2822 Header date tend to be "slower" than those that use the internal date. Although the overhead is minimum, the difference is due to the fact that the internal date @@ -97,7 +186,7 @@

    Note

    inside the message. Therefore, the server needs to access each message when executing this type of search. Despite this fact, both dates tend to be the same.

    -

    ImapCon$search_sent_period(): Search +

    ImapCon$search_sent_period(): Search operations that use the origination/RFC-2822 Header date tend to be "slower" than those that use the internal date. Although the overhead is minimum, the difference is due to the fact that the internal date @@ -105,48 +194,48 @@

    Note

    inside the message. Therefore, the server needs to access each message when executing this type of search. Despite this fact, both dates tend to be the same.

    -

    ImapCon$search_older_than(): +

    ImapCon$search_older_than(): To be able to use this functionality, the server must support the WITHIN capability. You can check it by running - ImapCon$list_server_capabilities().

    -

    ImapCon$search_older_than(): + ImapCon$list_server_capabilities().

    +

    ImapCon$search_older_than(): To be able to use this functionality, the server must support the WITHIN capability. You can check it by running - ImapCon$list_server_capabilities().

    -

    ImapCon$search_string(): Using + ImapCon$list_server_capabilities().

    +

    ImapCon$search_string(): Using where = "TEXT", may produce unexpected results since it will perform the search on raw data, i.e. the searched expression may be truncated by special formating characters such as \r\n for example. It is recommended to perform this type of search using where = "BODY", instead of "TEXT" (Heinlein, P. and Hartleben, P. (2008)).

    -

    ImapCon$esearch_count(): This +

    ImapCon$esearch_count(): This operation depends on the ESEARCH extension.

    -

    ImapCon$esearch_min_id(): This +

    ImapCon$esearch_min_id(): This operation depends on the ESEARCH extension.

    -

    ImapCon$esearch_max_id(): This +

    ImapCon$esearch_max_id(): This operation depends on the ESEARCH extension.

    -

    ImapCon$add_flags(): Unlike the +

    ImapCon$add_flags(): Unlike the search operations, the add/replace/delete flags operations demand system flag names to be preceded by two backslashes "\\".

    -

    ImapCon$add_flags(): add_flags, +

    ImapCon$add_flags(): add_flags, remove_flags, and replace_flags accept not only flags but also keywords (any word not beginning with two backslashes) which are custom flags defined by the user.

    -

    ImapCon$replace_flags(): Unlike the +

    ImapCon$replace_flags(): Unlike the search operations, the add/replace/delete flags operations demand system flag names to be preceded by two backslashes "\\".

    -

    ImapCon$replace_flags(): add_flags, +

    ImapCon$replace_flags(): add_flags, remove_flags, and replace_flags accept not only flags but also keywords (any word not beginning with two backslashes) which are custom flags defined by the user.

    -

    ImapCon$remove_flags(): Unlike the +

    ImapCon$remove_flags(): Unlike the search operations, the add/replace/delete flags operations demand system flag names to be preceded by two backslashes "\\".

    -

    ImapCon$remove_flags(): add_flags, +

    ImapCon$remove_flags(): add_flags, remove_flags, and replace_flags accept not only flags but also keywords (any word not beginning with two backslashes) which are custom flags defined by the user.

    -

    ImapCon$get_attachments(): +

    ImapCon$get_attachments(): This method is to be used after the body or the text part of one or more messages were fetched. This makes sense if the user is interested in keeping the message content (body or text) besides @@ -154,9 +243,9 @@

    Note

    recommended approach if the user is only interested in downloading the files as the previous fetching operation will probably be costly. In this last case, the recommendation is to use - ImapCon$fetch_attachments() as + ImapCon$fetch_attachments() as it will only fetch the attachment part.

    -

    ImapCon$get_attachments(): All +

    ImapCon$get_attachments(): All attachments will be stored in a folder labeled with the message id inside the working directory > servername > foldername. This function currently handles only attachments @@ -164,7 +253,7 @@

    Note

    decoding the text, but it may not be possible to do so in some circumstances. If it happens, you can try to change the file extension directly by renaming the file.

    -

    ImapCon$get_attachments(): The +

    ImapCon$get_attachments(): The "Content-Disposition" header specifies if the multipart electronic messages will be presented as a main document with a list of separate attachments ("Content-Disposition: attachment") or as a single document @@ -174,7 +263,7 @@

    Note

    (Troost, R., Dorner, S., and K. Moore, Ed. (1997)). You can choose to download both, or only one type of attachment, using the argument content_disposition.

    -

    ImapCon$fetch_attachments(): All +

    ImapCon$fetch_attachments(): All attachments will be stored in a folder labeled with the message id inside the working directory > servername > foldername. This function currently handles only attachments @@ -182,7 +271,7 @@

    Note

    decoding the text, but it may not be possible to do so in some circumstances. If it happens, you can try to change the file extension directly by renaming the file.

    -

    ImapCon$fetch_attachments(): The +

    ImapCon$fetch_attachments(): The "Content-Disposition" header specifies if the multipart electronic messages will be presented as a main document with a list of separate attachments ("Content-Disposition: attachment") or as a single document @@ -192,606 +281,437 @@

    Note

    (Troost, R., Dorner, S., and K. Moore, Ed. (1997)). You can choose to download both, or only one type of attachment, using the argument content_disposition.

    -
    -
    -

    References

    -

    ImapCon$search_string(): +

    References

    + +

    ImapCon$search_string(): Heinlein, P. and Hartleben, P. (2008). The Book of IMAP: Building a Mail Server with Courier and Cyrus. No Starch Press. ISBN 978-1-59327-177-0.

    -

    ImapCon$get_attachments(): +

    ImapCon$get_attachments(): Troost, R., Dorner, S., and K. Moore (1997), Communicating Presentation Information in Internet Messages: The Content-Disposition Header Field, RFC 2183, August 1997, https://www.rfc-editor.org/rfc/rfc2183.

    -

    ImapCon$fetch_attachments(): +

    ImapCon$fetch_attachments(): Troost, R., Dorner, S., and K. Moore (1997), Communicating Presentation Information in Internet Messages: The Content-Disposition Header Field, RFC 2183, DOI 10.17487/RFC2183, August 1997, https://www.rfc-editor.org/rfc/rfc2183.

    -
    -
    -

    See also

    -

    Other custom search: -AND(), -OR(), -before(), -flag(), -larger_than(), -older_than(), -on(), -sent_before(), -sent_on(), -sent_since(), -since(), -smaller_than(), -string(), -younger_than()

    +

    See also

    + +

    Other custom search: +AND(), +OR(), +before(), +flag(), +larger_than(), +older_than(), +on(), +sent_before(), +sent_on(), +sent_since(), +since(), +smaller_than(), +string(), +younger_than()

    Other attachments: -list_attachments()

    -
    -
    -

    Methods

    - -
    -

    Public methods

    - -

    -

    Method new()

    -

    Configure and create a new IMAP connection.

    -

    Usage

    -

    ImapCon$new(
-  url,
-  username,
-  password = NULL,
-  xoauth2_bearer = NULL,
-  use_ssl = TRUE,
-  verbose = FALSE,
-  buffersize = 16000,
-  timeout_ms = 0,
-  ...
-)

    -
    - -
    -

    Arguments

    -

    url
    -

    A character string containing the IMAP server address

    - - -
    username
    -

    A character string containing the username.

    - - -
    password
    -

    A character string containing the user's password.

    - - -
    xoauth2_bearer
    -

    A character string containing the oauth2 bearer token.

    +list_attachments()

    +

    Methods

    - -
    use_ssl
    -

    A logical indicating the use or not of Secure Sockets Layer + +

    Public methods

    + + +

    +

    Method new()

    +

    Configure and create a new IMAP connection.

    Usage

    +

    ImapCon$new(
+  url,
+  username,
+  password = NULL,
+  xoauth2_bearer = NULL,
+  use_ssl = TRUE,
+  verbose = FALSE,
+  buffersize = 16000,
+  timeout_ms = 0,
+  ...
+)

    + +

    Arguments

    +

    +
    url

    A character string containing the IMAP server address

    + +
    username

    A character string containing the username.

    + +
    password

    A character string containing the user's password.

    + +
    xoauth2_bearer

    A character string containing the oauth2 bearer token.

    + +
    use_ssl

    A logical indicating the use or not of Secure Sockets Layer encryption when connecting to the IMAP server. Default is TRUE.

    - -
    verbose
    -

    If FALSE, mutes the flow of information between the +

    verbose

    If FALSE, mutes the flow of information between the server and the client. Default is FALSE.

    - -
    buffersize
    -

    The size in bytes for the receive buffer. Default is +

    buffersize

    The size in bytes for the receive buffer. Default is 16000 bytes or 16kb, which means it will use the libcurl's default value. According to the libcurl's documentation, the maximum buffersize is 512kb (or 512000 bytes), but any number passed to buffersize is treated as a request, not an order.

    - -
    timeout_ms
    -

    Time in milliseconds (ms) to wait for the execution or +

    timeout_ms

    Time in milliseconds (ms) to wait for the execution or re-execution of a command. Default is 0, which means that no timeout limit is set.

    - -
    ...
    -

    Further curl parameters (see curl::curl_options) that +

    ...

    Further curl parameters (see curl::curl_options) that can be used with the IMAP protocol. Only for advanced users.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A new `ImapCon` object.

    -
    - -

    -

    Method reset_url()

    -

    Reset the previously informed url

    -

    Usage

    -

    ImapCon$reset_url(x)

    -
    - -
    -

    Arguments

    -

    x
    -

    A character string containing a new url to be set.

    - - -

    -
    - -

    -

    Method reset_username()

    -

    Reset the previously informed username

    -

    Usage

    -

    ImapCon$reset_username(x)

    -
    - -
    -

    Arguments

    -

    x
    -

    A character string containing a new username to be set.

    - - -

    -
    - -

    -

    Method reset_use_ssl()

    -

    Reset the previously informed use_ssl parameter

    -

    Usage

    -

    ImapCon$reset_use_ssl(x)

    -
    - -
    -

    Arguments

    -

    x
    -

    A logical indicating the use or not of Secure Sockets Layer +

    +

    Method reset_url()

    +

    Reset the previously informed url

    Usage

    +

    ImapCon$reset_url(x)

    + +

    Arguments

    +

    +
    x

    A character string containing a new url to be set.

    + +

    +

    +

    Method reset_username()

    +

    Reset the previously informed username

    Usage

    +

    ImapCon$reset_username(x)

    + +

    Arguments

    +

    +
    x

    A character string containing a new username to be set.

    + +

    +

    +

    Method reset_use_ssl()

    +

    Reset the previously informed use_ssl parameter

    Usage

    +

    ImapCon$reset_use_ssl(x)

    + +

    Arguments

    +

    +
    x

    A logical indicating the use or not of Secure Sockets Layer encryption when connecting to the IMAP server. Default is TRUE.

    +

    +

    +

    Method reset_verbose()

    +

    Reset the previously informed verbose parameter

    Usage

    +

    ImapCon$reset_verbose(x)

    -

    -
    - -

    -

    Method reset_verbose()

    -

    Reset the previously informed verbose parameter

    -

    Usage

    -

    ImapCon$reset_verbose(x)

    -
    - -
    -

    Arguments

    -

    x
    -

    If FALSE, mutes the flow of information between the +

    Arguments

    +

    +
    x

    If FALSE, mutes the flow of information between the server and the client.

    +

    +

    +

    Method reset_buffersize()

    +

    Reset the previously informed buffersize parameter

    Usage

    +

    ImapCon$reset_buffersize(x)

    -

    -
    - -

    -

    Method reset_buffersize()

    -

    Reset the previously informed buffersize parameter

    -

    Usage

    -

    ImapCon$reset_buffersize(x)

    -
    - -
    -

    Arguments

    -

    x
    -

    The size in bytes for the receive buffer. Default is +

    Arguments

    +

    +
    x

    The size in bytes for the receive buffer. Default is 16000 bytes or 16kb, which means it will use the libcurl's default value. According to the libcurl's documentation, the maximum buffersize is 512kb (or 512000 bytes), but any number passed to buffersize is treated as a request, not an order.

    +

    +

    +

    Method reset_timeout_ms()

    +

    Reset the previously informed buffersize parameter

    Usage

    +

    ImapCon$reset_timeout_ms(x)

    -

    -
    - -

    -

    Method reset_timeout_ms()

    -

    Reset the previously informed buffersize parameter

    -

    Usage

    -

    ImapCon$reset_timeout_ms(x)

    -
    - -
    -

    Arguments

    -

    x
    -

    Time in milliseconds (ms) to wait for the execution or +

    Arguments

    +

    +
    x

    Time in milliseconds (ms) to wait for the execution or re-execution of a command. Default is 0, which means that no timeout limit is set.

    - -

    -
    - -

    -

    Method reset_password()

    -

    Reset the previously informed password

    -

    Usage

    -

    ImapCon$reset_password(x)

    -
    - -
    -

    Arguments

    -

    x
    -

    A character string containing the user's password.

    - - -

    -
    - -

    -

    Method reset_xoauth2_bearer()

    -

    Reset the previously informed oauth2 bearer token

    -

    Usage

    -

    ImapCon$reset_xoauth2_bearer(x)

    -
    - -
    -

    Arguments

    -

    x
    -

    A character string containing the oauth2 bearer token.

    - - -

    -
    - -

    -

    Method list_server_capabilities()

    -

    List the server's IMAP capabilities.

    -

    Usage

    -

    ImapCon$list_server_capabilities(retries = 1)

    -
    - -
    -

    Arguments

    -

    retries
    -

    Number of attempts to connect and execute the command. +

    +

    +

    Method reset_password()

    +

    Reset the previously informed password

    Usage

    +

    ImapCon$reset_password(x)

    + +

    Arguments

    +

    +
    x

    A character string containing the user's password.

    + +

    +

    +

    Method reset_xoauth2_bearer()

    +

    Reset the previously informed oauth2 bearer token

    Usage

    +

    ImapCon$reset_xoauth2_bearer(x)

    + +

    Arguments

    +

    +
    x

    A character string containing the oauth2 bearer token.

    + +

    +

    +

    Method list_server_capabilities()

    +

    List the server's IMAP capabilities.

    Usage

    +

    ImapCon$list_server_capabilities(retries = 1)

    + +

    Arguments

    +

    +
    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A character vector containing the server's IMAP capabilities.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 cap <- con$list_server_capabilities()
 cap
 }
-
    -
    +

    +

    +

    Method list_mail_folders()

    +

    List mail folders in a mailbox.

    Usage

    +

    ImapCon$list_mail_folders(retries = 1)

    -

    -

    Method list_mail_folders()

    -

    List mail folders in a mailbox.

    -

    Usage

    -

    ImapCon$list_mail_folders(retries = 1)

    -
    - -
    -

    Arguments

    -

    retries
    -

    Number of attempts to connect and execute the command. +

    Arguments

    +

    +
    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A list containing the mail folder names and their inherent structure.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 folders <- con$list_mail_folders()
 folders
 }
-
    -
    - +

    -

    -

    Method select_folder()

    -

    Select a mail folder.

    -

    Usage

    -

    ImapCon$select_folder(name, mute = FALSE, retries = 1)

    -
    +

    +

    Method select_folder()

    +

    Select a mail folder.

    Usage

    +

    ImapCon$select_folder(name, mute = FALSE, retries = 1)

    -
    -

    Arguments

    -

    name
    -

    A string containing the name of an existing mail folder on the +

    Arguments

    +

    +
    name

    A string containing the name of an existing mail folder on the user's mailbox.

    - -
    mute
    -

    A logical. If TRUE, mutes the confirmation message +

    mute

    A logical. If TRUE, mutes the confirmation message when the command is successfully executed. Default is FALSE.

    - -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A list containing the mail folder names and their inherent structure.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_mail_folder(name = "INBOX")
 }
-
    -
    +

    +

    +

    Method examine_folder()

    +

    Examine the number of messages in a mail folder.

    Usage

    +

    ImapCon$examine_folder(name = NULL, retries = 1)

    -

    -

    Method examine_folder()

    -

    Examine the number of messages in a mail folder.

    -

    Usage

    -

    ImapCon$examine_folder(name = NULL, retries = 1)

    -
    - -
    -

    Arguments

    -

    name
    -

    A character string containing the name of an existing +

    Arguments

    +

    +
    name

    A character string containing the name of an existing mail folder on the user's mailbox. If no name is passed, the command will be executed using the previously selected mail folder name.

    - -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A vector (with names "EXISTS" and "RECENT") containing the number of messages in each category.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 con$examine_folder()
 
 # or directly:
 con$examine_folder("Sent")
 }
-
    -
    - +

    -

    -

    Method create_folder()

    -

    Create a new mail folder.

    -

    Usage

    -

    ImapCon$create_folder(name, mute = FALSE, retries = 1)

    -
    +

    +

    Method create_folder()

    +

    Create a new mail folder.

    Usage

    +

    ImapCon$create_folder(name, mute = FALSE, retries = 1)

    -
    -

    Arguments

    -

    name
    -

    A string containing the name of the new mail folder to be +

    Arguments

    +

    +
    name

    A string containing the name of the new mail folder to be created.

    - -
    mute
    -

    A logical. If TRUE, mutes the confirmation message +

    mute

    A logical. If TRUE, mutes the confirmation message when the command is successfully executed. Default is FALSE.

    - -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    TRUE in case the operation is successful.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$create_folder(name = "New Folder Name")
 }
-
    -
    - - -

    -

    Method rename_folder()

    -

    Rename a mail folder.

    -

    Usage

    -

    ImapCon$rename_folder(
-  name = NULL,
-  new_name,
-  reselect = TRUE,
-  mute = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    name
    -

    A string containing the name of the new mail folder to be +

    + +

    +

    Method rename_folder()

    +

    Rename a mail folder.

    Usage

    +

    ImapCon$rename_folder(
+  name = NULL,
+  new_name,
+  reselect = TRUE,
+  mute = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    name

    A string containing the name of the new mail folder to be renamed. If no name is passed, the command will be executed using the previously selected mail folder name.

    +
    new_name

    A string containing the new name to be assigned.

    -
    new_name
    -

    A string containing the new name to be assigned.

    - - -
    reselect
    -

    A logical. If TRUE, calls +

    reselect

    A logical. If TRUE, calls select_folder(name = to_folder) under the hood before returning the output. Default is TRUE.

    - -
    mute
    -

    A logical. If TRUE, mutes the confirmation message +

    mute

    A logical. If TRUE, mutes the confirmation message when the command is successfully executed. Default is FALSE.

    - -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    TRUE in case the operation is successful.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "Folder A")
 con$rename_folder(new_name = "Folder B")
 # or directly:
 con$rename_folder(name = "Folder A", new_name = "Folder B")
 }
-
    -
    +

    +

    +

    Method list_flags()

    +

    List flags in a selected mail folder

    Usage

    +

    ImapCon$list_flags(retries = 1)

    -

    -

    Method list_flags()

    -

    List flags in a selected mail folder

    -

    Usage

    -

    ImapCon$list_flags(retries = 1)

    -
    - -
    -

    Arguments

    -

    retries
    -

    Number of attempts to connect and execute the command. +

    Arguments

    +

    +
    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    TRUE in case the operation is successful.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 con$list_flags()
 }
-
    -
    - - -

    -

    Method search()

    -

    Execute a custom search

    -

    Usage

    -

    ImapCon$search(
-  request,
-  negate = FALSE,
-  use_uid = FALSE,
-  esearch = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    request
    -

    A string directly specifying what to search or -constructed by a combination of relational-operator-helper-functions OR -and AND, and criteria helper functions such as -before, since, on, -sent_before, sent_since, sent_on, -flag, string, smaller_than, -larger_than, younger_than, or -younger_than.

    - - -
    negate
    -

    If TRUE, negates the search and seeks for "NOT SEARCH +

    + +

    +

    Method search()

    +

    Execute a custom search

    Usage

    +

    ImapCon$search(
+  request,
+  negate = FALSE,
+  use_uid = FALSE,
+  esearch = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    request

    A string directly specifying what to search or +constructed by a combination of relational-operator-helper-functions OR +and AND, and criteria helper functions such as +before, since, on, +sent_before, sent_since, sent_on, +flag, string, smaller_than, +larger_than, younger_than, or +younger_than.

    + +
    negate

    If TRUE, negates the search and seeks for "NOT SEARCH CRITERIA". Default is FALSE.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -800,34 +720,25 @@

    ArgumentsImapCon$list_server_capabilities().

    - +ImapCon$list_server_capabilities().

    -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A list containing the flags (character vector), the permanent flags (character vector), and an indication if custom flags are allowed by the server (logical vector).

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # ex1
 con$search(OR(before(date_char = "17-Apr-2015"),
@@ -838,38 +749,29 @@ 
    Examples
    -
    - - -

    -

    Method search_larger_than()

    -

    Search by size (LARGER)

    -

    Usage

    -

    ImapCon$search_larger_than(
-  size,
-  negate = FALSE,
-  use_uid = FALSE,
-  flag = NULL,
-  esearch = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    size
    -

    An integer specifying the size in bytes to be used as the +

    + +

    +

    Method search_larger_than()

    +

    Search by size (LARGER)

    Usage

    +

    ImapCon$search_larger_than(
+  size,
+  negate = FALSE,
+  use_uid = FALSE,
+  flag = NULL,
+  esearch = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    size

    An integer specifying the size in bytes to be used as the search criterion.

    - -
    negate
    -

    If TRUE, negates the search and seeks for "NOT SEARCH +

    negate

    If TRUE, negates the search and seeks for "NOT SEARCH CRITERION". Default is FALSE.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -878,73 +780,53 @@

    ArgumentsImapCon$list_flags() +
    flag

    An optional argument that sets one or more flags as an additional +filter to the search. Use ImapCon$list_flags() to list the flags in a selected mail folder. Default is NULL.

    - -
    esearch
    -

    A logical. Default is FALSE. If the IMAP server has +

    esearch

    A logical. Default is FALSE. If the IMAP server has ESEARCH capability, it can be used to optimize search results. It will condense the results: instead of writing down the whole sequences of messages' ids, such as {1 2 3 4 5}, it will be presented as {1:5}, which decreases transmission costs. This argument can be used along with buffersize to avoid results stripping. Check if your IMAP server supports ESEARCH with -ImapCon$list_server_capabilities().

    +ImapCon$list_server_capabilities().

    - -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 # search for messages with size larger than 512Kb
 con$search_larger_than(size = 512000))
 }
-
    -
    - - -

    -

    Method search_smaller_than()

    -

    Search by size (SMALLER)

    -

    Usage

    -

    ImapCon$search_smaller_than(
-  size,
-  negate = FALSE,
-  use_uid = FALSE,
-  flag = NULL,
-  esearch = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    size
    -

    An integer specifying the size in bytes to be used as the +

    + +

    +

    Method search_smaller_than()

    +

    Search by size (SMALLER)

    Usage

    +

    ImapCon$search_smaller_than(
+  size,
+  negate = FALSE,
+  use_uid = FALSE,
+  flag = NULL,
+  esearch = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    size

    An integer specifying the size in bytes to be used as the search criterion.

    - -
    negate
    -

    If TRUE, negates the search and seeks for "NOT SEARCH +

    negate

    If TRUE, negates the search and seeks for "NOT SEARCH CRITERION". Default is FALSE.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -953,75 +835,55 @@

    ArgumentsImapCon$list_flags() +
    flag

    An optional argument that sets one or more flags as an additional +filter to the search. Use ImapCon$list_flags() to list the flags in a selected mail folder. Default is NULL.

    - -
    esearch
    -

    A logical. Default is FALSE. If the IMAP server has +

    esearch

    A logical. Default is FALSE. If the IMAP server has ESEARCH capability, it can be used to optimize search results. It will condense the results: instead of writing down the whole sequences of messages' ids, such as {1 2 3 4 5}, it will be presented as {1:5}, which decreases transmission costs. This argument can be used along with buffersize to avoid results stripping. Check if your IMAP server supports ESEARCH with -ImapCon$list_server_capabilities().

    +ImapCon$list_server_capabilities().

    - -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # search for messages with size smaller than 512Kb
 con$search_smaller_than(size = 512000))
 }
-
    -
    - - -

    -

    Method search_before()

    -

    Search by internal date (BEFORE)

    -

    Usage

    -

    ImapCon$search_before(
-  date_char,
-  negate = FALSE,
-  use_uid = FALSE,
-  flag = NULL,
-  esearch = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    date_char
    -

    A character string with format "DD-Mon-YYYY", e.g. +

    + +

    +

    Method search_before()

    +

    Search by internal date (BEFORE)

    Usage

    +

    ImapCon$search_before(
+  date_char,
+  negate = FALSE,
+  use_uid = FALSE,
+  flag = NULL,
+  esearch = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    date_char

    A character string with format "DD-Mon-YYYY", e.g. "01-Apr-2019". We opt not to use Date or POSIX* like objects, since IMAP servers use this uncommon date format.

    - -
    negate
    -

    If TRUE, negates the search and seeks for "NOT SEARCH +

    negate

    If TRUE, negates the search and seeks for "NOT SEARCH CRITERION". Default is FALSE.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -1030,78 +892,58 @@

    ArgumentsImapCon$list_flags() +
    flag

    An optional argument that sets one or more flags as an additional +filter to the search. Use ImapCon$list_flags() to list the flags in a selected mail folder. Default is NULL.

    - -
    esearch
    -

    A logical. Default is FALSE. If the IMAP server has +

    esearch

    A logical. Default is FALSE. If the IMAP server has ESEARCH capability, it can be used to optimize search results. It will condense the results: instead of writing down the whole sequences of messages' ids, such as {1 2 3 4 5}, it will be presented as {1:5}, which decreases transmission costs. This argument can be used along with buffersize to avoid results stripping. Check if your IMAP server supports ESEARCH with -ImapCon$list_server_capabilities().

    - +ImapCon$list_server_capabilities().

    -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # search for messages with date before "02-Jan-2020", presenting the
 # .. results as unique identifiers (UID)
 con$search_before(date = "02-Jan-2020", use_uid = TRUE)
 }
-
    -
    - - -

    -

    Method search_since()

    -

    Search by internal date (SINCE)

    -

    Usage

    -

    ImapCon$search_since(
-  date_char,
-  negate = FALSE,
-  use_uid = FALSE,
-  flag = NULL,
-  esearch = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    date_char
    -

    A character string with format "DD-Mon-YYYY", e.g. +

    + +

    +

    Method search_since()

    +

    Search by internal date (SINCE)

    Usage

    +

    ImapCon$search_since(
+  date_char,
+  negate = FALSE,
+  use_uid = FALSE,
+  flag = NULL,
+  esearch = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    date_char

    A character string with format "DD-Mon-YYYY", e.g. "01-Apr-2019". We opt not to use Date or POSIX* like objects, since IMAP servers use this uncommon date format. POSIX* like objects, since IMAP servers use this uncommon date format. POSIX* like, since IMAP servers like this not so common date format.

    - -
    negate
    -

    If TRUE, negates the search and seeks for "NOT SEARCH +

    negate

    If TRUE, negates the search and seeks for "NOT SEARCH CRITERION". Default is FALSE.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -1110,76 +952,56 @@

    ArgumentsImapCon$list_flags() +
    flag

    An optional argument that sets one or more flags as an additional +filter to the search. Use ImapCon$list_flags() to list the flags in a selected mail folder. Default is NULL.

    - -
    esearch
    -

    A logical. Default is FALSE. If the IMAP server has +

    esearch

    A logical. Default is FALSE. If the IMAP server has ESEARCH capability, it can be used to optimize search results. It will condense the results: instead of writing down the whole sequences of messages' ids, such as {1 2 3 4 5}, it will be presented as {1:5}, which decreases transmission costs. This argument can be used along with buffersize to avoid results stripping. Check if your IMAP server supports ESEARCH with -ImapCon$list_server_capabilities().

    - +ImapCon$list_server_capabilities().

    -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # search for messages with date since "02-Jan-2020", presenting the
 # .. results as unique identifiers (UID)
 con$search_since(date = "02-Jan-2020", use_uid = TRUE)
 }
-
    -
    - - -

    -

    Method search_on()

    -

    Search by internal date (ON)

    -

    Usage

    -

    ImapCon$search_on(
-  date_char,
-  negate = FALSE,
-  use_uid = FALSE,
-  flag = NULL,
-  esearch = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    date_char
    -

    A character string with format "DD-Mon-YYYY", e.g. +

    + +

    +

    Method search_on()

    +

    Search by internal date (ON)

    Usage

    +

    ImapCon$search_on(
+  date_char,
+  negate = FALSE,
+  use_uid = FALSE,
+  flag = NULL,
+  esearch = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    date_char

    A character string with format "DD-Mon-YYYY", e.g. "01-Apr-2019". We opt not to use Date or POSIX* like objects, since IMAP servers use this uncommon date format.

    - -
    negate
    -

    If TRUE, negates the search and seeks for "NOT SEARCH +

    negate

    If TRUE, negates the search and seeks for "NOT SEARCH CRITERION". Default is FALSE.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -1188,83 +1010,61 @@

    ArgumentsImapCon$list_flags() +
    flag

    An optional argument that sets one or more flags as an additional +filter to the search. Use ImapCon$list_flags() to list the flags in a selected mail folder. Default is NULL.

    - -
    esearch
    -

    A logical. Default is FALSE. If the IMAP server has +

    esearch

    A logical. Default is FALSE. If the IMAP server has ESEARCH capability, it can be used to optimize search results. It will condense the results: instead of writing down the whole sequences of messages' ids, such as {1 2 3 4 5}, it will be presented as {1:5}, which decreases transmission costs. This argument can be used along with buffersize to avoid results stripping. Check if your IMAP server supports ESEARCH with -ImapCon$list_server_capabilities().

    - +ImapCon$list_server_capabilities().

    -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # search for messages received on date "02-Jan-2020", presenting the
 #... results as unique identifiers (UID)
 con$search_on(date = "02-Jan-2020", use_uid = TRUE)
 }
-
    -
    - - -

    -

    Method search_period()

    -

    Search by internal date (Period)

    -

    Usage

    -

    ImapCon$search_period(
-  since_date_char,
-  before_date_char,
-  negate = FALSE,
-  use_uid = FALSE,
-  flag = NULL,
-  esearch = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    since_date_char
    -

    A character string with format "DD-Mon-YYYY", e.g. +

    + +

    +

    Method search_period()

    +

    Search by internal date (Period)

    Usage

    +

    ImapCon$search_period(
+  since_date_char,
+  before_date_char,
+  negate = FALSE,
+  use_uid = FALSE,
+  flag = NULL,
+  esearch = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    since_date_char

    A character string with format "DD-Mon-YYYY", e.g. "01-Apr-2019". We opt not to use Date or POSIX* like objects, since IMAP servers use this uncommon date format.

    - -
    before_date_char
    -

    A character string with format "DD-Mon-YYYY", e.g. +

    before_date_char

    A character string with format "DD-Mon-YYYY", e.g. "01-Apr-2019". We opt not to use Date or POSIX* like objects, since IMAP servers use this uncommon date format.

    - -
    negate
    -

    If TRUE, negates the search and seeks for "NOT SEARCH +

    negate

    If TRUE, negates the search and seeks for "NOT SEARCH CRITERION". Default is FALSE.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -1273,38 +1073,27 @@

    ArgumentsImapCon$list_flags() +
    flag

    An optional argument that sets one or more flags as an additional +filter to the search. Use ImapCon$list_flags() to list the flags in a selected mail folder. Default is NULL.

    - -
    esearch
    -

    A logical. Default is FALSE. If the IMAP server has +

    esearch

    A logical. Default is FALSE. If the IMAP server has ESEARCH capability, it can be used to optimize search results. It will condense the results: instead of writing down the whole sequences of messages' ids, such as {1 2 3 4 5}, it will be presented as {1:5}, which decreases transmission costs. This argument can be used along with buffersize to avoid results stripping. Check if your IMAP server supports ESEARCH with -ImapCon$list_server_capabilities().

    - +ImapCon$list_server_capabilities().

    -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # search for all messages in the mail folder, EXCEPT (negate = TRUE) by
 #... those received between the dates "02-Jan-2020" and "22-Mar-2020"
@@ -1312,39 +1101,30 @@ 
    Examples
    -
    - - -

    -

    Method search_sent_before()

    -

    Search by origination date (RFC 2822 Header - SENT BEFORE)

    -

    Usage

    -

    ImapCon$search_sent_before(
-  date_char,
-  negate = FALSE,
-  use_uid = FALSE,
-  flag = NULL,
-  esearch = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    date_char
    -

    A character string with format "DD-Mon-YYYY", e.g. +

    + +

    +

    Method search_sent_before()

    +

    Search by origination date (RFC 2822 Header - SENT BEFORE)

    Usage

    +

    ImapCon$search_sent_before(
+  date_char,
+  negate = FALSE,
+  use_uid = FALSE,
+  flag = NULL,
+  esearch = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    date_char

    A character string with format "DD-Mon-YYYY", e.g. "01-Apr-2019". We opt not to use Date or POSIX* like objects, since IMAP servers use this uncommon date format.

    - -
    negate
    -

    If TRUE, negates the search and seeks for "NOT SEARCH +

    negate

    If TRUE, negates the search and seeks for "NOT SEARCH CRITERION". Default is FALSE.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -1353,75 +1133,55 @@

    ArgumentsImapCon$list_flags() +
    flag

    An optional argument that sets one or more flags as an additional +filter to the search. Use ImapCon$list_flags() to list the flags in a selected mail folder. Default is NULL.

    - -
    esearch
    -

    A logical. Default is FALSE. If the IMAP server has +

    esearch

    A logical. Default is FALSE. If the IMAP server has ESEARCH capability, it can be used to optimize search results. It will condense the results: instead of writing down the whole sequences of messages' ids, such as {1 2 3 4 5}, it will be presented as {1:5}, which decreases transmission costs. This argument can be used along with buffersize to avoid results stripping. Check if your IMAP server supports ESEARCH with -ImapCon$list_server_capabilities().

    +ImapCon$list_server_capabilities().

    - -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 # search for messages with date before "02-Jan-2020", presenting the
 # .. results as unique identifiers (UID)
 con$search_sent_before(date = "02-Jan-2020", use_uid = TRUE)
 }
-
    -
    - - -

    -

    Method search_sent_since()

    -

    Search by origination date (RFC 2822 Header - SENT SINCE)

    -

    Usage

    -

    ImapCon$search_sent_since(
-  date_char,
-  negate = FALSE,
-  use_uid = FALSE,
-  flag = NULL,
-  esearch = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    date_char
    -

    A character string with format "DD-Mon-YYYY", e.g. +

    + +

    +

    Method search_sent_since()

    +

    Search by origination date (RFC 2822 Header - SENT SINCE)

    Usage

    +

    ImapCon$search_sent_since(
+  date_char,
+  negate = FALSE,
+  use_uid = FALSE,
+  flag = NULL,
+  esearch = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    date_char

    A character string with format "DD-Mon-YYYY", e.g. "01-Apr-2019". We opt not to use Date or POSIX* like objects, since IMAP servers use this uncommon date format.

    - -
    negate
    -

    If TRUE, negates the search and seeks for "NOT SEARCH +

    negate

    If TRUE, negates the search and seeks for "NOT SEARCH CRITERION". Default is FALSE.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -1430,75 +1190,55 @@

    ArgumentsImapCon$list_flags() +
    flag

    An optional argument that sets one or more flags as an additional +filter to the search. Use ImapCon$list_flags() to list the flags in a selected mail folder. Default is NULL.

    - -
    esearch
    -

    A logical. Default is FALSE. If the IMAP server has +

    esearch

    A logical. Default is FALSE. If the IMAP server has ESEARCH capability, it can be used to optimize search results. It will condense the results: instead of writing down the whole sequences of messages' ids, such as {1 2 3 4 5}, it will be presented as {1:5}, which decreases transmission costs. This argument can be used along with buffersize to avoid results stripping. Check if your IMAP server supports ESEARCH with -ImapCon$list_server_capabilities().

    +ImapCon$list_server_capabilities().

    - -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 # search for messages with date before "02-Jan-2020", presenting the
 # .. results as unique identifiers (UID)
 con$search_sent_since(date = "02-Jan-2020", use_uid = TRUE)
 }
-
    -
    - - -

    -

    Method search_sent_on()

    -

    Search by origination date (RFC 2822 Header - SENT ON)

    -

    Usage

    -

    ImapCon$search_sent_on(
-  date_char,
-  negate = FALSE,
-  use_uid = FALSE,
-  flag = NULL,
-  esearch = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    date_char
    -

    A character string with format "DD-Mon-YYYY", e.g. +

    + +

    +

    Method search_sent_on()

    +

    Search by origination date (RFC 2822 Header - SENT ON)

    Usage

    +

    ImapCon$search_sent_on(
+  date_char,
+  negate = FALSE,
+  use_uid = FALSE,
+  flag = NULL,
+  esearch = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    date_char

    A character string with format "DD-Mon-YYYY", e.g. "01-Apr-2019". We opt not to use Date or POSIX* like objects, since IMAP servers use this uncommon date format.

    - -
    negate
    -

    If TRUE, negates the search and seeks for "NOT SEARCH +

    negate

    If TRUE, negates the search and seeks for "NOT SEARCH CRITERION". Default is FALSE.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -1507,83 +1247,61 @@

    ArgumentsImapCon$list_flags() +
    flag

    An optional argument that sets one or more flags as an additional +filter to the search. Use ImapCon$list_flags() to list the flags in a selected mail folder. Default is NULL.

    - -
    esearch
    -

    A logical. Default is FALSE. If the IMAP server has +

    esearch

    A logical. Default is FALSE. If the IMAP server has ESEARCH capability, it can be used to optimize search results. It will condense the results: instead of writing down the whole sequences of messages' ids, such as {1 2 3 4 5}, it will be presented as {1:5}, which decreases transmission costs. This argument can be used along with buffersize to avoid results stripping. Check if your IMAP server supports ESEARCH with -ImapCon$list_server_capabilities().

    - +ImapCon$list_server_capabilities().

    -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # search for messages received on date "02-Jan-2020", presenting the
 #... results as unique identifiers (UID)
 con$search_sent_on(date = "02-Jan-2020", use_uid = TRUE)
 }
-
    -
    - - -

    -

    Method search_sent_period()

    -

    Search by origination date (RFC 2822 Header - SENT Period)

    -

    Usage

    -

    ImapCon$search_sent_period(
-  since_date_char,
-  before_date_char,
-  negate = FALSE,
-  use_uid = FALSE,
-  flag = NULL,
-  esearch = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    since_date_char
    -

    A character string with format "DD-Mon-YYYY", e.g. +

    + +

    +

    Method search_sent_period()

    +

    Search by origination date (RFC 2822 Header - SENT Period)

    Usage

    +

    ImapCon$search_sent_period(
+  since_date_char,
+  before_date_char,
+  negate = FALSE,
+  use_uid = FALSE,
+  flag = NULL,
+  esearch = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    since_date_char

    A character string with format "DD-Mon-YYYY", e.g. "01-Apr-2019". We opt not to use Date or POSIX* like objects, since IMAP servers use this uncommon date format.

    - -
    before_date_char
    -

    A character string with format "DD-Mon-YYYY", e.g. +

    before_date_char

    A character string with format "DD-Mon-YYYY", e.g. "01-Apr-2019". We opt not to use Date or POSIX* like objects, since IMAP servers use this uncommon date format.

    - -
    negate
    -

    If TRUE, negates the search and seeks for "NOT SEARCH +

    negate

    If TRUE, negates the search and seeks for "NOT SEARCH CRITERION". Default is FALSE.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -1592,38 +1310,27 @@

    ArgumentsImapCon$list_flags() +
    flag

    An optional argument that sets one or more flags as an additional +filter to the search. Use ImapCon$list_flags() to list the flags in a selected mail folder. Default is NULL.

    - -
    esearch
    -

    A logical. Default is FALSE. If the IMAP server has +

    esearch

    A logical. Default is FALSE. If the IMAP server has ESEARCH capability, it can be used to optimize search results. It will condense the results: instead of writing down the whole sequences of messages' ids, such as {1 2 3 4 5}, it will be presented as {1:5}, which decreases transmission costs. This argument can be used along with buffersize to avoid results stripping. Check if your IMAP server supports ESEARCH with -ImapCon$list_server_capabilities().

    - +ImapCon$list_server_capabilities().

    -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # search for all messages in the mail folder, EXCEPT (negate = TRUE) by
 #... those received between the dates "02-Jan-2020" and "22-Mar-2020"
@@ -1631,38 +1338,29 @@ 
    Examples
    -
    - - -

    -

    Method search_flag()

    -

    Search by flag(s)

    -

    Usage

    -

    ImapCon$search_flag(
-  name,
-  negate = FALSE,
-  use_uid = FALSE,
-  esearch = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    name
    -

    A string containing one or more flags to search for. Use -ImapCon$list_flags() to list the flags +

    + +

    +

    Method search_flag()

    +

    Search by flag(s)

    Usage

    +

    ImapCon$search_flag(
+  name,
+  negate = FALSE,
+  use_uid = FALSE,
+  esearch = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    name

    A string containing one or more flags to search for. Use +ImapCon$list_flags() to list the flags in a selected mail folder.

    - -
    negate
    -

    If TRUE, negates the search and seeks for "NOT SEARCH +

    negate

    If TRUE, negates the search and seeks for "NOT SEARCH CRITERION". Default is FALSE.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -1671,69 +1369,51 @@

    ArgumentsImapCon$list_server_capabilities().

    +ImapCon$list_server_capabilities().

    - -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # search for all messages in the mail folder that are marked as "SEEN" AND
 #.. "ANSWERED"
 con$search_flag(name = c("SEEN", "ANSWERED"))
 }
-
    -
    - - -

    -

    Method search_older_than()

    -

    Search WITHIN a specific time (OLDER)

    -

    Usage

    -

    ImapCon$search_older_than(
-  seconds,
-  negate = FALSE,
-  use_uid = FALSE,
-  flag = NULL,
-  esearch = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    seconds
    -

    An integer specifying the number of seconds to be used as +

    + +

    +

    Method search_older_than()

    +

    Search WITHIN a specific time (OLDER)

    Usage

    +

    ImapCon$search_older_than(
+  seconds,
+  negate = FALSE,
+  use_uid = FALSE,
+  flag = NULL,
+  esearch = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    seconds

    An integer specifying the number of seconds to be used as the search criterion.

    - -
    negate
    -

    If TRUE, negates the search and seeks for "NOT SEARCH +

    negate

    If TRUE, negates the search and seeks for "NOT SEARCH CRITERION". Default is FALSE.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -1742,74 +1422,54 @@

    ArgumentsImapCon$list_flags() +
    flag

    An optional argument that sets one or more flags as an additional +filter to the search. Use ImapCon$list_flags() to list the flags in a selected mail folder. Default is NULL.

    - -
    esearch
    -

    A logical. Default is FALSE. If the IMAP server has +

    esearch

    A logical. Default is FALSE. If the IMAP server has ESEARCH capability, it can be used to optimize search results. It will condense the results: instead of writing down the whole sequences of messages' ids, such as {1 2 3 4 5}, it will be presented as {1:5}, which decreases transmission costs. This argument can be used along with buffersize to avoid results stripping. Check if your IMAP server supports ESEARCH with -ImapCon$list_server_capabilities().

    +ImapCon$list_server_capabilities().

    - -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # search for all messages received in the last hour (not older than 3600 seconds)
 con$search_older_than(seconds = 3600, negate = TRUE)
 }
-
    -
    - - -

    -

    Method search_younger_than()

    -

    Search WITHIN a specific time (YOUNGER)

    -

    Usage

    -

    ImapCon$search_younger_than(
-  seconds,
-  negate = FALSE,
-  use_uid = FALSE,
-  flag = NULL,
-  esearch = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    seconds
    -

    An integer specifying the number of seconds to be used as +

    + +

    +

    Method search_younger_than()

    +

    Search WITHIN a specific time (YOUNGER)

    Usage

    +

    ImapCon$search_younger_than(
+  seconds,
+  negate = FALSE,
+  use_uid = FALSE,
+  flag = NULL,
+  esearch = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    seconds

    An integer specifying the number of seconds to be used as the search criterion.

    - -
    negate
    -

    If TRUE, negates the search and seeks for "NOT SEARCH +

    negate

    If TRUE, negates the search and seeks for "NOT SEARCH CRITERION". Default is FALSE.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -1818,80 +1478,58 @@

    ArgumentsImapCon$list_flags() +
    flag

    An optional argument that sets one or more flags as an additional +filter to the search. Use ImapCon$list_flags() to list the flags in a selected mail folder. Default is NULL.

    - -
    esearch
    -

    A logical. Default is FALSE. If the IMAP server has +

    esearch

    A logical. Default is FALSE. If the IMAP server has ESEARCH capability, it can be used to optimize search results. It will condense the results: instead of writing down the whole sequences of messages' ids, such as {1 2 3 4 5}, it will be presented as {1:5}, which decreases transmission costs. This argument can be used along with buffersize to avoid results stripping. Check if your IMAP server supports ESEARCH with -ImapCon$list_server_capabilities().

    - +ImapCon$list_server_capabilities().

    -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # search for all messages received in the last hour (younger than 3600 seconds)
 con$search_younger_than(seconds = 3600)
 }
-
    -
    - - -

    -

    Method search_string()

    -

    Search by string or expression

    -

    Usage

    -

    ImapCon$search_string(
-  expr,
-  where,
-  negate = FALSE,
-  use_uid = FALSE,
-  flag = NULL,
-  esearch = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    expr
    -

    A character string specifying the word or expression to search +

    + +

    +

    Method search_string()

    +

    Search by string or expression

    Usage

    +

    ImapCon$search_string(
+  expr,
+  where,
+  negate = FALSE,
+  use_uid = FALSE,
+  flag = NULL,
+  esearch = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    expr

    A character string specifying the word or expression to search for in messages.

    - -
    where
    -

    A mandatory character string specifying in which +

    where

    A mandatory character string specifying in which message's Section or Header Field to search for the provided string.

    - -
    negate
    -

    If TRUE, negates the search and seeks for "NOT SEARCH +

    negate

    If TRUE, negates the search and seeks for "NOT SEARCH CRITERION". Default is FALSE.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -1900,71 +1538,53 @@

    ArgumentsImapCon$list_flags() +
    flag

    An optional argument that sets one or more flags as an additional +filter to the search. Use ImapCon$list_flags() to list the flags in a selected mail folder. Default is NULL.

    - -
    esearch
    -

    A logical. Default is FALSE. If the IMAP server has +

    esearch

    A logical. Default is FALSE. If the IMAP server has ESEARCH capability, it can be used to optimize search results. It will condense the results: instead of writing down the whole sequences of messages' ids, such as {1 2 3 4 5}, it will be presented as {1:5}, which decreases transmission costs. This argument can be used along with buffersize to avoid results stripping. Check if your IMAP server supports ESEARCH with -ImapCon$list_server_capabilities().

    - +ImapCon$list_server_capabilities().

    -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # search for all messages received in the last hour (younger than 3600 seconds)
 con$search_string(expr = "@k-state.edu", where = "FROM")
 }
-
    -
    - - -

    -

    Method fetch_body()

    -

    Fetch message body (message's full content)

    -

    Usage

    -

    ImapCon$fetch_body(
-  msg_id,
-  use_uid = FALSE,
-  mime_level = NULL,
-  peek = TRUE,
-  partial = NULL,
-  write_to_disk = FALSE,
-  keep_in_mem = TRUE,
-  mute = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    msg_id
    -

    A numeric vector containing one or more message ids.

    - - -
    use_uid
    -

    Default is FALSE. In this case, the operation will +

    + +

    +

    Method fetch_body()

    +

    Fetch message body (message's full content)

    Usage

    +

    ImapCon$fetch_body(
+  msg_id,
+  use_uid = FALSE,
+  mime_level = NULL,
+  peek = TRUE,
+  partial = NULL,
+  write_to_disk = FALSE,
+  keep_in_mem = TRUE,
+  mute = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    msg_id

    A numeric vector containing one or more message ids.

    + +
    use_uid

    Default is FALSE. In this case, the operation will be performed using message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -1972,57 +1592,38 @@

    Arguments or unique identifier. UIDs are always the same during the life cycle of a message in a mail folder.

    - -
    mime_level
    -

    An integer specifying MIME multipart to fetch from +

    mime_level

    An integer specifying MIME multipart to fetch from the message's body. Default is NULL, which retrieves the full body content.

    - -
    peek
    -

    If TRUE, it does not mark messages as "read" after +

    peek

    If TRUE, it does not mark messages as "read" after fetching. Default is TRUE.

    - -
    partial
    -

    NULL or a character string with format +

    partial

    NULL or a character string with format "startchar.endchar" indicating the size (in characters) of a message slice to fetch. Default is NULL, which will fetch the full specified content.

    - -
    write_to_disk
    -

    If TRUE, writes the fetched content of each message +

    write_to_disk

    If TRUE, writes the fetched content of each message to a text file in a local folder inside the working directory, also -returning the results with invisible(). Default is FALSE.

    +returning the results with invisible(). Default is FALSE.

    - -
    keep_in_mem
    -

    If TRUE, keeps a copy of each fetch result while +

    keep_in_mem

    If TRUE, keeps a copy of each fetch result while the operation is being performed with write_to_disk = TRUE. Default is FALSE, and it can only be set TRUE when write_to_disk = TRUE.

    - -
    mute
    -

    A logical. It provides a confirmation message if the +

    mute

    A logical. It provides a confirmation message if the command is successfully executed. It is only effective when write_to_disk = TRUE and keep_in_mem = FALSE. Default is FALSE.

    - -
    retries
    -

    Number of attempts to connect and execute the command. Default +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    A list with the fetch contents or a logical if write_to_disk = TRUE and keep_in_mem = FALSE.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # do a search and fetch the results (saving to disk) using the pipe
 con$search_string(expr = "@k-state.edu", where = "FROM") %>%
@@ -2034,36 +1635,29 @@ 
    Examples
    
-
    Method fetch_header()
    
-
    Fetch message header
    
-
    Usage
    
-
    ImapCon$fetch_header(
-  msg_id,
-  use_uid = FALSE,
-  fields = NULL,
-  negate_fields = FALSE,
-  peek = TRUE,
-  partial = NULL,
-  write_to_disk = FALSE,
-  keep_in_mem = TRUE,
-  mute = FALSE,
-  retries = 1
-)
    
-
    
-
-
    
-
    Arguments
    
-
    msg_id
    
-
    A numeric vector containing one or more message ids.
    
-
-
-
    use_uid
    
-
    Default is FALSE. In this case, the operation will
+
    
+
+
    
+
    Method fetch_header()
    
+
    Fetch message header
    Usage
    
+
    ImapCon$fetch_header(
+  msg_id,
+  use_uid = FALSE,
+  fields = NULL,
+  negate_fields = FALSE,
+  peek = TRUE,
+  partial = NULL,
+  write_to_disk = FALSE,
+  keep_in_mem = TRUE,
+  mute = FALSE,
+  retries = 1
+)
    
+
+
    Arguments
    
+
    
+
    msg_id
    A numeric vector containing one or more message ids.
    
+
+
    use_uid
    Default is FALSE. In this case, the operation will
 be performed using message sequence numbers. A message sequence number
 is a message's relative position to the oldest message in a mail folder.
 It may change after deleting or moving messages. If a message is deleted,
@@ -2071,63 +1665,42 @@ 
    Arguments or unique identifier.
 UIDs are always the same during the life cycle of a message in a mail folder.
    
 
-
-
    fields
    
-
    An optional character vector specifying which field(s)
+
    fields
    An optional character vector specifying which field(s)
 will be fetched from the message's header. If none is specified, it will
 fetch the full header.
    
 
-
-
    negate_fields
    
-
    If TRUE, negates the operation and seeks for
+
    negate_fields
    If TRUE, negates the operation and seeks for
 "NOT in the field". Default is FALSE.
    
 
-
-
    peek
    
-
    If TRUE, it does not mark messages as "read" after
+
    peek
    If TRUE, it does not mark messages as "read" after
 fetching. Default is TRUE.
    
 
-
-
    partial
    
-
    NULL or a character string with format
+
    partial
    NULL or a character string with format
 "startchar.endchar" indicating the size (in characters) of a message slice
 to fetch. Default is NULL, which will fetch the full specified content.
    
 
-
-
    write_to_disk
    
-
    If TRUE, writes the fetched content of each message
+
    write_to_disk
    If TRUE, writes the fetched content of each message
 to a text file in a local folder inside the working directory, also
-returning the results with invisible(). Default is FALSE.
    
+returning the results with invisible(). Default is FALSE.
    
 
-
-
    keep_in_mem
    
-
    If TRUE, keeps a copy of each fetch result while
+
    keep_in_mem
    If TRUE, keeps a copy of each fetch result while
 the operation is being performed with write_to_disk = TRUE. Default
 is FALSE, and it can only be set TRUE when
 write_to_disk = TRUE.
    
 
-
-
    mute
    
-
    A logical. It provides a confirmation message if the
+
    mute
    A logical. It provides a confirmation message if the
 command is successfully executed. It is only effective when write_to_disk = TRUE
 and keep_in_mem = FALSE. Default is FALSE.
    
 
-
-
    retries
    
-
    Number of attempts to connect and execute the command. Default
+
    retries
    Number of attempts to connect and execute the command. Default
 is 1.
    
 
-
-
    
-
    -
    -

    Returns

    +

    +

    Returns

    A list with the fetch contents or a logical if write_to_disk = TRUE and keep_in_mem = FALSE.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # do a search and fetch the results (also saving to disk) using the pipe
 out <- con$search_string(expr = "@k-state.edu", where = "CC") %>%
@@ -2138,33 +1711,26 @@ 
    Examples
    
-
    Method fetch_metadata()
    
-
    Fetch message metadata
    
-
    Usage
    
-
    ImapCon$fetch_metadata(
-  msg_id,
-  use_uid = FALSE,
-  attribute = NULL,
-  write_to_disk = FALSE,
-  keep_in_mem = TRUE,
-  mute = FALSE,
-  retries = 1
-)
    
-
    
-
-
    
-
    Arguments
    
-
    msg_id
    
-
    A numeric vector containing one or more message ids.
    
-
-
-
    use_uid
    
-
    Default is FALSE. In this case, the operation will
+
    
+
+
    
+
    Method fetch_metadata()
    
+
    Fetch message metadata
    Usage
    
+
    ImapCon$fetch_metadata(
+  msg_id,
+  use_uid = FALSE,
+  attribute = NULL,
+  write_to_disk = FALSE,
+  keep_in_mem = TRUE,
+  mute = FALSE,
+  retries = 1
+)
    
+
+
    Arguments
    
+
    
+
    msg_id
    A numeric vector containing one or more message ids.
    
+
+
    use_uid
    Default is FALSE. In this case, the operation will
 be performed using message sequence numbers. A message sequence number
 is a message's relative position to the oldest message in a mail folder.
 It may change after deleting or moving messages. If a message is deleted,
@@ -2172,57 +1738,38 @@ 
    Arguments or unique identifier.
 UIDs are always the same during the life cycle of a message in a mail folder.
    
 
+
    attribute
    An optional character vector specifying one or more
+attributes of the metadata of a message to fetch. See metadata_options.
    
 
-
    attribute
    
-
    An optional character vector specifying one or more
-attributes of the metadata of a message to fetch. See metadata_options.
    
-
-
-
    write_to_disk
    
-
    If TRUE, writes the fetched content of each message
+
    write_to_disk
    If TRUE, writes the fetched content of each message
 to a text file in a local folder inside the working directory, also
-returning the results with invisible(). Default is FALSE.
    
-
+returning the results with invisible(). Default is FALSE.
    
 
-
    keep_in_mem
    
-
    If TRUE, keeps a copy of each fetch result while
+
    keep_in_mem
    If TRUE, keeps a copy of each fetch result while
 the operation is being performed with write_to_disk = TRUE. Default
 is FALSE, and it can only be set TRUE when
 write_to_disk = TRUE.
    
 
-
-
    mute
    
-
    A logical. It provides a confirmation message if the
+
    mute
    A logical. It provides a confirmation message if the
 command is successfully executed. It is only effective when write_to_disk = TRUE
 and keep_in_mem = FALSE. Default is FALSE.
    
 
-
-
    retries
    
-
    Number of attempts to connect and execute the command. Default
+
    retries
    Number of attempts to connect and execute the command. Default
 is 1.
    
 
-
-
    peek
    
-
    If TRUE, it does not mark messages as "read" after
+
    peek
    If TRUE, it does not mark messages as "read" after
 fetching. Default is TRUE.
    
 
-
-
    partial
    
-
    NULL or a character string with format
+
    partial
    NULL or a character string with format
 "startchar.endchar" indicating the size (in characters) of a message slice
 to fetch. Default is NULL, which will fetch the full specified content.
    
 
-
-
    
-
    -
    -

    Returns

    +

    +

    Returns

    A list with the fetch contents or a logical if write_to_disk = TRUE and keep_in_mem = FALSE.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # do a search and fetch the results using the pipe
 out <- con$search_string(expr = "@k-state.edu", where = "FROM") %>%
@@ -2233,35 +1780,28 @@ 
    Examples
    
-
    Method fetch_text()
    
-
    Fetch message text
    
-
    Usage
    
-
    ImapCon$fetch_text(
-  msg_id,
-  use_uid = FALSE,
-  peek = TRUE,
-  partial = NULL,
-  write_to_disk = FALSE,
-  keep_in_mem = TRUE,
-  mute = FALSE,
-  base64_decode = FALSE,
-  retries = 1
-)
    
-
    
-
-
    
-
    Arguments
    
-
    msg_id
    
-
    A numeric vector containing one or more message ids.
    
-
-
-
    use_uid
    
-
    Default is FALSE. In this case, the operation will
+
    
+
+
    
+
    Method fetch_text()
    
+
    Fetch message text
    Usage
    
+
    ImapCon$fetch_text(
+  msg_id,
+  use_uid = FALSE,
+  peek = TRUE,
+  partial = NULL,
+  write_to_disk = FALSE,
+  keep_in_mem = TRUE,
+  mute = FALSE,
+  base64_decode = FALSE,
+  retries = 1
+)
    
+
+
    Arguments
    
+
    
+
    msg_id
    A numeric vector containing one or more message ids.
    
+
+
    use_uid
    Default is FALSE. In this case, the operation will
 be performed using message sequence numbers. A message sequence number
 is a message's relative position to the oldest message in a mail folder.
 It may change after deleting or moving messages. If a message is deleted,
@@ -2269,57 +1809,38 @@ 
    Arguments or unique identifier.
 UIDs are always the same during the life cycle of a message in a mail folder.
    
 
-
-
    peek
    
-
    If TRUE, it does not mark messages as "read" after
+
    peek
    If TRUE, it does not mark messages as "read" after
 fetching. Default is TRUE.
    
 
-
-
    partial
    
-
    NULL or a character string with format
+
    partial
    NULL or a character string with format
 "startchar.endchar" indicating the size (in characters) of a message slice
 to fetch. Default is NULL, which will fetch the full specified content.
    
 
-
-
    write_to_disk
    
-
    If TRUE, writes the fetched content of each message
+
    write_to_disk
    If TRUE, writes the fetched content of each message
 to a text file in a local folder inside the working directory, also
-returning the results with invisible(). Default is FALSE.
    
-
+returning the results with invisible(). Default is FALSE.
    
 
-
    keep_in_mem
    
-
    If TRUE, keeps a copy of each fetch result while
+
    keep_in_mem
    If TRUE, keeps a copy of each fetch result while
 the operation is being performed with write_to_disk = TRUE. Default
 is FALSE, and it can only be set TRUE when
 write_to_disk = TRUE.
    
 
-
-
    mute
    
-
    A logical. It provides a confirmation message if the
+
    mute
    A logical. It provides a confirmation message if the
 command is successfully executed. It is only effective when write_to_disk = TRUE
 and keep_in_mem = FALSE. Default is FALSE.
    
 
-
-
    base64_decode
    
-
    If TRUE, tries to guess and decode the fetched
+
    base64_decode
    If TRUE, tries to guess and decode the fetched
 text from base64 format to character. Default is FALSE.
    
 
-
-
    retries
    
-
    Number of attempts to connect and execute the command. Default
+
    retries
    Number of attempts to connect and execute the command. Default
 is 1.
    
 
-
-
    
-
    -
    -

    Returns

    +

    +

    Returns

    A list with the fetch contents or a logical if write_to_disk = TRUE and keep_in_mem = FALSE.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # do a search and partially fetch the results using the pipe
 # first 200 characters, writing to disk, silence results in the console
@@ -2336,32 +1857,25 @@ 
    Examples
    
-
    Method copy_msg()
    
-
    Copy message(s) between the selected folder and another one
    
-
    Usage
    
-
    ImapCon$copy_msg(
-  msg_id,
-  use_uid = FALSE,
-  to_folder,
-  reselect = TRUE,
-  mute = FALSE,
-  retries = 1
-)
    
-
    
-
-
    
-
    Arguments
    
-
    msg_id
    
-
    A numeric vector containing one or more message ids.
    
-
-
-
    use_uid
    
-
    Default is FALSE. In this case, the operation will
+
    
+
+
    
+
    Method copy_msg()
    
+
    Copy message(s) between the selected folder and another one
    Usage
    
+
    ImapCon$copy_msg(
+  msg_id,
+  use_uid = FALSE,
+  to_folder,
+  reselect = TRUE,
+  mute = FALSE,
+  retries = 1
+)
    
+
+
    Arguments
    
+
    
+
    msg_id
    A numeric vector containing one or more message ids.
    
+
+
    use_uid
    Default is FALSE. In this case, the operation will
 be performed using message sequence numbers. A message sequence number
 is a message's relative position to the oldest message in a mail folder.
 It may change after deleting or moving messages. If a message is deleted,
@@ -2369,37 +1883,24 @@ 
    Arguments or unique identifier.
 UIDs are always the same during the life cycle of a message in a mail folder.
    
 
-
-
    to_folder
    
-
    A character string specifying the folder to which
+
    to_folder
    A character string specifying the folder to which
 the messages will be copied.
    
 
-
-
    reselect
    
-
    A logical. If TRUE, calls
-ImapCon$select_folder(name = to_folder)
+
    reselect
    A logical. If TRUE, calls
+ImapCon$select_folder(name = to_folder)
 under the hood before returning the output. Default is TRUE.
    
 
-
-
    mute
    
-
    A logical. If TRUE, mutes the confirmation message
+
    mute
    A logical. If TRUE, mutes the confirmation message
 when the command is successfully executed. Default is FALSE.
    
 
-
-
    retries
    
-
    Number of attempts to connect and execute the command.
+
    retries
    Number of attempts to connect and execute the command.
 Default is 1.
    
 
-
-
    
-
    -
    -

    Returns

    +

    +

    Returns

    An invisible numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # do a search and copy the results to another folder
 con$search_string(expr = "@k-state.edu", where = "FROM") %>%
@@ -2410,32 +1911,25 @@ 
    Examples
    -
    - - -

    -

    Method move_msg()

    -

    Move message(s) between the selected folder and another one

    -

    Usage

    -

    ImapCon$move_msg(
-  msg_id,
-  use_uid = FALSE,
-  to_folder,
-  reselect = TRUE,
-  mute = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    msg_id
    -

    A numeric vector containing one or more message ids.

    - - -
    use_uid
    -

    Default is FALSE. In this case, the operation will +

    + +

    +

    Method move_msg()

    +

    Move message(s) between the selected folder and another one

    Usage

    +

    ImapCon$move_msg(
+  msg_id,
+  use_uid = FALSE,
+  to_folder,
+  reselect = TRUE,
+  mute = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    msg_id

    A numeric vector containing one or more message ids.

    + +
    use_uid

    Default is FALSE. In this case, the operation will be performed using message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -2443,37 +1937,24 @@

    Arguments or unique identifier. UIDs are always the same during the life cycle of a message in a mail folder.

    - -
    to_folder
    -

    A character string specifying the folder to which +

    to_folder

    A character string specifying the folder to which the messages will be copied.

    - -
    reselect
    -

    A logical. If TRUE, calls -ImapCon$select_folder(name = to_folder) +

    reselect

    A logical. If TRUE, calls +ImapCon$select_folder(name = to_folder) under the hood before returning the output. Default is TRUE.

    - -
    mute
    -

    A logical. If TRUE, mutes the confirmation message +

    mute

    A logical. If TRUE, mutes the confirmation message when the command is successfully executed. Default is FALSE.

    - -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    An invisible numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # do a search and copy the results to another folder
 con$search_string(expr = "@k-state.edu", where = "FROM") %>%
@@ -2484,28 +1965,21 @@ 
    Examples
    -
    - +

    -

    -

    Method esearch_count()

    +

    +

    Method esearch_count()

    Count the number of messages with a specific flag(s) in a - folder (depend on ESEARCH capability)

    -

    Usage

    -

    ImapCon$esearch_count(flag, use_uid = FALSE, retries = 1)

    -
    + folder (depend on ESEARCH capability)

    Usage

    +

    ImapCon$esearch_count(flag, use_uid = FALSE, retries = 1)

    -
    -

    Arguments

    -

    flag
    -

    A mandatory parameter that specifies one or more flags as a -filter to the counting operation. Use ImapCon$list_flags() +

    Arguments

    +

    +
    flag

    A mandatory parameter that specifies one or more flags as a +filter to the counting operation. Use ImapCon$list_flags() to list the flags in a selected mail folder.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -2514,45 +1988,31 @@

    Arguments -

    Returns

    +

    +

    Returns

    A numeric vector of length 1 containing the number of messages in the folder that meet the specified criteria.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # count the number of messages marked as "Flagged" and "Answered"
 con$esearch_count(flag = c("Flagged", "Answered"))
 }
-
    -
    - +

    -

    -

    Method delete_msg()

    -

    Delete message(s) in the selected mail folder

    -

    Usage

    -

    ImapCon$delete_msg(msg_id, use_uid = FALSE, mute = FALSE, retries = 1)

    -
    - -
    -

    Arguments

    -

    msg_id
    -

    A numeric vector containing one or more message ids.

    +

    +

    Method delete_msg()

    +

    Delete message(s) in the selected mail folder

    Usage

    +

    ImapCon$delete_msg(msg_id, use_uid = FALSE, mute = FALSE, retries = 1)

    +

    Arguments

    +

    +
    msg_id

    A numeric vector containing one or more message ids.

    -
    use_uid
    -

    Default is FALSE. In this case, the operation will +

    use_uid

    Default is FALSE. In this case, the operation will be performed using message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -2560,93 +2020,63 @@

    Arguments or unique identifier. UIDs are always the same during the life cycle of a message in a mail folder.

    - -
    mute
    -

    A logical. If TRUE, mutes the confirmation message +

    mute

    A logical. If TRUE, mutes the confirmation message when the command is successfully executed. Default is FALSE.

    - -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    An invisible numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # delete
 con$delete_msg(flag = c("Flagged", "Answered"))
 }
-
    -
    +

    +

    +

    Method expunge()

    +

    Permanently removes all or specific messages marked as deleted from the selected folder

    Usage

    +

    ImapCon$expunge(msg_uid = NULL, mute = FALSE, retries = 1)

    -

    -

    Method expunge()

    -

    Permanently removes all or specific messages marked as deleted from the selected folder

    -

    Usage

    -

    ImapCon$expunge(msg_uid = NULL, mute = FALSE, retries = 1)

    -
    - -
    -

    Arguments

    -

    msg_uid
    -

    A numeric vector containing one or more messages UIDs. +

    Arguments

    +

    +
    msg_uid

    A numeric vector containing one or more messages UIDs. Only UIDs are allowed in this operation (note the "u" in msg_uid).

    - -
    mute
    -

    A logical. If TRUE, mutes the confirmation message +

    mute

    A logical. If TRUE, mutes the confirmation message when the command is successfully executed. Default is FALSE.

    - -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    TRUE if the operation is successful.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # count the number of messages marked as "Flagged" and "Answered"
 con$esearch_count(flag = c("Flagged", "Answered"))
 }
-
    -
    +

    - -

    -

    Method esearch_min_id()

    +

    +

    Method esearch_min_id()

    Search the minimum message id in the selected mail folder - (depend on ESEARCH capability)

    -

    Usage

    -

    ImapCon$esearch_min_id(flag, use_uid = FALSE, retries = 1)

    -
    + (depend on ESEARCH capability)

    Usage

    +

    ImapCon$esearch_min_id(flag, use_uid = FALSE, retries = 1)

    -
    -

    Arguments

    -

    flag
    -

    A mandatory parameter that specifies one or more flags as a -filter to the searching operation. Use ImapCon$list_flags() +

    Arguments

    +

    +
    flag

    A mandatory parameter that specifies one or more flags as a +filter to the searching operation. Use ImapCon$list_flags() to list the flags in a selected mail folder.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -2655,48 +2085,34 @@

    Arguments -

    Returns

    +

    +

    Returns

    A numeric vector of length 1 containing the minimum message id in the folder.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # Search the minimum id of messages marked as "Answered"
 con$esearch_min_id(flag = "Answered")
 }
-
    -
    +

    - -

    -

    Method esearch_max_id()

    +

    +

    Method esearch_max_id()

    Search the maximum message id in the selected mail folder - (depend on ESEARCH capability)

    -

    Usage

    -

    ImapCon$esearch_max_id(flag, use_uid = FALSE, retries = 1)

    -
    + (depend on ESEARCH capability)

    Usage

    +

    ImapCon$esearch_max_id(flag, use_uid = FALSE, retries = 1)

    -
    -

    Arguments

    -

    flag
    -

    A mandatory parameter that specifies one or more flags as a -filter to the searching operation. Use ImapCon$list_flags() +

    Arguments

    +

    +
    flag

    A mandatory parameter that specifies one or more flags as a +filter to the searching operation. Use ImapCon$list_flags() to list the flags in a selected mail folder.

    - -
    use_uid
    -

    Default is FALSE. In this case, results will be +

    use_uid

    Default is FALSE. In this case, results will be presented as message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -2705,51 +2121,37 @@

    Arguments -

    Returns

    +

    +

    Returns

    A numeric vector of length 1 containing the maximum message id in the folder.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # Search the minimum id of messages marked as "Seen"
 con$esearch_max_id(flag = "Seen")
 }
-
    -
    - - -

    -

    Method add_flags()

    -

    Add flags to one or more messages

    -

    Usage

    -

    ImapCon$add_flags(
-  msg_id,
-  use_uid = FALSE,
-  flags_to_set,
-  mute = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    msg_id
    -

    A numeric vector containing one or more message ids.

    - - -
    use_uid
    -

    Default is FALSE. In this case, the operation will +

    + +

    +

    Method add_flags()

    +

    Add flags to one or more messages

    Usage

    +

    ImapCon$add_flags(
+  msg_id,
+  use_uid = FALSE,
+  flags_to_set,
+  mute = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    msg_id

    A numeric vector containing one or more message ids.

    + +
    use_uid

    Default is FALSE. In this case, the operation will be performed using message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -2757,63 +2159,45 @@

    Arguments or unique identifier. UIDs are always the same during the life cycle of a message in a mail folder.

    - -
    flags_to_set
    -

    A character vector containing one or more flag +

    flags_to_set

    A character vector containing one or more flag names to add to the specified message ids. If the flag to be set is a system flag, such as \SEEN, \ANSWERED, the name should be preceded by two backslashes \.

    - -
    mute
    -

    A logical. If TRUE, mutes the confirmation message +

    mute

    A logical. If TRUE, mutes the confirmation message when the command is successfully executed. Default is FALSE.

    - -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    An invisible numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # Add the "\Seen" permanent flag to the messages received in the last hour
 con$search_younger_than(seconds = 3600) %>% # depends on the WITHIN extension
   con$add_flags(flags_to_set = "\\Seen")
 }
-
    -
    - - -

    -

    Method replace_flags()

    -

    Replace the current flags of one or more messages

    -

    Usage

    -

    ImapCon$replace_flags(
-  msg_id,
-  use_uid = FALSE,
-  flags_to_set,
-  mute = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    msg_id
    -

    A numeric vector containing one or more message ids.

    - - -
    use_uid
    -

    Default is FALSE. In this case, the operation will +

    + +

    +

    Method replace_flags()

    +

    Replace the current flags of one or more messages

    Usage

    +

    ImapCon$replace_flags(
+  msg_id,
+  use_uid = FALSE,
+  flags_to_set,
+  mute = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    msg_id

    A numeric vector containing one or more message ids.

    + +
    use_uid

    Default is FALSE. In this case, the operation will be performed using message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -2821,64 +2205,46 @@

    Arguments or unique identifier. UIDs are always the same during the life cycle of a message in a mail folder.

    - -
    flags_to_set
    -

    A character vector containing one or more flag +

    flags_to_set

    A character vector containing one or more flag names that will replace the current ones. If the flag to be set is a system flag, such as \SEEN, \ANSWERED, the name should be preceded by two backslashes \.

    - -
    mute
    -

    A logical. If TRUE, mutes the confirmation message +

    mute

    A logical. If TRUE, mutes the confirmation message when the command is successfully executed. Default is FALSE.

    - -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    An invisible numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # Replace the current flags of the messages in the search results for the
 #.. flags "\UNSEEN" and "\Flagged"
 con$search_since(date_char = "20-Aug-2020") %>%
   con$replace_flags(flags_to_set = c("\\UNSEEN", "\\Flagged")
 }
-
    -
    - - -

    -

    Method remove_flags()

    -

    Remove flag(s) of one or more messages

    -

    Usage

    -

    ImapCon$remove_flags(
-  msg_id,
-  use_uid = FALSE,
-  flags_to_unset,
-  mute = FALSE,
-  retries = 1
-)

    -
    - -
    -

    Arguments

    -

    msg_id
    -

    A numeric vector containing one or more message ids.

    - - -
    use_uid
    -

    Default is FALSE. In this case, the operation will +

    + +

    +

    Method remove_flags()

    +

    Remove flag(s) of one or more messages

    Usage

    +

    ImapCon$remove_flags(
+  msg_id,
+  use_uid = FALSE,
+  flags_to_unset,
+  mute = FALSE,
+  retries = 1
+)

    + +

    Arguments

    +

    +
    msg_id

    A numeric vector containing one or more message ids.

    + +
    use_uid

    Default is FALSE. In this case, the operation will be performed using message sequence numbers. A message sequence number is a message's relative position to the oldest message in a mail folder. It may change after deleting or moving messages. If a message is deleted, @@ -2886,89 +2252,62 @@

    Arguments or unique identifier. UIDs are always the same during the life cycle of a message in a mail folder.

    - -
    flags_to_unset
    -

    A character vector containing one or more +

    flags_to_unset

    A character vector containing one or more flag names that will be unset (removed). If the flag to be removed is a system flag, such as \SEEN, \ANSWERED, the name should be preceded by two backslashes \.

    - -
    mute
    -

    A logical. If TRUE, mutes the confirmation message +

    mute

    A logical. If TRUE, mutes the confirmation message when the command is successfully executed. Default is FALSE.

    - -
    retries
    -

    Number of attempts to connect and execute the command. +

    retries

    Number of attempts to connect and execute the command. Default is 1.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    An invisible numeric vector containing the message ids.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # Remove the the "\SEEN" flag from the messages in the search result
 con$search_since(date_char = "20-Aug-2020") %>%
   con$remove_flags(flags_to_unset = "\\UNSEEN")
 }
-
    -
    - - -

    -

    Method get_attachments()

    -

    Extract attached file(s) from fetched message(s)

    -

    Usage

    -

    ImapCon$get_attachments(
-  msg_list,
-  content_disposition = "both",
-  override = FALSE,
-  mute = FALSE
-)

    -
    - -
    -

    Arguments

    -

    msg_list
    -

    A list with the body or text content of the messages -fetched with ImapCon$fetch_body() or -ImapCon$fetch_text().

    - - -
    content_disposition
    -

    A string indicating which type of +

    + +

    +

    Method get_attachments()

    +

    Extract attached file(s) from fetched message(s)

    Usage

    +

    ImapCon$get_attachments(
+  msg_list,
+  content_disposition = "both",
+  override = FALSE,
+  mute = FALSE
+)

    + +

    Arguments

    +

    +
    msg_list

    A list with the body or text content of the messages +fetched with ImapCon$fetch_body() or +ImapCon$fetch_text().

    + +
    content_disposition

    A string indicating which type of "Content-Disposition" attachments should be retrieved. Default is "both", which retrieves regular attachments ("Content-Disposition: attachment") and inline attachments ("Content-Disposition: inline").

    - -
    override
    -

    A logical. Provides a confirmation message if the +

    override

    A logical. Provides a confirmation message if the command is successfully executed. Default is FALSE.

    - -
    mute
    -

    A logical. If TRUE, mutes the confirmation message +

    mute

    A logical. If TRUE, mutes the confirmation message when the command is successfully executed. Default is FALSE.

    - -

    -
    -
    -

    Returns

    +

    +

    Returns

    TRUE if the operation is successful. The files are saved locally.

    -
    -
    -

    Examples

    -

    \dontrun{
+
    Examples
    
+
    \dontrun{
 # example 1
 con$select_folder(name = "INBOX")
 con$search_string(expr = "@gmail", where = "CC") %>%
@@ -2980,25 +2319,18 @@ 
    Examples
    
-
    Method fetch_attachments_list()
    
-
    Fetch attachments' list
    
-
    Usage
    
-
    ImapCon$fetch_attachments_list(msg_id, use_uid = FALSE, retries = 1)
    
-
    
-
-
    
-
    Arguments
    
-
    msg_id
    
-
    A numeric vector containing one or more message ids.
    
+
    
+
    Method fetch_attachments_list()
    
+
    Fetch attachments' list
    Usage
    
+
    ImapCon$fetch_attachments_list(msg_id, use_uid = FALSE, retries = 1)
    
 
+
    Arguments
    
+
    
+
    msg_id
    A numeric vector containing one or more message ids.
    
 
-
    use_uid
    
-
    Default is FALSE. In this case, the operation will
+
    use_uid
    Default is FALSE. In this case, the operation will
 be performed using message sequence numbers. A message sequence number
 is a message's relative position to the oldest message in a mail folder.
 It may change after deleting or moving messages. If a message is deleted,
@@ -3006,21 +2338,14 @@ 
    Arguments or unique identifier.
 UIDs are always the same during the life cycle of a message in a mail folder.
    
 
-
-
    retries
    
-
    Number of attempts to connect and execute the command. Default
+
    retries
    Number of attempts to connect and execute the command. Default
 is 1.
    
 
-
-
    
-
    
-
    
-
    Returns
    
+
    
+
    Returns
    
 
    A list with the fetch contents.
    
-
    
-
    
-
    Examples
    
-
    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # do a search and fetch the attachments' list of the messages
 out < con$search_string(expr = "@k-state.edu", where = "FROM") %>%
@@ -3033,32 +2358,25 @@ 
    Examples
    
-
    Method fetch_attachments()
    
-
    Fetch message attachments
    
-
    Usage
    
-
    ImapCon$fetch_attachments(
-  msg_id,
-  use_uid = FALSE,
-  content_disposition = "both",
-  override = FALSE,
-  mute = FALSE,
-  retries = 1
-)
    
-
    
-
-
    
-
    Arguments
    
-
    msg_id
    
-
    A numeric vector containing one or more message ids.
    
-
-
-
    use_uid
    
-
    Default is FALSE. In this case, the operation will
+
    
+
+
    
+
    Method fetch_attachments()
    
+
    Fetch message attachments
    Usage
    
+
    ImapCon$fetch_attachments(
+  msg_id,
+  use_uid = FALSE,
+  content_disposition = "both",
+  override = FALSE,
+  mute = FALSE,
+  retries = 1
+)
    
+
+
    Arguments
    
+
    
+
    msg_id
    A numeric vector containing one or more message ids.
    
+
+
    use_uid
    Default is FALSE. In this case, the operation will
 be performed using message sequence numbers. A message sequence number
 is a message's relative position to the oldest message in a mail folder.
 It may change after deleting or moving messages. If a message is deleted,
@@ -3066,39 +2384,26 @@ 
    Arguments or unique identifier.
 UIDs are always the same during the life cycle of a message in a mail folder.
    
 
-
-
    content_disposition
    
-
    A string indicating which type of
+
    content_disposition
    A string indicating which type of
 "Content-Disposition" attachments should be retrieved. The options are
 both, attachment, and inline. Default is
 "both", which retrieves regular attachments ("Content-Disposition:
 attachment") and  inline attachments ("Content-Disposition: inline").
    
 
-
-
    override
    
-
    A logical. Provides a confirmation message if the
+
    override
    A logical. Provides a confirmation message if the
 command is successfully executed. Default is FALSE.
    
 
-
-
    mute
    
-
    A logical. If TRUE, mutes the confirmation message
+
    mute
    A logical. If TRUE, mutes the confirmation message
 when the command is successfully executed. Default is FALSE.
    
 
-
-
    retries
    
-
    Number of attempts to connect and execute the command. Default
+
    retries
    Number of attempts to connect and execute the command. Default
 is 1.
    
 
-
-
    
-
    
-
    
-
    Returns
    
+
    
+
    Returns
    
 
    A list with the fetch contents.
    
-
    
-
    
-
    Examples
    
-
    \dontrun{
+
    Examples
    
+
    \dontrun{
 con$select_folder(name = "INBOX")
 # do a search and fetch the attachments' list of the messages
 con$search_string(expr = "@k-state.edu", where = "FROM") %>%
@@ -3110,51 +2415,48 @@ 
    Examples
    Method clone()
    
+
    The objects of this class are cloneable with this method.
    Usage
    
+
    ImapCon$clone(deep = FALSE)
    
 
-
    
-
    Method clone()
    
-
    The objects of this class are cloneable with this method.
    
-
    Usage
    
-
    ImapCon$clone(deep = FALSE)
    
-
    
+
    Arguments
    
+
    
+
    deep
    Whether to make a deep clone.
    
 
-
    
-
    Arguments
    
-
    deep
    
-
    Whether to make a deep clone.
    
+
    
 
 
-
    
-
    
 
+    
    Examples
    
+    
    
+  
    
+  
 
    
 
-    
    
-
-    
    
-    
    Examples
    
-    
-    
    
-  
    
-
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
    
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/OR.html b/docs/reference/OR.html
index 1eb29f1..4e54e50 100644
--- a/docs/reference/OR.html
+++ b/docs/reference/OR.html
@@ -1,133 +1,223 @@
+
 
-Relational-operator-function to construct a custom search statement — OR • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
 
-    
    
-
    
-  
    
-      
    Relational-operator-function to construct a custom search statement
    
-      Source: R/OR.R
-      
    OR.Rd
    
-    
    
+
+
+
 
-    
    
-    
    Relational-operator-function to construct a custom search statement
    
-    
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-    
    
-    
    Usage
    
-    
    OR(..., negate = FALSE)
    
-    
    
 
-    
    
-    
    Arguments
    
-    
    ...
    
-
    a combination of criteria constructor functions with its arguments.
    
 
 
-
    negate
    
-
    If TRUE, negates the search and seeks for
-"NOT search_criterion". Default is FALSE.
    
+
+
+
 
-
    
-    
    
-    
    Value
    
-    
 
-
    A search string to be used as a request parameter in
    
-
    
-
    ImapCon$search() function.
    
+
+
+
+
+
+
+
+
+
+
+  
+
+  
+    
    
+      
    
+      
    
+
+
    
+  
    
+    
    
+    
    Relational-operator-function to construct a custom search statement
    
+    Source: R/OR.R
+    
     
    
 
-    
    
-    
    Examples
    
-    
    if (FALSE) {
-# select folder & search
-con$select_folder(name = "INBOX")
-# search for messages SINCE "30-Ago-2019" OR SMALLER than 512KB.
-res <- con$search(request = OR(sent_since(date_char = "30-Ago-2019"),
-                                smaller_than(size = 512000)))
-}
-
    
+    
    
+    
    Relational-operator-function to construct a custom search statement
    
     
    
-  
    
+
+    
    OR(..., negate = FALSE)
    
+
+    
    Arguments
    
+    
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
    ...
    a combination of criteria constructor functions with its arguments.
    negate
    If TRUE, negates the search and seeks for
+"NOT search_criterion". Default is FALSE.
    
+
+    
    Value
    
+
+    
    A search string to be used as a request parameter in
+ ImapCon$search() function.
    
+    
    See also
    
+
+    
    Other custom search: 
+AND(),
+ImapCon,
+before(),
+flag(),
+larger_than(),
+older_than(),
+on(),
+sent_before(),
+sent_on(),
+sent_since(),
+since(),
+smaller_than(),
+string(),
+younger_than()
    
+
+    
    Examples
    
+    
    if (FALSE) {
+# select folder & search
+con$select_folder(name = "INBOX")
+# search for messages SINCE "30-Ago-2019" OR SMALLER than 512KB.
+res <- con$search(request = OR(sent_since(date_char = "30-Ago-2019"),
+                                smaller_than(size = 512000)))
+}
+
    
+  
    
+  
+
 
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/before.html b/docs/reference/before.html
index 992622c..c6f14ae 100644
--- a/docs/reference/before.html
+++ b/docs/reference/before.html
@@ -1,135 +1,225 @@
+
 
-Criterion constructor function to be combined in a custom search statement — before • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
+
+Criterion constructor function to be combined in a custom search statement — before • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-    
    
 
    
-  
    
-      
    Criterion constructor function to be combined in a custom search statement
    
-      Source: R/before.R
-      
    before.Rd
    
+  
    
+    
    
+    
    Criterion constructor function to be combined in a custom search statement
    
+    Source: R/before.R
+    
     
    
 
-    
    
+    
    
     
    Criterion constructor function to be combined in a custom search statement
    
     
    
 
-    
    
-    
    Usage
    
-    
    before(date_char, negate = FALSE)
    
-    
    
+    
    before(date_char, negate = FALSE)
    
 
-    
    
-    
    Arguments
    
-    
    date_char
    
-
    A character string with format "DD-Mon-YYYY", e.g.
+    
    Arguments
    
+    
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
    date_char
    A character string with format "DD-Mon-YYYY", e.g.
 "01-Apr-2019". We opt not to use Date or POSIX* like
-objects, since IMAP servers use this unusual date format.
    
-
-
-
    negate
    
-
    If TRUE, negates the search and seeks for "NOT SEARCH
-CRITERIA". Default is FALSE.
    
-
-
-    
    
-    
    Value
    
-    
-
-
    A search string to be used as a request parameter in
    
-
    
-
    ImapCon$search() function.
    
-    
    
-    
    
-    
    See also
    
-    
    Other custom search: 
-AND(),
-ImapCon,
-OR(),
-flag(),
-larger_than(),
-older_than(),
-on(),
-sent_before(),
-sent_on(),
-sent_since(),
-since(),
-smaller_than(),
-string(),
-younger_than()
    
-    
    
-
-    
    
-    
    Examples
    
-    
    if (FALSE) {
-# select folder & search
-con$select_folder(name = "INBOX")
-# search for messages BEFORE "17-Apr-2019" AND NOT SMALLER than 512KB.
-res <- con$search(request = AND(before(date_char = "17-Apr-2019"),
-                                smaller_than(size = 512000, negate = TRUE)))
-}
-
    
-    
    
-  
+objects, since IMAP servers use this unusual date format.
    negate
    If TRUE, negates the search and seeks for "NOT SEARCH
+CRITERIA". Default is FALSE.
    
+
+    
    Value
    
+
+    
    A search string to be used as a request parameter in
+ ImapCon$search() function.
    
+    
    See also
    
+
+    
    Other custom search: 
+AND(),
+ImapCon,
+OR(),
+flag(),
+larger_than(),
+older_than(),
+on(),
+sent_before(),
+sent_on(),
+sent_since(),
+since(),
+smaller_than(),
+string(),
+younger_than()
    
+
+    
    Examples
    
+    
    if (FALSE) {
+# select folder & search
+con$select_folder(name = "INBOX")
+# search for messages BEFORE "17-Apr-2019" AND NOT SMALLER than 512KB.
+res <- con$search(request = AND(before(date_char = "17-Apr-2019"),
+                                smaller_than(size = 512000, negate = TRUE)))
+}
+
    
+  
    
+  
+
    
 
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
    
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/configure_imap.html b/docs/reference/configure_imap.html
index 1d2e3e2..cbc012d 100644
--- a/docs/reference/configure_imap.html
+++ b/docs/reference/configure_imap.html
@@ -1,167 +1,259 @@
+
 
-IMAP Connection Configuration — configure_imap • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
 
-    
    
-
    
-  
    
-      
    IMAP Connection Configuration
    
-      Source: R/configure-imap.R
-      
    configure_imap.Rd
    
-    
    
+
+
+
 
-    
    
-    
    Configure and create a new IMAP connection.
    
-    
    
-
-    
    
-    
    Usage
    
-    
    configure_imap(
-  url,
-  username,
-  password = NULL,
-  xoauth2_bearer = NULL,
-  use_ssl = TRUE,
-  verbose = FALSE,
-  buffersize = 16000,
-  timeout_ms = 0,
-  ...
-)
    
-    
    
-
-    
    
-    
    Arguments
    
-    
    url
    
-
    A character string containing the IMAP server address
    
-
-
-
    username
    
-
    A character string containing the username.
    
+
+
+
 
+
+
 
-
    password
    
-
    A character string containing the user's password.
    
+
+
+
 
+
+
+
 
-
    xoauth2_bearer
    
-
    A character string containing the oauth2 bearer token.
    
 
 
-
    use_ssl
    
-
    A logical indicating the use or not of Secure Sockets Layer
-encryption when connecting to the IMAP server. Default is TRUE.
    
 
+
+
+
 
-
    verbose
    
-
    If FALSE, mutes the flow of information between the
-server and the client. Default is FALSE.
    
 
 
-
    buffersize
    
-
    The size in bytes for the receive buffer. Default is
-16000 bytes or 16kb, which means it will use the libcurl's default value.
-According to the libcurl's documentation, the maximum buffersize is 512kb
-(or 512000 bytes), but any number passed to buffersize is treated
-as a request, not an order.
    
 
+
+
+
 
-
    timeout_ms
    
-
    Time in milliseconds (ms) to wait for the execution or
-re-execution of a command. Default is 0, which means that no timeout limit is
-set.
    
+
+
+
+
+  
+
+  
+    
    
+      
    
+      
 
-
    ...
    
-
    Further curl parameters (see curl::curl_options) that
-can be used with the IMAP protocol. Only for advanced users.
    
+      
 
-
    
-    
    
-    
    Value
    
-    
+      
 
-
    A new `ImapCon` object.
    
+
    
+  
    
+    
    
+    
    IMAP Connection Configuration
    
+    Source: R/configure-imap.R
+    
     
    
 
-    
    
-    
    Examples
    
-    
    if (FALSE) {
-# w/ Plain authentication
-con <- configure_imap(
-  url="imaps://outlook.office365.com",
-  username="user@agency.gov.br",
-  password=rstudioapi::askForPassword(),
-  verbose = TRUE)
-
-# w/ OAuth2.0 authentication
-con <- configure_imap(
-  url="imaps://outlook.office365.com",
-  username="user@agency.gov.br",
-  verbose = TRUE,
-  xoauth2_bearer = "XX.Ya9...")
-}
-
    
+    
    
+    
    Configure and create a new IMAP connection.
    
     
    
-  
    
+
+    
    configure_imap(
+  url,
+  username,
+  password = NULL,
+  xoauth2_bearer = NULL,
+  use_ssl = TRUE,
+  verbose = FALSE,
+  buffersize = 16000,
+  timeout_ms = 0,
+  ...
+)
    
+
+    
    Arguments
    
+    
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
    url
    A character string containing the IMAP server address
    username
    A character string containing the username.
    password
    A character string containing the user's password.
    xoauth2_bearer
    A character string containing the oauth2 bearer token.
    use_ssl
    A logical indicating the use or not of Secure Sockets Layer
+encryption when connecting to the IMAP server. Default is TRUE.
    verbose
    If FALSE, mutes the flow of information between the
+server and the client. Default is FALSE.
    buffersize
    The size in bytes for the receive buffer. Default is
+16000 bytes or 16kb, which means it will use the libcurl's default value.
+According to the libcurl's documentation, the maximum buffersize is 512kb
+(or 512000 bytes), but any number passed to buffersize is treated
+as a request, not an order.
    timeout_ms
    Time in milliseconds (ms) to wait for the execution or
+re-execution of a command. Default is 0, which means that no timeout limit is
+set.
    ...
    Further curl parameters (see curl::curl_options) that
+can be used with the IMAP protocol. Only for advanced users.
    
+
+    
    Value
    
+
+    
    A new `ImapCon` object.
    
+
+    
    Examples
    
+    
    if (FALSE) {
+# w/ Plain authentication
+con <- configure_imap(
+  url="imaps://outlook.office365.com",
+  username="user@agency.gov.br",
+  password=rstudioapi::askForPassword(),
+  verbose = TRUE)
+
+# w/ OAuth2.0 authentication
+con <- configure_imap(
+  url="imaps://outlook.office365.com",
+  username="user@agency.gov.br",
+  verbose = TRUE,
+  xoauth2_bearer = "XX.Ya9...")
+}
+
    
+  
    
+  
+
    
 
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
    
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/decode_mime_header.html b/docs/reference/decode_mime_header.html
index d020301..63c2cb4 100644
--- a/docs/reference/decode_mime_header.html
+++ b/docs/reference/decode_mime_header.html
@@ -1,81 +1,167 @@
+
 
-Decode RFC 2047 quoted-printable and base64 MIME headers and strings — decode_mime_header • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
+
+Decode RFC 2047 quoted-printable and base64 MIME headers and strings — decode_mime_header • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-    
    
+
+      
+
+      
 
-    
-  
-
    
 
    
-  
    
-      
    Decode RFC 2047 quoted-printable and base64 MIME headers and strings
    
-      Source: R/decode-mime-header.R
-      
    decode_mime_header.Rd
    
+  
    
+    
    
+    
    Decode RFC 2047 quoted-printable and base64 MIME headers and strings
    
+    Source: R/decode-mime-header.R
+    
     
    
 
-    
    
+    
    
     
    Decode RFC 2047 quoted-printable and base64 MIME headers and strings
    
     
    
 
-    
    
-    
    Usage
    
-    
    decode_mime_header(string)
    
-    
    
+    
    decode_mime_header(string)
    
 
-    
    
-    
    Arguments
    
-    
    string
    
-
    A character vector containing a string to be decoded.
    
+    
    Arguments
    
+    
+    
+    
+      
+      
+    
+    
    string
    A character vector containing a string to be decoded.
    
 
-
    
-    
    
-    
    Value
    
-    
+    
    Value
    
+
+    
    A decoded character vector if applicable.
    
+    
    Note
    
 
-
    A decoded character vector if applicable.
    
-    
    
-    
    
-    
    Note
    
     
    The RFC 2047 (Moore, 1996) presents an encoded-word syntax to be used by e-mail
   clients to display body text and header information in character sets
   other than ASCII. According to the manual, non-ASCII content is encoded as
@@ -87,9 +173,8 @@ 
    Note
    
   syntax, i.e. cases where only the encoded text part is present, such as the
   quoted-printable pattern in the string "Estat=EDstica" (Estatística,
   which is the equivalent word, in Portuguese, for Statistics).
    
-    
    
-    
    
-    
    References
    
+    
    References
    
+
     
    Moore, K. (1996), MIME (Multipurpose Internet Mail Extensions) Part
   Three: Message Header Extensions for Non-ASCII
   Text, RFC 2047, November 1996, https://tools.ietf.org/html/rfc2047.
    
@@ -99,53 +184,58 @@ 
    References
-    
    Examples
    
-    
    if (FALSE) {
-# The examples below runs smoothly on any computer. The 'dontrun' flag is just to skip CRAN checks.
-
-# Simple quoted-printable string - Portuguese example
-qp_encoded <- "Minist=E9rio_da_Educa=E7=E3o"
-decoded_string <- decode_mime_header(string = qp_encoded)
-
-# Simple quoted-printable string - French example
-qp_encoded <- "sur la route =C3=A0 suivre les voil=C3=A0 bient=C3=B4t qui te d=C3=A9gradent"
-decoded_string <- decode_mime_header(string = qp_encoded)
-
-# RFC 2047 quoted-printable header - Portuguese example
-qp_encoded <- "=?iso-8859-1?Q?DIDEC_Capacita=E7=E3o?="
-decoded_string <- decode_mime_header(string = qp_encoded)
-
-# RFC 2047 quoted-printable - German example
-qp_encoded <- "=?UTF-8?Q?stern=2Ede_-_t=C3=A4glich?="
-decoded_string <- decode_mime_header(string = qp_encoded)
-
-# RFC 2047 base64 - Portuguese example
-b64_encoded <- "=?utf-8?B?Sk9BTkEgRlVTQ08gTE9CTyBubyBUZWFtcw==?="
-decoded_string <- decode_mime_header(string = b64_encoded)
-}
-
-
    
-    
    
-  
    
+    
    Examples
    
+    
    if (FALSE) {
+# The examples below runs smoothly on any computer. The 'dontrun' flag is just to skip CRAN checks.
+
+# Simple quoted-printable string - Portuguese example
+qp_encoded <- "Minist=E9rio_da_Educa=E7=E3o"
+decoded_string <- decode_mime_header(string = qp_encoded)
+
+# Simple quoted-printable string - French example
+qp_encoded <- "sur la route =C3=A0 suivre les voil=C3=A0 bient=C3=B4t qui te d=C3=A9gradent"
+decoded_string <- decode_mime_header(string = qp_encoded)
+
+# RFC 2047 quoted-printable header - Portuguese example
+qp_encoded <- "=?iso-8859-1?Q?DIDEC_Capacita=E7=E3o?="
+decoded_string <- decode_mime_header(string = qp_encoded)
+
+# RFC 2047 quoted-printable - German example
+qp_encoded <- "=?UTF-8?Q?stern=2Ede_-_t=C3=A4glich?="
+decoded_string <- decode_mime_header(string = qp_encoded)
+
+# RFC 2047 base64 - Portuguese example
+b64_encoded <- "=?utf-8?B?Sk9BTkEgRlVTQ08gTE9CTyBubyBUZWFtcw==?="
+decoded_string <- decode_mime_header(string = b64_encoded)
+}
+
+
    
+  
    
+  
+
 
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/flag.html b/docs/reference/flag.html
index 4378594..5736627 100644
--- a/docs/reference/flag.html
+++ b/docs/reference/flag.html
@@ -1,127 +1,221 @@
+
 
-Criterion constructor function to be combined in a custom search statement — flag • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
+
+Criterion constructor function to be combined in a custom search statement — flag • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-    
    
-
    
-  
    
-      
    Criterion constructor function to be combined in a custom search statement
    
-      Source: R/flag.R
-      
    flag.Rd
    
-    
    
+      
 
-    
    
-    
    Criterion constructor function to be combined in a custom search statement
    
-    
    
+      
 
-    
    
-    
    Usage
    
-    
    flag(name, negate = FALSE)
    
+
    
+  
    
+    
    
+    
    Criterion constructor function to be combined in a custom search statement
    
+    Source: R/flag.R
+    
     
    
 
-    
    
-    
    Arguments
    
-    
    name
    
-
    A string containing one or more flags to search for. Use
-ImapCon$list_flags() to list the flags
-in a selected mail folder.
    
-
-
-
    negate
    
-
    If TRUE, negates the search and seeks for "NOT SEARCH
-CRITERIA". Default is FALSE.
    
-
-
    
-    
    
-    
    See also
    
-    
    Other custom search: 
-AND(),
-ImapCon,
-OR(),
-before(),
-larger_than(),
-older_than(),
-on(),
-sent_before(),
-sent_on(),
-sent_since(),
-since(),
-smaller_than(),
-string(),
-younger_than()
    
+    
    
+    
    Criterion constructor function to be combined in a custom search statement
    
     
    
 
-    
    
-    
    Examples
    
-    
    if (FALSE) {
-# select folder & search
-con$select_folder(name = "INBOX")
-# search for messages with Flag "UNSEEN" AND NOT Smaller Than  512KB.
-res <- con$search(request = AND(flag("UNSEEN"),
-                                smaller_than(size = 512000, negate = TRUE)))
-}
-
    
-    
    
-  
    
+    
    flag(name, negate = FALSE)
    
+
+    
    Arguments
    
+    
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
    name
    A string containing one or more flags to search for. Use
+ImapCon$list_flags() to list the flags
+in a selected mail folder.
    negate
    If TRUE, negates the search and seeks for "NOT SEARCH
+CRITERIA". Default is FALSE.
    
+
+    
    See also
    
+
+    
    Other custom search: 
+AND(),
+ImapCon,
+OR(),
+before(),
+larger_than(),
+older_than(),
+on(),
+sent_before(),
+sent_on(),
+sent_since(),
+since(),
+smaller_than(),
+string(),
+younger_than()
    
+
+    
    Examples
    
+    
    if (FALSE) {
+# select folder & search
+con$select_folder(name = "INBOX")
+# search for messages with Flag "UNSEEN" AND NOT Smaller Than  512KB.
+res <- con$search(request = AND(flag("UNSEEN"),
+                                smaller_than(size = 512000, negate = TRUE)))
+}
+
    
+  
    
+  
+
 
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/index.html b/docs/reference/index.html
index a5568d4..8d04e16 100644
--- a/docs/reference/index.html
+++ b/docs/reference/index.html
@@ -1,189 +1,319 @@
+
 
-Function reference • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    Skip to contents
-    
+
 
-    
    
 
    
-  
    
-      
    Function reference
    
+  
    
+    
    
+      
    Reference
    
     
    
 
-    
    
-      
    All functions
    
-      
+    
+
+    +      +      +    
 
+    
+      
+        
+      
       
-    
    
       
+    
    
       
       
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+        
+        
+        
+      
+    
+    
    
       



    
+          
    All functions
    
+          
    
+        
    
+          
    AND() 
    
+        
    Relational-operator-function to construct a custom search statement
    
+          
    ImapCon 
    
+        
    An IMAP Connection Class
    
+          
    OR() 
    
+        
    Relational-operator-function to construct a custom search statement
    
+          
    before() 
    
+        
    Criterion constructor function to be combined in a custom search statement
    
+          
    clean_msg_text() 
    
+        
    Extract text from MIME level
    
+          
    configure_imap() 
    
+        
    IMAP Connection Configuration
    
+          
    decode_mime_header() 
    
+        
    Decode RFC 2047 quoted-printable and base64 MIME headers and strings
    
+          
    flag() 
    
+        
    Criterion constructor function to be combined in a custom search statement
    
+          
    larger_than() 
    
+        
    Criterion constructor function to be combined in a custom search statement
    
+          
    list_attachments() 
    
+        
    List attachments and content-disposition types
    
+          
    mRpostman-package 
    
+        
    An IMAP client for R
    
+          
    metadata_options() 
    
+        
    Message Metadata Options
    
+          
    older_than() 
    
+        
    Criterion constructor function to be combined in a custom search statement
    
+          
    on() 
    
+        
    Criterion constructor function to be combined in a custom search statement
    
+          
    sent_before() 
    
+        
    Criterion constructor function to be combined in a custom search statement
    
+          
    sent_on() 
    
+        
    Criterion constructor function to be combined in a custom search statement
    
+          
    sent_since() 
    
+        
    Criterion constructor function to be combined in a custom search statement
    
+          
    since() 
    
+        
    Criterion constructor function to be combined in a custom search statement
    
+          
    smaller_than() 
    
+        
    Criterion constructor function to be combined in a custom search statement
    
+          
    string() 
    
+        
    Criterion constructor function to be combined in a custom search statement
    
+          
    younger_than() 
    
+        
    Criterion constructor function to be combined in a custom search statement
    
+  
    
+
+  
+
    
+
 
-      
    
-          
-          AND() 
-        
    
-        
    Relational-operator-function to construct a custom search statement
    
-      
    
-          
-          ImapCon 
-        
    
-        
    An IMAP Connection Class
    
-      
    
-          
-          OR() 
-        
    
-        
    Relational-operator-function to construct a custom search statement
    
-      
    
-          
-          before() 
-        
    
-        
    Criterion constructor function to be combined in a custom search statement
    
-      
    
-          
-          clean_msg_text() 
-        
    
-        
    Extract text from MIME level
    
-      
    
-          
-          configure_imap() 
-        
    
-        
    IMAP Connection Configuration
    
-      
    
-          
-          decode_mime_header() 
-        
    
-        
    Decode RFC 2047 quoted-printable and base64 MIME headers and strings
    
-      
    
-          
-          flag() 
-        
    
-        
    Criterion constructor function to be combined in a custom search statement
    
-      
    
-          
-          larger_than() 
-        
    
-        
    Criterion constructor function to be combined in a custom search statement
    
-      
    
-          
-          list_attachments() 
-        
    
-        
    List attachments and content-disposition types
    
-      
    
-          
-          mRpostman-package mRpostman 
-        
    
-        
    An IMAP client for R
    
-      
    
-          
-          metadata_options() 
-        
    
-        
    Message Metadata Options
    
-      
    
-          
-          older_than() 
-        
    
-        
    Criterion constructor function to be combined in a custom search statement
    
-      
    
-          
-          on() 
-        
    
-        
    Criterion constructor function to be combined in a custom search statement
    
-      
    
-          
-          sent_before() 
-        
    
-        
    Criterion constructor function to be combined in a custom search statement
    
-      
    
-          
-          sent_on() 
-        
    
-        
    Criterion constructor function to be combined in a custom search statement
    
-      
    
-          
-          sent_since() 
-        
    
-        
    Criterion constructor function to be combined in a custom search statement
    
-      
    
-          
-          since() 
-        
    
-        
    Criterion constructor function to be combined in a custom search statement
    
-      
    
-          
-          smaller_than() 
-        
    
-        
    Criterion constructor function to be combined in a custom search statement
    
-      
    
-          
-          string() 
-        
    
-        
    Criterion constructor function to be combined in a custom search statement
    
-      
    
-          
-          younger_than() 
-        
    
-        
    Criterion constructor function to be combined in a custom search statement
    
-      
    
-  
    
-
-
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
    
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/larger_than.html b/docs/reference/larger_than.html
index 0ea6711..e407292 100644
--- a/docs/reference/larger_than.html
+++ b/docs/reference/larger_than.html
@@ -1,129 +1,223 @@
+
 
-Criterion constructor function to be combined in a custom search statement — larger_than • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
+
+Criterion constructor function to be combined in a custom search statement — larger_than • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-    
    
-
    
-  
    
-      
    Criterion constructor function to be combined in a custom search statement
    
-      Source: R/larger-than.R
-      
    larger_than.Rd
    
-    
    
+      
 
-    
    
-    
    Criterion constructor function to be combined in a custom search statement
    
-    
    
+      
 
-    
    
-    
    Usage
    
-    
    larger_than(size, negate = FALSE)
    
+
    
+  
    
+    
    
+    
    Criterion constructor function to be combined in a custom search statement
    
+    Source: R/larger-than.R
+    
     
    
 
-    
    
-    
    Arguments
    
-    
    size
    
-
    An integer specifying the number of seconds to be used as
-search criterion.
    
-
-
-
    negate
    
-
    If TRUE, negates the search and seeks for "NOT SEARCH
-CRITERIA". Default is FALSE.
    
-
-
    
-    
    
-    
    See also
    
-    
    Other custom search: 
-AND(),
-ImapCon,
-OR(),
-before(),
-flag(),
-older_than(),
-on(),
-sent_before(),
-sent_on(),
-sent_since(),
-since(),
-smaller_than(),
-string(),
-younger_than()
    
+    
    
+    
    Criterion constructor function to be combined in a custom search statement
    
     
    
 
-    
    
-    
    Examples
    
-    
    if (FALSE) {
-# select folder & search
-con$select_folder(name = "INBOX")
-# search for messages containing the string "XYZ@k-state.edu" in the
-#   "FROM" field OR those that are LARGER than 512KB.
-res <- con$search(request = OR(string(expr = "XYZ@k-state.edu",
-                                      where = "FROM"),
-                               larger_than(size = 512000)))
-}
-
-
    
-    
    
-  
    
+    
    larger_than(size, negate = FALSE)
    
+
+    
    Arguments
    
+    
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
    size
    An integer specifying the number of seconds to be used as
+search criterion.
    negate
    If TRUE, negates the search and seeks for "NOT SEARCH
+CRITERIA". Default is FALSE.
    
+
+    
    See also
    
+
+    
    Other custom search: 
+AND(),
+ImapCon,
+OR(),
+before(),
+flag(),
+older_than(),
+on(),
+sent_before(),
+sent_on(),
+sent_since(),
+since(),
+smaller_than(),
+string(),
+younger_than()
    
+
+    
    Examples
    
+    
    if (FALSE) {
+# select folder & search
+con$select_folder(name = "INBOX")
+# search for messages containing the string "XYZ@k-state.edu" in the
+#   "FROM" field OR those that are LARGER than 512KB.
+res <- con$search(request = OR(string(expr = "XYZ@k-state.edu",
+                                      where = "FROM"),
+                               larger_than(size = 512000)))
+}
+
+
    
+  
    
+  
+
 
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/list_attachments.html b/docs/reference/list_attachments.html
index 6b823ed..f43a3b6 100644
--- a/docs/reference/list_attachments.html
+++ b/docs/reference/list_attachments.html
@@ -1,127 +1,216 @@
+
 
-List attachments and content-disposition types — list_attachments • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
+
+List attachments and content-disposition types — list_attachments • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-    
    
 
    
-  
    
-      
    List attachments and content-disposition types
    
-      Source: R/list-attachments.R
-      
    list_attachments.Rd
    
+  
    
+    
    
+    
    List attachments and content-disposition types
    
+    Source: R/list-attachments.R
+    
     
    
 
-    
    
+    
    
     
    List attachments and content-disposition types
    
     
    
 
-    
    
-    
    Usage
    
-    
    list_attachments(msg_list)
    
-    
    
+    
    list_attachments(msg_list)
    
 
-    
    
-    
    Arguments
    
-    
    msg_list
    
-
    A list containing the messages (body or text) fetched
-from the server.
    
+    
    Arguments
    
+    
+    
+    
+      
+      
+    
+    
    msg_list
    A list containing the messages (body or text) fetched
+from the server.
    
 
-
    
-    
    
-    
    Value
    
-    
+    
    Value
    
+
+    
    A list of data.frames containing the filenames and its
+  Content-Disposition types for each fetched message.
    
+    
    Note
    
 
-
    A list of data.frames containing the filenames and its
    
-
    
-
    Content-Disposition types for each fetched message.
    
-    
    
-    
    
-    
    Note
    
     
    Please, note that this is an independent function and not an R6 method
   that depends on the connection object. Therefore, it should be called alone
   without the ImapCon object.
    
-    
    
-    
    
-    
    See also
    
-    
    Other attachments: 
-ImapCon
    
-    
    
-
-    
    
-    
    Examples
    
-    
    if (FALSE) {
-con$select_folder(name = "INBOX")
-# do a search followed by a fetch operation, then extract the attachments' list
-out <- con$search_string(expr = "@k-state.edu", where = "FROM") %>%
-  con$fetch_body()
-att_list <- list_attachments(msg_list = out)
-
-# or
-att_list <- con$search_string(expr = "@k-state.edu", where = "FROM") %>%
-  con$fetch_body() %>%
-  list_attachments()
-}
-
    
-    
    
-  
    
+    
    See also
    
+
+    
    Other attachments: 
+ImapCon
    
+
+    
    Examples
    
+    
    if (FALSE) {
+con$select_folder(name = "INBOX")
+# do a search followed by a fetch operation, then extract the attachments' list
+out <- con$search_string(expr = "@k-state.edu", where = "FROM") %>%
+  con$fetch_body()
+att_list <- list_attachments(msg_list = out)
+
+# or
+att_list <- con$search_string(expr = "@k-state.edu", where = "FROM") %>%
+  con$fetch_body() %>%
+  list_attachments()
+}
+
    
+  
    
+  
+
 
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/mRpostman-package.html b/docs/reference/mRpostman-package.html
index a61738d..dc6c98c 100644
--- a/docs/reference/mRpostman-package.html
+++ b/docs/reference/mRpostman-package.html
@@ -1,110 +1,206 @@
+
 
-An IMAP client for R — mRpostman-package • mRpostman
+  
+  
+
+
+
+An IMAP client for R — mRpostman-package • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    Skip to contents
-    
+    and several other IMAP features, paving the way for e-mail data analysis in R." />
+
 
-    
    
-
    
-  
    
-      
    An IMAP client for R
    
       
-      
    mRpostman-package.Rd
    
+
+      
+
+
    
+  
    
+    
    
+    
    An IMAP client for R
    
+    
+    
     
    
 
-    
    
+    
    
     
    mRpostman is an easy-to-use IMAP client that provides tools for message searching,
     selective fetching of message attributes, mailbox management, attachment extraction,
     and several other IMAP features, paving the way for e-mail data analysis in R.
    
     
    
 
 
-    
    
-    
    Author
    
+
+    
    Author
    
+
     
 
-
    Author & Mantainer: Allan Quadros allanvcq@gmail.com
    
-    
    
-    
    
-    
    References
    
+
    Author & Mantainer: Allan Quadros allanvcq@gmail.com
    
+    
    References
    
+
     
 
-
    Crispin, M. (2003), INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1, RFC 3501, March 2003, https://www.rfc-editor.org/rfc/rfc3501.
    
+
    Crispin, M. (2003), INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1, RFC 3501, March 2003, https://www.rfc-editor.org/rfc/rfc3501.
    
 
    Heinlein, P. and Hartleben, P. (2008). The Book of IMAP: Building a Mail Server with Courier and Cyrus. No Starch Press. ISBN 978-1-59327-177-0.
    
-
    Ooms, J. (2020). curl: A Modern and Flexible Web Client for R. R package version 4.3, https://CRAN.R-project.org/package=curl.
    
-
    Stenberg, D. Libcurl - The Multiprotocol File Transfer Library, https://curl.se/libcurl/.
    
-    
    
-    
    
-    
    See also
    
-    
    
+
    Ooms, J. (2020). curl: A Modern and Flexible Web Client for R. R package version 4.3, https://CRAN.R-project.org/package=curl.
    
+
    Stenberg, D. Libcurl - The Multiprotocol File Transfer Library, https://curl.se/libcurl/.
    
+    
    See also
    
+
+    
    
 
 
    Useful links:
    
-
    
-    
    
+
    
 
-  
    
+
    
 
+  
+  
+
 
-    
    
-  
    Developed by Allan Quadros.
    
+
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/metadata_options.html b/docs/reference/metadata_options.html
index 78b91da..6717147 100644
--- a/docs/reference/metadata_options.html
+++ b/docs/reference/metadata_options.html
@@ -1,113 +1,201 @@
+
 
-Message Metadata Options — metadata_options • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
+
+Message Metadata Options — metadata_options • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-    
    
 
    
-  
    
-      
    Message Metadata Options
    
-      Source: R/metadata-options.R
-      
    metadata_options.Rd
    
+  
    
+    
    
+    
    Message Metadata Options
    
+    Source: R/metadata-options.R
+    
     
    
 
-    
    
+    
    
     
    List Metadata fields used in messages.
    
     
    
 
-    
    
-    
    Usage
    
-    
    metadata_options()
    
-    
    
+    
    metadata_options()
    
 
-    
    
-    
    Value
    
-    
 
-
    A vector containing message metadata fields.
    
-    
    
-    
    
-    
    Note
    
+    
    Value
    
+
+    
    A vector containing message metadata fields.
    
+    
    Note
    
+
     
    This function lists message metadata used by
     IMAP servers, according to the RFC 2060 (Crispin, 1996).
    
-    
    
-    
    
-    
    References
    
+    
    References
    
+
     
    Crispin, M., "Internet Message Access Protocol - Version 4rev1",
-    RFC 2060, doi:10.17487/RFC2060
+    RFC 2060, doi:10.17487/RFC2060
 , December 1996,
-    https://www.rfc-editor.org/info/rfc2060.
    
-    
    
-
-    
    
-    
    Examples
    
-    
    if (FALSE) {
-
-library(mRpostman)
-metadata_options()
-
-}
-
    
-    
    
-  
    
+    https://www.rfc-editor.org/info/rfc2060.
    
+
+    
    Examples
    
+    
    if (FALSE) {
+
+library(mRpostman)
+metadata_options()
+
+}
+
    
+  
    
+  
+
 
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/older_than.html b/docs/reference/older_than.html
index 9e44165..661863b 100644
--- a/docs/reference/older_than.html
+++ b/docs/reference/older_than.html
@@ -1,134 +1,227 @@
+
 
-Criterion constructor function to be combined in a custom search statement — older_than • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
+
+Criterion constructor function to be combined in a custom search statement — older_than • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-    
    
 
    
-  
    
-      
    Criterion constructor function to be combined in a custom search statement
    
-      Source: R/older-than.R
-      
    older_than.Rd
    
+  
    
+    
    
+    
    Criterion constructor function to be combined in a custom search statement
    
+    Source: R/older-than.R
+    
     
    
 
-    
    
+    
    
     
    Criterion constructor function to be combined in a custom search statement
    
     
    
 
-    
    
-    
    Usage
    
-    
    older_than(seconds, negate = FALSE)
    
-    
    
-
-    
    
-    
    Arguments
    
-    
    seconds
    
-
    An integer specifying the number of seconds to be used as
-the search criterion.
    
+    
    older_than(seconds, negate = FALSE)
    
+
+    
    Arguments
    
+    
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
    seconds
    An integer specifying the number of seconds to be used as
+the search criterion.
    negate
    If TRUE, negates the search and seeks for "NOT SEARCH
+CRITERIA". Default is FALSE.
    
+
+    
    Note
    
 
-
-
    negate
    
-
    If TRUE, negates the search and seeks for "NOT SEARCH
-CRITERIA". Default is FALSE.
    
-
-
    
-    
    
-    
    Note
    
     
    To be able to use this functionality, the server must support the
   WITHIN capability.
    
-    
    
-    
    
-    
    See also
    
-    
    Other custom search: 
-AND(),
-ImapCon,
-OR(),
-before(),
-flag(),
-larger_than(),
-on(),
-sent_before(),
-sent_on(),
-sent_since(),
-since(),
-smaller_than(),
-string(),
-younger_than()
    
-    
    
-
-    
    
-    
    Examples
    
-    
    if (FALSE) {
-# select folder & search
-con$select_folder(name = "INBOX")
-# search for messages containing the string "XYZ@k-state.edu" in the
-#   "FROM" field AND those that are OLDER than 3600 seconds (1 hour).
-res <- con$search(request = AND(string(expr = "XYZ@k-state.edu",
-                                      where = "FROM"),
-                               older_than(seconds = 3600)))
-}
-
-
    
-    
    
-  
    
+    
    See also
    
+
+    
    Other custom search: 
+AND(),
+ImapCon,
+OR(),
+before(),
+flag(),
+larger_than(),
+on(),
+sent_before(),
+sent_on(),
+sent_since(),
+since(),
+smaller_than(),
+string(),
+younger_than()
    
+
+    
    Examples
    
+    
    if (FALSE) {
+# select folder & search
+con$select_folder(name = "INBOX")
+# search for messages containing the string "XYZ@k-state.edu" in the
+#   "FROM" field AND those that are OLDER than 3600 seconds (1 hour).
+res <- con$search(request = AND(string(expr = "XYZ@k-state.edu",
+                                      where = "FROM"),
+                               older_than(seconds = 3600)))
+}
+
+
    
+  
    
+  
+
 
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/on.html b/docs/reference/on.html
index b820c5f..63cf7c6 100644
--- a/docs/reference/on.html
+++ b/docs/reference/on.html
@@ -1,137 +1,227 @@
+
 
-Criterion constructor function to be combined in a custom search statement — on • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
+
+Criterion constructor function to be combined in a custom search statement — on • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-    
    
 
    
-  
    
-      
    Criterion constructor function to be combined in a custom search statement
    
-      Source: R/on.R
-      
    on.Rd
    
+  
    
+    
    
+    
    Criterion constructor function to be combined in a custom search statement
    
+    Source: R/on.R
+    
     
    
 
-    
    
+    
    
     
    Criterion constructor function to be combined in a custom search statement
    
     
    
 
-    
    
-    
    Usage
    
-    
    on(date_char, negate = FALSE)
    
-    
    
+    
    on(date_char, negate = FALSE)
    
 
-    
    
-    
    Arguments
    
-    
    date_char
    
-
    A character string with format "DD-Mon-YYYY", e.g.
+    
    Arguments
    
+    
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
    date_char
    A character string with format "DD-Mon-YYYY", e.g.
 "01-Apr-2019". We opt not to use Date or POSIX* like
-objects, since IMAP servers use this unusual date format.
    
-
-
-
    negate
    
-
    If TRUE, negates the search and seeks for "NOT SEARCH
-CRITERIA". Default is FALSE.
    
-
-
-    
    
-    
    Value
    
-    
-
-
    A search string to be used as a request parameter in
    
-
    
-
    ImapCon$search() function.
    
-    
    
-    
    
-    
    See also
    
-    
    Other custom search: 
-AND(),
-ImapCon,
-OR(),
-before(),
-flag(),
-larger_than(),
-older_than(),
-sent_before(),
-sent_on(),
-sent_since(),
-since(),
-smaller_than(),
-string(),
-younger_than()
    
-    
    
-
-    
    
-    
    Examples
    
-    
    if (FALSE) {
-# select folder & search
-con$select_folder(name = "INBOX")
-# search for messages SINCE "17-Apr-2019" AND SMALLER than 512KB.
-res <- con$search(request = OR(on(date_char = "30-Jun-2019"),
-                               on(date_char = "22-Mar-2018")))
-# search for messages received ON "30-Jun-2019" OR ON "22-Mar-2018".
-
-}
-
    
-    
    
-  
+objects, since IMAP servers use this unusual date format.
    negate
    If TRUE, negates the search and seeks for "NOT SEARCH
+CRITERIA". Default is FALSE.
    
+
+    
    Value
    
+
+    
    A search string to be used as a request parameter in
+ ImapCon$search() function.
    
+    
    See also
    
+
+    
    Other custom search: 
+AND(),
+ImapCon,
+OR(),
+before(),
+flag(),
+larger_than(),
+older_than(),
+sent_before(),
+sent_on(),
+sent_since(),
+since(),
+smaller_than(),
+string(),
+younger_than()
    
+
+    
    Examples
    
+    
    if (FALSE) {
+# select folder & search
+con$select_folder(name = "INBOX")
+# search for messages SINCE "17-Apr-2019" AND SMALLER than 512KB.
+res <- con$search(request = OR(on(date_char = "30-Jun-2019"),
+                               on(date_char = "22-Mar-2018")))
+# search for messages received ON "30-Jun-2019" OR ON "22-Mar-2018".
+
+}
+
    
+  
    
+  
+
    
 
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
    
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/pipe.html b/docs/reference/pipe.html
index 2037869..c331d89 100644
--- a/docs/reference/pipe.html
+++ b/docs/reference/pipe.html
@@ -1,80 +1,179 @@
+
 
-Common Pipe operator — %>% • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
+
+Common Pipe operator — %>% • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-    
    
+
+      
+
+      
 
-    
-  
    
-
    
 
    
-  
    
-      
    Common Pipe operator
    
-      Source: R/pipe.R
-      
    pipe.Rd
    
+  
    
+    
    
+    
    Common Pipe operator
    
+    Source: R/pipe.R
+    
     
    
 
-    
    
+    
    
     
    Common Pipe operator
    
     
    
 
 
 
-  
    
+
+  
    
+  
+
    
 
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/sent_before.html b/docs/reference/sent_before.html
index 278f5ab..4ba0b4c 100644
--- a/docs/reference/sent_before.html
+++ b/docs/reference/sent_before.html
@@ -1,135 +1,225 @@
+
 
-Criterion constructor function to be combined in a custom search statement — sent_before • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
+
+Criterion constructor function to be combined in a custom search statement — sent_before • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-    
    
 
    
-  
    
-      
    Criterion constructor function to be combined in a custom search statement
    
-      Source: R/sent-before.R
-      
    sent_before.Rd
    
+  
    
+    
    
+    
    Criterion constructor function to be combined in a custom search statement
    
+    Source: R/sent-before.R
+    
     
    
 
-    
    
+    
    
     
    Criterion constructor function to be combined in a custom search statement
    
     
    
 
-    
    
-    
    Usage
    
-    
    sent_before(date_char, negate = FALSE)
    
-    
    
+    
    sent_before(date_char, negate = FALSE)
    
 
-    
    
-    
    Arguments
    
-    
    date_char
    
-
    A character string with format "DD-Mon-YYYY", e.g.
+    
    Arguments
    
+    
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
    date_char
    A character string with format "DD-Mon-YYYY", e.g.
 "01-Apr-2019". We opt not to use Date or POSIX* like
-objects, since IMAP servers use this unusual date format.
    
-
-
-
    negate
    
-
    If TRUE, negates the search and seeks for "NOT SEARCH
-CRITERIA". Default is FALSE.
    
-
-
-    
    
-    
    Value
    
-    
-
-
    A search string to be used as a request parameter in
    
-
    
-
    ImapCon$search() function.
    
-    
    
-    
    
-    
    See also
    
-    
    Other custom search: 
-AND(),
-ImapCon,
-OR(),
-before(),
-flag(),
-larger_than(),
-older_than(),
-on(),
-sent_on(),
-sent_since(),
-since(),
-smaller_than(),
-string(),
-younger_than()
    
-    
    
-
-    
    
-    
    Examples
    
-    
    if (FALSE) {
-# select folder & search
-con$select_folder(name = "INBOX")
-# search for messages SINCE "30-Ago-2019" AND SMALLER than 512KB.
-res <- con$search(request = AND(sent_since(date_char = "30-Ago-2019"),
-                                smaller_than(size = 512000)))
-}
-
    
-    
    
-  
+objects, since IMAP servers use this unusual date format.
    negate
    If TRUE, negates the search and seeks for "NOT SEARCH
+CRITERIA". Default is FALSE.
    
+
+    
    Value
    
+
+    
    A search string to be used as a request parameter in
+ ImapCon$search() function.
    
+    
    See also
    
+
+    
    Other custom search: 
+AND(),
+ImapCon,
+OR(),
+before(),
+flag(),
+larger_than(),
+older_than(),
+on(),
+sent_on(),
+sent_since(),
+since(),
+smaller_than(),
+string(),
+younger_than()
    
+
+    
    Examples
    
+    
    if (FALSE) {
+# select folder & search
+con$select_folder(name = "INBOX")
+# search for messages SINCE "30-Ago-2019" AND SMALLER than 512KB.
+res <- con$search(request = AND(sent_since(date_char = "30-Ago-2019"),
+                                smaller_than(size = 512000)))
+}
+
    
+  
    
+  
+
    
 
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
    
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/sent_on.html b/docs/reference/sent_on.html
index eecd650..e3d44cc 100644
--- a/docs/reference/sent_on.html
+++ b/docs/reference/sent_on.html
@@ -1,135 +1,225 @@
+
 
-Criterion constructor function to be combined in a custom search statement — sent_on • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
+
+Criterion constructor function to be combined in a custom search statement — sent_on • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-    
    
+
+      
+
+      
 
-    
-  
    
-
    
 
    
-  
    
-      
    Criterion constructor function to be combined in a custom search statement
    
-      Source: R/sent-on.R
-      
    sent_on.Rd
    
+  
    
+    
    
+    
    Criterion constructor function to be combined in a custom search statement
    
+    Source: R/sent-on.R
+    
     
    
 
-    
    
+    
    
     
    Criterion constructor function to be combined in a custom search statement
    
     
    
 
-    
    
-    
    Usage
    
-    
    sent_on(date_char, negate = FALSE)
    
-    
    
+    
    sent_on(date_char, negate = FALSE)
    
 
-    
    
-    
    Arguments
    
-    
    date_char
    
-
    A character string with format "DD-Mon-YYYY", e.g.
+    
    Arguments
    
+    
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
    date_char
    A character string with format "DD-Mon-YYYY", e.g.
 "01-Apr-2019". We opt not to use Date or POSIX* like
-objects, since IMAP servers use this unusual date format.
    
-
-
-
    negate
    
-
    If TRUE, negates the search and seeks for "NOT SEARCH
-CRITERIA". Default is FALSE.
    
-
-
-    
    
-    
    Value
    
-    
-
-
    A search string to be used as a request parameter in
    
-
    
-
    ImapCon$search() function.
    
-    
    
-    
    
-    
    See also
    
-    
    Other custom search: 
-AND(),
-ImapCon,
-OR(),
-before(),
-flag(),
-larger_than(),
-older_than(),
-on(),
-sent_before(),
-sent_since(),
-since(),
-smaller_than(),
-string(),
-younger_than()
    
-    
    
-
-    
    
-    
    Examples
    
-    
    if (FALSE) {
-# select folder & search
-con$select_folder(name = "INBOX")
-# search for messages SINCE "30-Ago-2019" OR LARGER than 512KB.
-res <- con$search(request = OR(sent_since(date_char = "30-Jun-2020"),
-                               larger_than(size = 512000)))
-}
-
    
-    
    
-  
+objects, since IMAP servers use this unusual date format.
    negate
    If TRUE, negates the search and seeks for "NOT SEARCH
+CRITERIA". Default is FALSE.
    
+
+    
    Value
    
+
+    
    A search string to be used as a request parameter in
+ ImapCon$search() function.
    
+    
    See also
    
+
+    
    Other custom search: 
+AND(),
+ImapCon,
+OR(),
+before(),
+flag(),
+larger_than(),
+older_than(),
+on(),
+sent_before(),
+sent_since(),
+since(),
+smaller_than(),
+string(),
+younger_than()
    
+
+    
    Examples
    
+    
    if (FALSE) {
+# select folder & search
+con$select_folder(name = "INBOX")
+# search for messages SINCE "30-Ago-2019" OR LARGER than 512KB.
+res <- con$search(request = OR(sent_since(date_char = "30-Jun-2020"),
+                               larger_than(size = 512000)))
+}
+
    
+  
    
+  
+
    
 
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
    
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/sent_since.html b/docs/reference/sent_since.html
index 76675c8..c73b35d 100644
--- a/docs/reference/sent_since.html
+++ b/docs/reference/sent_since.html
@@ -1,137 +1,227 @@
+
 
-Criterion constructor function to be combined in a custom search statement — sent_since • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
+
+Criterion constructor function to be combined in a custom search statement — sent_since • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-    
    
+
+      
+
+      
 
-    
-  
    
-
    
 
    
-  
    
-      
    Criterion constructor function to be combined in a custom search statement
    
-      Source: R/sent-since.R
-      
    sent_since.Rd
    
+  
    
+    
    
+    
    Criterion constructor function to be combined in a custom search statement
    
+    Source: R/sent-since.R
+    
     
    
 
-    
    
+    
    
     
    Criterion constructor function to be combined in a custom search statement
    
     
    
 
-    
    
-    
    Usage
    
-    
    sent_since(date_char, negate = FALSE)
    
-    
    
+    
    sent_since(date_char, negate = FALSE)
    
 
-    
    
-    
    Arguments
    
-    
    date_char
    
-
    A character string with format "DD-Mon-YYYY", e.g.
+    
    Arguments
    
+    
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
    date_char
    A character string with format "DD-Mon-YYYY", e.g.
 "01-Apr-2019". We opt not to use Date or POSIX* like
-objects, since IMAP servers use this unusual date format.
    
-
-
-
    negate
    
-
    If TRUE, negates the search and seeks for "NOT SEARCH
-CRITERIA". Default is FALSE.
    
-
-
-    
    
-    
    Value
    
-    
-
-
    A search string to be used as a request parameter in
    
-
    
-
    ImapCon$search() function.
    
-    
    
-    
    
-    
    See also
    
-    
    Other custom search: 
-AND(),
-ImapCon,
-OR(),
-before(),
-flag(),
-larger_than(),
-older_than(),
-on(),
-sent_before(),
-sent_on(),
-since(),
-smaller_than(),
-string(),
-younger_than()
    
-    
    
-
-    
    
-    
    Examples
    
-    
    if (FALSE) {
-# select folder & search
-con$select_folder(name = "INBOX")
-# search for messages SENT SINCE "22-Mar-2020" OR containing the STRING
-#  "congratulations" in the subject.
-res <- con$search(request = AND(sent_since(date_char = "22-Mar-2020"),
-                                string(expr = "congratulations",
-                                       where = "SUBJECT")))
-}
-
    
-    
    
-  
+objects, since IMAP servers use this unusual date format.
    negate
    If TRUE, negates the search and seeks for "NOT SEARCH
+CRITERIA". Default is FALSE.
    
+
+    
    Value
    
+
+    
    A search string to be used as a request parameter in
+ ImapCon$search() function.
    
+    
    See also
    
+
+    
    Other custom search: 
+AND(),
+ImapCon,
+OR(),
+before(),
+flag(),
+larger_than(),
+older_than(),
+on(),
+sent_before(),
+sent_on(),
+since(),
+smaller_than(),
+string(),
+younger_than()
    
+
+    
    Examples
    
+    
    if (FALSE) {
+# select folder & search
+con$select_folder(name = "INBOX")
+# search for messages SENT SINCE "22-Mar-2020" OR containing the STRING
+#  "congratulations" in the subject.
+res <- con$search(request = AND(sent_since(date_char = "22-Mar-2020"),
+                                string(expr = "congratulations",
+                                       where = "SUBJECT")))
+}
+
    
+  
    
+  
+
    
 
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
    
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/since.html b/docs/reference/since.html
index a1179aa..5d9bbdb 100644
--- a/docs/reference/since.html
+++ b/docs/reference/since.html
@@ -1,135 +1,225 @@
+
 
-Criterion constructor function to be combined in a custom search statement — since • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
+
+Criterion constructor function to be combined in a custom search statement — since • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-    
    
+
+      
+
+      
 
-    
-  
    
-
    
 
    
-  
    
-      
    Criterion constructor function to be combined in a custom search statement
    
-      Source: R/since.R
-      
    since.Rd
    
+  
    
+    
    
+    
    Criterion constructor function to be combined in a custom search statement
    
+    Source: R/since.R
+    
     
    
 
-    
    
+    
    
     
    Criterion constructor function to be combined in a custom search statement
    
     
    
 
-    
    
-    
    Usage
    
-    
    since(date_char, negate = FALSE)
    
-    
    
+    
    since(date_char, negate = FALSE)
    
 
-    
    
-    
    Arguments
    
-    
    date_char
    
-
    A character string with format "DD-Mon-YYYY", e.g.
+    
    Arguments
    
+    
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
    date_char
    A character string with format "DD-Mon-YYYY", e.g.
 "01-Apr-2019". We opt not to use Date or POSIX* like
-objects, since IMAP servers use this unusual date format.
    
-
-
-
    negate
    
-
    If TRUE, negates the search and seeks for "NOT SEARCH
-CRITERIA". Default is FALSE.
    
-
-
-    
    
-    
    Value
    
-    
-
-
    A search string to be used as a request parameter in
    
-
    
-
    ImapCon$search() function.
    
-    
    
-    
    
-    
    See also
    
-    
    Other custom search: 
-AND(),
-ImapCon,
-OR(),
-before(),
-flag(),
-larger_than(),
-older_than(),
-on(),
-sent_before(),
-sent_on(),
-sent_since(),
-smaller_than(),
-string(),
-younger_than()
    
-    
    
-
-    
    
-    
    Examples
    
-    
    if (FALSE) {
-# select folder & search
-con$select_folder(name = "INBOX")
-# search for messages SINCE "17-Apr-2019" AND SMALLER than 512KB.
-res <- con$search(request = AND(since(date_char = "17-Apr-2019"),
-                                smaller_than(size = 512000)))
-}
-
    
-    
    
-  
+objects, since IMAP servers use this unusual date format.
    negate
    If TRUE, negates the search and seeks for "NOT SEARCH
+CRITERIA". Default is FALSE.
    
+
+    
    Value
    
+
+    
    A search string to be used as a request parameter in
+ ImapCon$search() function.
    
+    
    See also
    
+
+    
    Other custom search: 
+AND(),
+ImapCon,
+OR(),
+before(),
+flag(),
+larger_than(),
+older_than(),
+on(),
+sent_before(),
+sent_on(),
+sent_since(),
+smaller_than(),
+string(),
+younger_than()
    
+
+    
    Examples
    
+    
    if (FALSE) {
+# select folder & search
+con$select_folder(name = "INBOX")
+# search for messages SINCE "17-Apr-2019" AND SMALLER than 512KB.
+res <- con$search(request = AND(since(date_char = "17-Apr-2019"),
+                                smaller_than(size = 512000)))
+}
+
    
+  
    
+  
+
    
 
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
    
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/smaller_than.html b/docs/reference/smaller_than.html
index 0457cde..80ed195 100644
--- a/docs/reference/smaller_than.html
+++ b/docs/reference/smaller_than.html
@@ -1,129 +1,223 @@
+
 
-Criterion constructor function to be combined in a custom search statement — smaller_than • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
+
+Criterion constructor function to be combined in a custom search statement — smaller_than • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-    
    
 
-    
-  
    
-
    
-
    
-  
    
-      
    Criterion constructor function to be combined in a custom search statement
    
-      Source: R/smaller-than.R
-      
    smaller_than.Rd
    
-    
    
+      
 
-    
    
-    
    Criterion constructor function to be combined in a custom search statement
    
-    
    
+      
 
-    
    
-    
    Usage
    
-    
    smaller_than(size, negate = FALSE)
    
+
    
+  
    
+    
    
+    
    Criterion constructor function to be combined in a custom search statement
    
+    Source: R/smaller-than.R
+    
     
    
 
-    
    
-    
    Arguments
    
-    
    size
    
-
    An integer specifying the number of seconds to be used as
-search criterion.
    
-
-
-
    negate
    
-
    If TRUE, negates the search and seeks for "NOT SEARCH
-CRITERIA". Default is FALSE.
    
-
-
    
-    
    
-    
    See also
    
-    
    Other custom search: 
-AND(),
-ImapCon,
-OR(),
-before(),
-flag(),
-larger_than(),
-older_than(),
-on(),
-sent_before(),
-sent_on(),
-sent_since(),
-since(),
-string(),
-younger_than()
    
+    
    
+    
    Criterion constructor function to be combined in a custom search statement
    
     
    
 
-    
    
-    
    Examples
    
-    
    if (FALSE) {
-# select folder & search
-con$select_folder(name = "INBOX")
-# search for messages containing the string "XYZ@k-state.edu" in the
-# "FROM" field OR those that are SMALLER than 512KB.
-res <- con$search(request = OR(string(expr = "XYZ@k-state.edu",
-                                      where = "FROM"),
-                               smaller_than(size = 512000)))
-}
-
-
    
-    
    
-  
    
+    
    smaller_than(size, negate = FALSE)
    
+
+    
    Arguments
    
+    
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
    size
    An integer specifying the number of seconds to be used as
+search criterion.
    negate
    If TRUE, negates the search and seeks for "NOT SEARCH
+CRITERIA". Default is FALSE.
    
+
+    
    See also
    
+
+    
    Other custom search: 
+AND(),
+ImapCon,
+OR(),
+before(),
+flag(),
+larger_than(),
+older_than(),
+on(),
+sent_before(),
+sent_on(),
+sent_since(),
+since(),
+string(),
+younger_than()
    
+
+    
    Examples
    
+    
    if (FALSE) {
+# select folder & search
+con$select_folder(name = "INBOX")
+# search for messages containing the string "XYZ@k-state.edu" in the
+# "FROM" field OR those that are SMALLER than 512KB.
+res <- con$search(request = OR(string(expr = "XYZ@k-state.edu",
+                                      where = "FROM"),
+                               smaller_than(size = 512000)))
+}
+
+
    
+  
    
+  
+
    
 
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
    
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/string.html b/docs/reference/string.html
index 61038ed..9184623 100644
--- a/docs/reference/string.html
+++ b/docs/reference/string.html
@@ -1,135 +1,229 @@
+
 
-Criterion constructor function to be combined in a custom search statement — string • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
+
+Criterion constructor function to be combined in a custom search statement — string • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-    
    
 
-    
-  
    
-
    
-
    
-  
    
-      
    Criterion constructor function to be combined in a custom search statement
    
-      Source: R/string.R
-      
    string.Rd
    
-    
    
+      
 
-    
    
-    
    Criterion constructor function to be combined in a custom search statement
    
-    
    
+      
 
-    
    
-    
    Usage
    
-    
    string(expr, where, negate = FALSE)
    
+
    
+  
    
+    
    
+    
    Criterion constructor function to be combined in a custom search statement
    
+    Source: R/string.R
+    
     
    
 
-    
    
-    
    Arguments
    
-    
    expr
    
-
    A character string specifying the word or expression to search
-for in messages.
    
-
-
-
    where
    
-
    A mandatory character string specifying in which
-message's Section or Header Field to search for the provided string.
    
-
-
-
    negate
    
-
    If TRUE, negates the search and seeks for "NOT SEARCH
-CRITERIA". Default is FALSE.
    
-
-
    
-    
    
-    
    See also
    
-    
    Other custom search: 
-AND(),
-ImapCon,
-OR(),
-before(),
-flag(),
-larger_than(),
-older_than(),
-on(),
-sent_before(),
-sent_on(),
-sent_since(),
-since(),
-smaller_than(),
-younger_than()
    
+    
    
+    
    Criterion constructor function to be combined in a custom search statement
    
     
    
 
-    
    
-    
    Examples
    
-    
    if (FALSE) {
-# select folder & search
-con$select_folder(name = "INBOX")
-# search for messages containing the string "XYZ@k-state.edu" in the
-#   "FROM" AND the string "@gmail.com" in the "CC" field.
-res <- con$search(request = AND(string(expr = "XYZ@k-state.edu",
-                                      where = "FROM"),
-                               string(expr = "@gmail.com",
-                                      where = "CC")))
-}
-
-
    
-    
    
-  
    
+    
    string(expr, where, negate = FALSE)
    
+
+    
    Arguments
    
+    
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
    expr
    A character string specifying the word or expression to search
+for in messages.
    where
    A mandatory character string specifying in which
+message's Section or Header Field to search for the provided string.
    negate
    If TRUE, negates the search and seeks for "NOT SEARCH
+CRITERIA". Default is FALSE.
    
+
+    
    See also
    
+
+    
    Other custom search: 
+AND(),
+ImapCon,
+OR(),
+before(),
+flag(),
+larger_than(),
+older_than(),
+on(),
+sent_before(),
+sent_on(),
+sent_since(),
+since(),
+smaller_than(),
+younger_than()
    
+
+    
    Examples
    
+    
    if (FALSE) {
+# select folder & search
+con$select_folder(name = "INBOX")
+# search for messages containing the string "XYZ@k-state.edu" in the
+#   "FROM" AND the string "@gmail.com" in the "CC" field.
+res <- con$search(request = AND(string(expr = "XYZ@k-state.edu",
+                                      where = "FROM"),
+                               string(expr = "@gmail.com",
+                                      where = "CC")))
+}
+
+
    
+  
    
+  
+
 
 
-    
    
-  
    Developed by Allan Quadros.
    
+      
    
+      
    
+  
    Developed by Allan Quadros.
    
 
    
 
-
    
-  
    Site built with pkgdown 2.0.7.
    
+
    
+  
    Site built with pkgdown 1.6.1.
    
 
    
 
-    
    
+      
    
+   
 
   
 
-  
 
-  
+  
+
+
 
diff --git a/docs/reference/younger_than.html b/docs/reference/younger_than.html
index 95fded0..25d6717 100644
--- a/docs/reference/younger_than.html
+++ b/docs/reference/younger_than.html
@@ -1,134 +1,227 @@
+
 
-Criterion constructor function to be combined in a custom search statement — younger_than • mRpostman
-    Skip to contents
-    
+
+  
+  
+
+
+
+Criterion constructor function to be combined in a custom search statement — younger_than • mRpostman
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-    
    
 
    
-  
    
-      
    Criterion constructor function to be combined in a custom search statement
    
-      Source: R/younger-than.R
-      
    younger_than.Rd
    
+  
    
+    
    
+    
    Criterion constructor function to be combined in a custom search statement
    
+    Source: R/younger-than.R
+    
     
    
 
-    
    
+    
    
     
    Criterion constructor function to be combined in a custom search statement
    
     
    
 
-    
    
-    
    Usage
    
-    
    younger_than(seconds, negate = FALSE)
    
-    
    
-
-    
    
-    
    Arguments
    
-    
    seconds
    
-
    An integer specifying the number of seconds to be used as
-the search criterion.
    
+    
    younger_than(seconds, negate = FALSE)
    
+
+    
    Arguments
    
+    
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
    seconds
    An integer specifying the number of seconds to be used as
+the search criterion.
    negate
    If TRUE, negates the search and seeks for "NOT SEARCH
+CRITERIA". Default is FALSE.
    
+
+    
    Note
    
 
-
-
    negate
    
-
    If TRUE, negates the search and seeks for "NOT SEARCH
-CRITERIA". Default is FALSE.
    
-
-
    
-    
    
-    
    Note
    
     
    To be able to use this functionality, the server must support the
   WITHIN capability.
    
-    
    
-    
    
-    
    See also
    
-    
    Other custom search: 
-AND(),
-ImapCon,
-OR(),
-before(),
-flag(),
-larger_than(),
-older_than(),
-on(),
-sent_before(),
-sent_on(),
-sent_since(),
-since(),
-smaller_than(),
-string()
    
-    
    
-
-    
    
-    
    Examples
    
-    
    if (FALSE) {
-# select folder & search
-con$select_folder(name = "INBOX")
-# search for messages containing the string "XYZ@k-state.edu" in the
-#   "FROM" field AND those that are YOUNGER than 3600 seconds (1 hour).
-res <- con$search(request = AND(string(expr = "XYZ@k-state.edu",
-                                      where = "FROM"),
-                               younger_than(seconds = 3600)))
-}
-
-
    
-    
    
-  
    
+    
    See also
    
+
+    
    Other custom search: 
+AND(),
+ImapCon,
+OR(),
+before(),
+flag(),
+larger_than(),
+older_than(),
+on(),
+sent_before(),
+sent_on(),
+sent_since(),
+since(),
+smaller_than(),
+string()
    
+
+    
    Examples
    
+    
    if (FALSE) {
+# select folder & search
+con$select_folder(name = "INBOX")
+# search for messages containing the string "XYZ@k-state.edu" in the
+#   "FROM" field AND those that are YOUNGER than 3600 seconds (1 hour).
+res <- con$search(request = AND(string(expr = "XYZ@k-state.edu",
+                                      where = "FROM"),
+                               younger_than(seconds = 3600)))
+}
+
+
    
+  
    
+  
+
 
 
-    
+   
 
   
 
-  
 
-  
+  
+
+