server {emayili} | R Documentation |
Create an object which can be used to send messages to an SMTP server.
server(
host,
port = 25,
username = NULL,
password = NULL,
insecure = FALSE,
reuse = TRUE,
helo = NA,
protocol = NA,
test = FALSE,
pause_base = 1,
max_times = 5,
...
)
gmail(username, password, ...)
sendgrid(password, ...)
mailgun(username, password, ...)
sendinblue(username, password, ...)
mailersend(username, password, ...)
mailfence(username, password, ...)
zeptomail(password, ...)
smtpbucket(...)
host |
DNS name or IP address of the SMTP server. |
port |
Port that the SMTP server is listening on. |
username |
Username for SMTP server. |
password |
Password for SMTP server or API key. |
insecure |
Whether to ignore SSL issues. |
reuse |
Whether the connection to the SMTP server should be left open for reuse. |
helo |
The HELO domain name of the sending host. If left as |
protocol |
Which protocol (SMTP or SMTPS) to use for communicating with the server. Default will choose appropriate protocol based on port. |
test |
Test login to server. |
pause_base |
Base delay (in seconds) for exponential backoff. See rate_backoff. |
max_times |
Maximum number of times to retry. |
... |
Additional curl options. See |
These functions return a function which can then be called with a message object.
A function which is used to send messages to the server.
If you're having trouble authenticating with Gmail then you should try the following:
enable 2-factor authentication and
create an app password.
Then use the app password rather than your usual account password.
To use SendGrid you'll need to first create an API key. # nolint Then use the API key as the password.
SendGrid will accept messages on ports 25, 587 and 2525 (using SMTP) as well as 465 (using SMTPS).
To use Mailgun you'll need to first register a sender domain. This will then be assigned a username and password.
Mailgun will accept messages on ports 25 and 587 (using SMTP) as well as 465 (using SMTPS).
To use Sendinblue you'll need to first create an account. You'll find your SMTP username and password in the SMTP & API section of your account settings.
To use MailerSend you'll need to first create an account. You'll find your SMTP username and password under Domains. See How to send emails via SMTP with MailerSend.
Although this is not likely to be a problem in practice, MailerSend insists that all messages have at minimum a valid subject and either text or HTML content.
To use Mailfence you'll need to create a premium account.
SMTP Bucket is a fake SMTP server that captures all the messages it receives and makes them available through a website or REST API.
SMTP Bucket is a fake SMTP server that captures all the messages it receives and makes them available through a website or REST API.
# Set parameters for SMTP server (with username and password).
smtp <- server(
host = "smtp.gmail.com",
port = 587,
username = "bob@gmail.com",
password = "bd40ef6d4a9413de9c1318a65cbae5d7"
)
# Set parameters for a (fake) testing SMTP server.
#
# More information about this service can be found at https://www.smtpbucket.com/.
#
smtp <- server(
host = "mail.smtpbucket.com",
port = 8025
)
# Create a message
msg <- envelope() %>%
from("bob@gmail.com") %>%
to("alice@yahoo.com")
# Send message (verbose output from interactions with server)
## Not run:
smtp(msg, verbose = TRUE)
## End(Not run)
# To confirm that the message was sent, go to https://www.smtpbucket.com/ then:
#
# - fill in "bob@gmail.com" for the Sender field and
# - fill in "alice@yahoo.com" for the Recipient field then
# - press the Search button.
# With explicit HELO domain.
#
smtp <- server(
host = "mail.example.com",
helo = "client.example.com"
)
# Set parameters for Gmail SMTP server. The host and port are implicit.
smtp <- gmail(
username = "bob@gmail.com",
password = "bd40ef6d4a9413de9c1318a65cbae5d7"
)
# Set API key for SendGrid SMTP server.
smtp <- sendgrid(
password = "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"
)
# Set username and password for Mailgun SMTP server.
smtp <- mailgun(
username = "postmaster@sandbox9ptce35fdf0b31338dec4284eb7aaa59.mailgun.org",
password = "44d072e7g2b5f3bf23b2b642da0fe3a7-2ac825a1-a5be680a"
)
# Set username and password for Sendinblue SMTP server.
smtp <- sendinblue(
username = "bob@gmail.com",
password = "xsmtpsib-c75cf91323adc53a1747c005447cbc9a893c35888635bb7bef1a624bf773da33"
)
# Set username and password for MailerSend SMTP server.
smtp <- mailersend(
username = "NS_Pf3ALM@gmail.com",
password = "e5ATWLlTnWWDaKeE"
)
# Set username and password for Mailfence SMTP server.
smtp <- mailfence(
username = "bob",
password = "F!Uosd6xbhSjd%63"
)
# Set password for ZeptoMail SMTP server.
# nolint start
smtp <- zeptomail("yA6KbHsL4l2mmI8Ns0/fs9iSTj8yG0dYBgfIG0j6Fsv4P2uV32xh8ciEYNYlRkgCC7wRfkgWA==")
# nolint end
# SMTP Bucket server.
smtp <- smtpbucket()