mRpostman (version 0.3.1)

larger_than: Criteria Helper Functions for Custom Search

Description

Criteria helper functions to be combined inside a operator helper function as a custom request in custom_search.

Usage

larger_than(size, negate = FALSE)

Arguments

size

An integer specifying the size (in number of characters) of message to be used as search criterion.

negate

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

Value

A search string to be used as a custom_request parameter in custom_search function.

See Also

Other customsearch helper functions: AND, OR, before, flag, older_than, on, sent_before, sent_on, sent_since, since, smaller_than, string, younger_than

Examples

# NOT RUN {
# }
# NOT RUN {
# configure IMAP
library(mRpostman)
imapconf <- configure_imap(url="imaps://your.imap.server.com",
                           username="your_username",
                           password=rstudioapi::askForPassword()
                          )

# search
result <- imapconf %>%
    select_mailbox(mbox = "INBOX") %>%
    custom_search(custom_request =
                 OR(string(
                       section_or_field = "from", string = "[e-mail]"),
                    larger_than(
                       size = 512000)
                   )
                 )
# searches for messages containing the string "[e-mail]" in the
# field "FROM" OR those Larger Than 512KB.

# }
# NOT RUN {
# }