mRpostman (version 0.3.1)

flag: 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

flag(flag, negate = FALSE)

Arguments

flag

A string specifying the flag to be used for filtering messages. Use flag_options to list the flags available in your IMAP server.

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, larger_than, 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 = AND(flag("UNSEEN"),
                                       smaller_than(size = 512000),
                                       negate = TRUE))
# searches for messages with Flag "UNSEEN" AND NOT Smaller Than  512KB.

# }
# NOT RUN {
# }