You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SES::Types::SendEmailRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SES::Types::SendEmailRequest
- Defined in:
- (unknown)
Overview
When passing SendEmailRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
source: "Address", # required
destination: { # required
to_addresses: ["Address"],
cc_addresses: ["Address"],
bcc_addresses: ["Address"],
},
message: { # required
subject: { # required
data: "MessageData", # required
charset: "Charset",
},
body: { # required
text: {
data: "MessageData", # required
charset: "Charset",
},
html: {
data: "MessageData", # required
charset: "Charset",
},
},
},
reply_to_addresses: ["Address"],
return_path: "Address",
source_arn: "AmazonResourceName",
return_path_arn: "AmazonResourceName",
tags: [
{
name: "MessageTagName", # required
value: "MessageTagValue", # required
},
],
configuration_set_name: "ConfigurationSetName",
}
Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.
Instance Attribute Summary collapse
-
#configuration_set_name ⇒ String
The name of the configuration set to use when you send an email using
SendEmail
. -
#destination ⇒ Types::Destination
The destination for this email, composed of To:, CC:, and BCC: fields.
-
#message ⇒ Types::Message
The message to be sent.
-
#reply_to_addresses ⇒ Array<String>
The reply-to email address(es) for the message.
-
#return_path ⇒ String
The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.
-
#return_path_arn ⇒ String
This parameter is used only for sending authorization.
-
#source ⇒ String
The email address that is sending the email.
-
#source_arn ⇒ String
This parameter is used only for sending authorization.
-
#tags ⇒ Array<Types::MessageTag>
A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendEmail
.
Instance Attribute Details
#configuration_set_name ⇒ String
The name of the configuration set to use when you send an email using
SendEmail
.
#destination ⇒ Types::Destination
The destination for this email, composed of To:, CC:, and BCC: fields.
#message ⇒ Types::Message
The message to be sent.
#reply_to_addresses ⇒ Array<String>
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
#return_path ⇒ String
The email address that bounces and complaints will be forwarded to when
feedback forwarding is enabled. If the message cannot be delivered to
the recipient, then an error message will be returned from the
recipient\'s ISP; this message will then be 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.
#return_path_arn ⇒ String
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.
#source ⇒ String
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.
=?charset?encoding?encoded-text?=
.
#source_arn ⇒ String
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.
#tags ⇒ Array<Types::MessageTag>
A list of tags, in the form of name/value pairs, to apply to an email
that you send using SendEmail
. Tags correspond to characteristics of
the email that you define, so that you can publish email sending events.