Class: Aws::SESV2::Types::SendEmailRequest

Inherits:

Struct

Object
Struct
Aws::SESV2::Types::SendEmailRequest

show all

Includes:: Aws::Structure

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

Overview

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#configuration_set_name ⇒ String

The name of the configuration set to use when sending the email.
#content ⇒ Types::EmailContent

An object that contains the body of the message.
#destination ⇒ Types::Destination

An object that contains the recipients of the email message.
#email_tags ⇒ Array<Types::MessageTag>

A list of tags, in the form of name/value pairs, to apply to an email that you send using the ‘SendEmail` operation.
#feedback_forwarding_email_address ⇒ String

The address that you want bounce and complaint notifications to be sent to.
#feedback_forwarding_email_address_identity_arn ⇒ String

This parameter is used only for sending authorization.
#from_email_address ⇒ String

The email address to use as the “From” address for the email.
#from_email_address_identity_arn ⇒ String

This parameter is used only for sending authorization.
#list_management_options ⇒ Types::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.
#reply_to_addresses ⇒ Array<String>

The “Reply-to” email addresses for the message.

Instance Attribute Details

#configuration_set_name ⇒ `String`

The name of the configuration set to use when sending the email.

Returns:

(String)

# File 'lib/aws-sdk-sesv2/types.rb', line 6543

class SendEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :destination,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :content,
  :email_tags,
  :configuration_set_name,
  :list_management_options)
  SENSITIVE = []
  include Aws::Structure
end

#content ⇒ `Types::EmailContent`

An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.

Returns:

(Types::EmailContent)

# File 'lib/aws-sdk-sesv2/types.rb', line 6543

class SendEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :destination,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :content,
  :email_tags,
  :configuration_set_name,
  :list_management_options)
  SENSITIVE = []
  include Aws::Structure
end

#destination ⇒ `Types::Destination`

An object that contains the recipients of the email message.

Returns:

(Types::Destination)

# File 'lib/aws-sdk-sesv2/types.rb', line 6543

class SendEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :destination,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :content,
  :email_tags,
  :configuration_set_name,
  :list_management_options)
  SENSITIVE = []
  include Aws::Structure
end

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

A list of tags, in the form of name/value pairs, to apply to an email that you send using the ‘SendEmail` operation. 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-sesv2/types.rb', line 6543

class SendEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :destination,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :content,
  :email_tags,
  :configuration_set_name,
  :list_management_options)
  SENSITIVE = []
  include Aws::Structure
end

#feedback_forwarding_email_address ⇒ `String`

The address that you want bounce and complaint notifications to be sent to.

Returns:

(String)

# File 'lib/aws-sdk-sesv2/types.rb', line 6543

class SendEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :destination,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :content,
  :email_tags,
  :configuration_set_name,
  :list_management_options)
  SENSITIVE = []
  include Aws::Structure
end

#feedback_forwarding_email_address_identity_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 ‘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 [email protected], then you would specify the ‘FeedbackForwardingEmailAddressIdentityArn` to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the `FeedbackForwardingEmailAddress` 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-sesv2/types.rb', line 6543

class SendEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :destination,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :content,
  :email_tags,
  :configuration_set_name,
  :list_management_options)
  SENSITIVE = []
  include Aws::Structure
end

#from_email_address ⇒ `String`

The email address to use as the “From” address for the email. The address that you specify has to be verified.

Returns:

(String)

# File 'lib/aws-sdk-sesv2/types.rb', line 6543

class SendEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :destination,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :content,
  :email_tags,
  :configuration_set_name,
  :list_management_options)
  SENSITIVE = []
  include Aws::Structure
end

#from_email_address_identity_arn ⇒ `String`

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 ‘FromEmailAddressIdentityArn` to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the `FromEmailAddress` to be [email protected].

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.

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

Returns:

(String)

# File 'lib/aws-sdk-sesv2/types.rb', line 6543

class SendEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :destination,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :content,
  :email_tags,
  :configuration_set_name,
  :list_management_options)
  SENSITIVE = []
  include Aws::Structure
end

#list_management_options ⇒ `Types::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.

Returns:

(Types::ListManagementOptions)

# File 'lib/aws-sdk-sesv2/types.rb', line 6543

class SendEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :destination,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :content,
  :email_tags,
  :configuration_set_name,
  :list_management_options)
  SENSITIVE = []
  include Aws::Structure
end

#reply_to_addresses ⇒ `Array<String>`

The “Reply-to” email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Returns:

(Array<String>)

# File 'lib/aws-sdk-sesv2/types.rb', line 6543

class SendEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :destination,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :content,
  :email_tags,
  :configuration_set_name,
  :list_management_options)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::SESV2::Types::SendEmailRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_set_name ⇒ String

#content ⇒ Types::EmailContent

#destination ⇒ Types::Destination

#email_tags ⇒ Array<Types::MessageTag>

#feedback_forwarding_email_address ⇒ String

#feedback_forwarding_email_address_identity_arn ⇒ String

#from_email_address ⇒ String

#from_email_address_identity_arn ⇒ String

#list_management_options ⇒ Types::ListManagementOptions

#reply_to_addresses ⇒ Array<String>

#configuration_set_name ⇒ `String`

#content ⇒ `Types::EmailContent`

#destination ⇒ `Types::Destination`

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

#feedback_forwarding_email_address ⇒ `String`

#feedback_forwarding_email_address_identity_arn ⇒ `String`

#from_email_address ⇒ `String`

#from_email_address_identity_arn ⇒ `String`

#list_management_options ⇒ `Types::ListManagementOptions`

#reply_to_addresses ⇒ `Array<String>`