blastula (version 0.2.1)

create_email_creds_file: Create a file with email access credentials

Description

Create a file with access credentials for the purpose of automatically emailing notification messages.

Usage

create_email_creds_file(user, password, provider = NULL, host = NULL,
  port = NULL, sender = NULL, use_ssl = TRUE, use_tls = FALSE,
  authenticate = TRUE, creds_file_name = NULL)

Arguments

user

the username for the email account.

password

the password associated with the email account.

provider

an optional provider email provider with which an STMP account is available. Options currently include gmail, outlook, and office365. If nothing is provided then values for host, port, sender, use_ssl, use_tls, and authenticate are expected.

host

the host name.

port

the port number.

sender

the sender name.

use_ssl

an option as to whether to use SSL; supply a TRUE or FALSE value (TRUE is the default value).

use_tls

a logical value to indicate whether to use TLS; supply a TRUE or FALSE value (FALSE is the default value).

authenticate

an option as to whether to authenticate; supply a TRUE or FALSE value (TRUE is the default value).

creds_file_name

an option to specify a name for the credentials file. If no name is provided, one will be automatically generated. The autogenerated file will be invisible and have its name constructed in the following way: .bls_<host_name>.

Examples

# NOT RUN {
# Create a credentials file to facilitate
# the sending of email messages
create_email_creds_file(
  user = "[e-mail]",
  password = "************",
  provider = "gmail")
# }