Class: Aws::SES::Types::SendRawEmailRequest

Inherits:

Struct

Object
Struct
Aws::SES::Types::SendRawEmailRequest

show all

Includes:: Aws::Structure

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

Overview

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

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#configuration_set_name ⇒ String

The name of the configuration set to use when you send an email using ‘SendRawEmail`.
#destinations ⇒ Array<String>

A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
#from_arn ⇒ String

This parameter is used only for sending authorization.
#raw_message ⇒ Types::RawMessage

The raw email message itself.
#return_path_arn ⇒ String

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

The identity’s email address.
#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 ‘SendRawEmail`.

Instance Attribute Details

#configuration_set_name ⇒ `String`

The name of the configuration set to use when you send an email using ‘SendRawEmail`.

Returns:

(String)

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

class SendRawEmailRequest < Struct.new(
  :source,
  :destinations,
  :raw_message,
  :from_arn,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  SENSITIVE = []
  include Aws::Structure
end

#destinations ⇒ `Array<String>`

A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.

Returns:

(Array<String>)

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

class SendRawEmailRequest < Struct.new(
  :source,
  :destinations,
  :raw_message,
  :from_arn,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  SENSITIVE = []
  include Aws::Structure
end

#from_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 specify a particular “From” address in the header of the raw email.

Instead of using this parameter, you can use the X-header ‘X-SES-FROM-ARN` in the raw message of the email. If you use both the `FromArn` parameter and the corresponding X-header, Amazon SES uses the value of the `FromArn` parameter.

<note markdown=“1”> For information about when to use this parameter, see the description of ‘SendRawEmail` in this guide, or see the [Amazon SES Developer Guide].

</note>

[1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html

Returns:

(String)

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

class SendRawEmailRequest < Struct.new(
  :source,
  :destinations,
  :raw_message,
  :from_arn,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  SENSITIVE = []
  include Aws::Structure
end

#raw_message ⇒ `Types::RawMessage`

The raw email message itself. The message has to meet the following criteria:

The message has to contain a header and a body, separated by a blank line.
All of the required header fields must be present in the message.
Each part of a multipart MIME message must be formatted properly.
Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see [Unsupported Attachment Types] in the *Amazon SES Developer Guide*.
The entire message must be base64-encoded.
If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see [Sending Raw Email] in the *Amazon SES Developer Guide*.
Per [RFC 5321], the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.

[1]: docs.aws.amazon.com/ses/latest/dg/mime-types.html [2]: docs.aws.amazon.com/ses/latest/dg/send-email-raw.html [3]: tools.ietf.org/html/rfc5321#section-4.5.3.1.6

Returns:

(Types::RawMessage)

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

class SendRawEmailRequest < Struct.new(
  :source,
  :destinations,
  :raw_message,
  :from_arn,
  :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`.

Instead of using this parameter, you can use the X-header ‘X-SES-RETURN-PATH-ARN` in the raw message of the email. If you use both the `ReturnPathArn` parameter and the corresponding X-header, Amazon SES uses the value of the `ReturnPathArn` parameter.

<note markdown=“1”> For information about when to use this parameter, see the description of ‘SendRawEmail` in this guide, or see the [Amazon SES Developer Guide].

</note>

[1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html

Returns:

(String)

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

class SendRawEmailRequest < Struct.new(
  :source,
  :destinations,
  :raw_message,
  :from_arn,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ `String`

The identity’s email address. If you do not provide a value for this parameter, you must specify a “From” address in the raw text of the message. (You can also specify both.)

<note markdown=“1”> Amazon SES does not support the SMTPUTF8 extension, as described in[1]. 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].

</note>

If you specify the ‘Source` parameter and have feedback forwarding enabled, then bounces and complaints are sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.

[1]: tools.ietf.org/html/rfc6531 [2]: docs.aws.amazon.com/ses/latest/dg/send-email-raw.html [3]: tools.ietf.org/html/rfc3492

Returns:

(String)

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

class SendRawEmailRequest < Struct.new(
  :source,
  :destinations,
  :raw_message,
  :from_arn,
  :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`.

Instead of using this parameter, you can use the X-header ‘X-SES-SOURCE-ARN` in the raw message of the email. If you use both the `SourceArn` parameter and the corresponding X-header, Amazon SES uses the value of the `SourceArn` parameter.

<note markdown=“1”> For information about when to use this parameter, see the description of ‘SendRawEmail` in this guide, or see the [Amazon SES Developer Guide].

</note>

[1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html

Returns:

(String)

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

class SendRawEmailRequest < Struct.new(
  :source,
  :destinations,
  :raw_message,
  :from_arn,
  :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 ‘SendRawEmail`. 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 4332

class SendRawEmailRequest < Struct.new(
  :source,
  :destinations,
  :raw_message,
  :from_arn,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::SES::Types::SendRawEmailRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_set_name ⇒ String

#destinations ⇒ Array<String>

#from_arn ⇒ String

#raw_message ⇒ Types::RawMessage

#return_path_arn ⇒ String

#source ⇒ String

#source_arn ⇒ String

#tags ⇒ Array<Types::MessageTag>

#configuration_set_name ⇒ `String`

#destinations ⇒ `Array<String>`

#from_arn ⇒ `String`

#raw_message ⇒ `Types::RawMessage`

#return_path_arn ⇒ `String`

#source ⇒ `String`

#source_arn ⇒ `String`

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