Class: Aws::SES::Types::SendEmailRequest

Inherits:

Struct

Object
Struct
Aws::SES::Types::SendEmailRequest

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-ses/types.rb

Overview

Note:

When making an API call, you may pass SendEmailRequest data as a 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].

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html

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`.

Returns:

(String)

# File 'lib/aws-sdk-ses/types.rb', line 4315

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end

#destination ⇒ `Types::Destination`

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

Returns:

(Types::Destination)

# File 'lib/aws-sdk-ses/types.rb', line 4315

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end

#message ⇒ `Types::Message`

The message to be sent.

Returns:

(Types::Message)

# File 'lib/aws-sdk-ses/types.rb', line 4315

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end

#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.

Returns:

(Array<String>)

# File 'lib/aws-sdk-ses/types.rb', line 4315

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end

#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.

Returns:

(String)

# File 'lib/aws-sdk-ses/types.rb', line 4315

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end

#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 `[email protected]`, then you would specify the `ReturnPathArn` to be `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the `ReturnPath` to be `[email protected]`.

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

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html

Returns:

(String)

# File 'lib/aws-sdk-ses/types.rb', line 4315

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end

#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].

<note markdown=“1”> Amazon SES does not support the SMTPUTF8 extension, as described in [RFC6531]. For this reason, the *local part* of a source email address (the part of the email address that precedes the @ sign) may only contain [7-bit ASCII characters]. If the *domain part* of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in [RFC3492]. The sender name (also known as the *friendly name*) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in [RFC 2047]. MIME encoded-word syntax uses the following form: ‘=?charset?encoding?encoded-text?=`.

</note>

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html [2]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html [3]: tools.ietf.org/html/rfc6531 [4]: en.wikipedia.org/wiki/Email_address#Local-part [5]: tools.ietf.org/html/rfc3492.html [6]: tools.ietf.org/html/rfc2047

Returns:

(String)

# File 'lib/aws-sdk-ses/types.rb', line 4315

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end

#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 `[email protected]`, then you would specify the `SourceArn` to be `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the `Source` to be `[email protected]`.

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

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html

Returns:

(String)

# File 'lib/aws-sdk-ses/types.rb', line 4315

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end

#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.

Returns:

(Array<Types::MessageTag>)

# File 'lib/aws-sdk-ses/types.rb', line 4315

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  include Aws::Structure
end

Class: Aws::SES::Types::SendEmailRequest

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_set_name ⇒ String

#destination ⇒ Types::Destination

#message ⇒ Types::Message

#reply_to_addresses ⇒ Array<String>

#return_path ⇒ String

#return_path_arn ⇒ String

#source ⇒ String

#source_arn ⇒ String

#tags ⇒ Array<Types::MessageTag>

#configuration_set_name ⇒ `String`

#destination ⇒ `Types::Destination`

#message ⇒ `Types::Message`

#reply_to_addresses ⇒ `Array<String>`

#return_path ⇒ `String`

#return_path_arn ⇒ `String`

#source ⇒ `String`

#source_arn ⇒ `String`

#tags ⇒ `Array<Types::MessageTag>`