Send Email

ses_send_email

R Documentation

Composes an email message and immediately queues it for sending¶

Description¶

Composes an email message and immediately queues it for sending. To send email using this operation, your message must meet the following requirements:

The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation results in an "Email address not verified" error.
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
The maximum message size is 10 MB.
The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.
The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the send_email operation several times to send the message to each group.

For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.

Usage¶

ses_send_email(Source, Destination, Message, ReplyToAddresses,
  ReturnPath, SourceArn, ReturnPathArn, Tags, ConfigurationSetName)

Arguments¶

Source

[required] The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

Destination

[required] The destination for this email, composed of To:, CC:, and BCC: fields.

Message

[required] The message to be sent.

ReplyToAddresses

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.

ReturnPath

The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

SourceArn

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

ReturnPathArn

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Tags

A list of tags, in the form of name/value pairs, to apply to an email that you send using send_email. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

ConfigurationSetName

The name of the configuration set to use when you send an email using send_email.

Value¶

A list with the following syntax:

list(
  MessageId = "string"
)

Request syntax¶

svc$send_email(
  Source = "string",
  Destination = list(
    ToAddresses = list(
      "string"
    ),
    CcAddresses = list(
      "string"
    ),
    BccAddresses = list(
      "string"
    )
  ),
  Message = list(
    Subject = list(
      Data = "string",
      Charset = "string"
    ),
    Body = list(
      Text = list(
        Data = "string",
        Charset = "string"
      ),
      Html = list(
        Data = "string",
        Charset = "string"
      )
    )
  ),
  ReplyToAddresses = list(
    "string"
  ),
  ReturnPath = "string",
  SourceArn = "string",
  ReturnPathArn = "string",
  Tags = list(
    list(
      Name = "string",
      Value = "string"
    )
  ),
  ConfigurationSetName = "string"
)

Examples¶

## Not run: 
# The following example sends a formatted email:
svc$send_email(
  Destination = list(
    BccAddresses = list(),
    CcAddresses = list(
      "recipient3@example.com"
    ),
    ToAddresses = list(
      "recipient1@example.com",
      "recipient2@example.com"
    )
  ),
  Message = list(
    Body = list(
      Html = list(
        Charset = "UTF-8",
        Data = "This message body contains HTML formatting. It can, for exa..."
      ),
      Text = list(
        Charset = "UTF-8",
        Data = "This is the message body in text format."
      )
    ),
    Subject = list(
      Charset = "UTF-8",
      Data = "Test email"
    )
  ),
  ReplyToAddresses = list(),
  ReturnPath = "",
  ReturnPathArn = "",
  Source = "sender@example.com",
  SourceArn = ""
)

## End(Not run)