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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb

Overview

Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 are 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 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4182

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

#destination ⇒ Types::Destination

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

Returns:

• (Types::Destination)

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

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

#message ⇒ Types::Message

The message to be sent.

Returns:

• (Types::Message)

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

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  SENSITIVE = []
  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 receives the reply.

Returns:

• (Array<String>)

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

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

#return_path ⇒ String

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.

Returns:

• (String)

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

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  SENSITIVE = []
  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 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.

Returns:

• (String)

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

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  SENSITIVE = []
  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.

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.

Returns:

• (String)

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

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  SENSITIVE = []
  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 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.

Returns:

• (String)

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

class SendEmailRequest < Struct.new(
  :source,
  :destination,
  :message,
  :reply_to_addresses,
  :return_path,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  SENSITIVE = []
  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 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 4182

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