send_email: Send Email

Description Usage Arguments Value

View source: R/send_email.R

Description

Uses COM dispatch to communicate with MS Outlook and send an email.

Usage

1
2
send_email(to, cc = NULL, subject, body, body_html = FALSE,
  attachments = NULL, display_only = FALSE)

Arguments

to

character, vector of email addresses which will be receiving the email. Each element must contain the @ symbol, with one or more characters on either side.

cc

character (optional), vector of email addresses which will be carbon-copied (CCed) on the email. If provided, each element must contain the @ symbol, with one or more characters on either side.

subject

character, the subject line for the email. If this has length > 1, an error will be returned.

body

character, the body of the email. If a vector of length > 1 is provided, the elements will be treated as lines of the email, and will be combined using paste0(..., collapse = "\r\n").

body_html

logical, does the argument to body contain HTML code that should control how the email is rendered? Default is FALSE.

attachments

character (optional), paths to files that are to be attached. If any of these files does not exist, an error will be returned.

display_only

logical, should the email be displayed only (and not sent)? Default is FALSE, which sends the email without displaying it first.

Value

NULL (invisibly)


aecoleman/extrospectr documentation built on Nov. 1, 2019, 8:59 p.m.