mRpostman (version 0.3.1)

list_mailboxes: Listing Mailboxes

Description

List Mailboxes from IMAP server.

Usage

list_mailboxes(imapconf, retries = 2)

Arguments

imapconf

An object of class imapconf generated with configure_imap.

retries

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

Value

A list containing the Mailboxes (root and children).

See Also

Other mailbox commands: examine_mailbox, list_server_capabilities, rename_mailbox, select_mailbox

Examples

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

# list mailboxes
results <- imapconf %>%
  list_mailboxes()

# }