Send Email
sesv2_send_email | R Documentation |
Sends an email message¶
Description¶
Sends an email message. You can use the Amazon SES API v2 to send the following types of messages:
-
Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon SES assembles the message for you.
-
Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.
-
Templated – A message that contains personalization tags. When you send this type of email, Amazon SES API v2 automatically replaces the tags with values that you specify.
Usage¶
sesv2_send_email(FromEmailAddress, FromEmailAddressIdentityArn,
Destination, ReplyToAddresses, FeedbackForwardingEmailAddress,
FeedbackForwardingEmailAddressIdentityArn, Content, EmailTags,
ConfigurationSetName, ListManagementOptions)
Arguments¶
FromEmailAddress
The email address to use as the "From" address for the email. The address that you specify has to be verified.
FromEmailAddressIdentityArn
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
FromEmailAddress
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 sender@example.com, then you would specify the
FromEmailAddressIdentityArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and theFromEmailAddress
to be sender@example.com.For more information about sending authorization, see the Amazon SES Developer Guide.
For Raw emails, the
FromEmailAddressIdentityArn
value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.Destination
An object that contains the recipients of the email message.
ReplyToAddresses
The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
FeedbackForwardingEmailAddress
The address that you want bounce and complaint notifications to be sent to.
FeedbackForwardingEmailAddressIdentityArn
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
FeedbackForwardingEmailAddress
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
FeedbackForwardingEmailAddressIdentityArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and theFeedbackForwardingEmailAddress
to be feedback@example.com.For more information about sending authorization, see the Amazon SES Developer Guide.
Content
[required] An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.
EmailTags
A list of tags, in the form of name/value pairs, to apply to an email that you send using the
send_email
operation. 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 sending the email.
ListManagementOptions
An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
Value¶
A list with the following syntax:
Request syntax¶
svc$send_email(
FromEmailAddress = "string",
FromEmailAddressIdentityArn = "string",
Destination = list(
ToAddresses = list(
"string"
),
CcAddresses = list(
"string"
),
BccAddresses = list(
"string"
)
),
ReplyToAddresses = list(
"string"
),
FeedbackForwardingEmailAddress = "string",
FeedbackForwardingEmailAddressIdentityArn = "string",
Content = list(
Simple = list(
Subject = list(
Data = "string",
Charset = "string"
),
Body = list(
Text = list(
Data = "string",
Charset = "string"
),
Html = list(
Data = "string",
Charset = "string"
)
),
Headers = list(
list(
Name = "string",
Value = "string"
)
)
),
Raw = list(
Data = raw
),
Template = list(
TemplateName = "string",
TemplateArn = "string",
TemplateData = "string",
Headers = list(
list(
Name = "string",
Value = "string"
)
)
)
),
EmailTags = list(
list(
Name = "string",
Value = "string"
)
),
ConfigurationSetName = "string",
ListManagementOptions = list(
ContactListName = "string",
TopicName = "string"
)
)