mRpostman (version 0.3.1)

fetch_msg_metadata: Fetch Message Metadata

Description

Fetch Metadata of one or more messages.

Usage

fetch_msg_metadata(imapconf, msg_id, by = "MSN", metadata,
  write_to_disk = FALSE, keep_in_mem = TRUE, retries = 2)

Arguments

imapconf

An object of class imapconf generated with configure_imap and with a mbox item added after a mailbox selection with select_mailbox.

msg_id

A numeric vetor containing one or more messages ids.

by

Which id (MSN or UID) to use when searching for messages. "MSN" or message squence number is a message's relative position to the older message in the mailbox. It may change after deleting or moving messages. For instance, if a message is deleted, message sequence numbers are reordered to fill the gap. "UID" or unique identifier is always the same during the life cycle of a message. Default is "MSN".

metadata

A character vector or string specifying one or more items of the metadata of a message to fetch. See metadata_options.

write_to_disk

If TRUE writes fetch content of each message to the disk as a text file in the working directory. Default is FALSE.

keep_in_mem

If TRUE keeps a copy of fetch results as an list in the R session when write_to_disk = TRUE. Default is FALSE. It can only be set TRUE when write_to_disk = TRUE.

retries

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

Value

A list or/and text files containing the fetch results.

See Also

Other fetch: fetch_full_msg, fetch_msg_header, fetch_msg_text

Examples

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

# fetching
results <- imapconf %>%
    select_mailbox(mbox = "INBOX") %>%
    search_sent_since(date_char = "26-Aug-2008") %$% #exposition pipe - two argg
    fetch_msg_metadata(imapconf, msg_id = msg_id, by = "UID",
                     metadata = c("INTERNALDATE", "UID", "ENVELOPE", "FLAGS",
                                 "RFC822.SIZE", "BODYSTRUCTURE"))

# }
# NOT RUN {
# }