configure_imap: IMAP Connection Configuration
In mRpostman: An IMAP Client for R

configure_imap

R Documentation

IMAP Connection Configuration

Description

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.

Examples

## Not run: 
# 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...")

## End(Not run)

mRpostman documentation built on Sept. 17, 2024, 5:09 p.m.