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

Note:

When making an API call, you may pass SendRawEmailRequest data as a hash:

{
  source: "Address",
  destinations: ["Address"],
  raw_message: { # required
    data: "data", # required
  },
  from_arn: "AmazonResourceName",
  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 raw email using Amazon SES. For more information, see the [Amazon SES Developer Guide].

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

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 text of the message.
#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 3584

class SendRawEmailRequest < Struct.new(
  :source,
  :destinations,
  :raw_message,
  :from_arn,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  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 3584

class SendRawEmailRequest < Struct.new(
  :source,
  :destinations,
  :raw_message,
  :from_arn,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  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/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html

Returns:

(String)

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

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

#raw_message ⇒ `Types::RawMessage`

The raw text of the message. The client is responsible for ensuring the following:

Message must contain a header and a body, separated by a blank line.
All required header fields must be present.
Each part of a multipart MIME message must be formatted properly.
MIME content types must be among those supported by Amazon SES. For more information, go to the [Amazon SES Developer Guide].
Must be base64-encoded.
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/DeveloperGuide/mime-types.html [2]: tools.ietf.org/html/rfc5321#section-4.5.3.1.6

Returns:

(Types::RawMessage)

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

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

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/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html

Returns:

(String)

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

class SendRawEmailRequest < Struct.new(
  :source,
  :destinations,
  :raw_message,
  :from_arn,
  :source_arn,
  :return_path_arn,
  :tags,
  :configuration_set_name)
  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.)

By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: ‘=?charset?encoding?encoded-text?=`. For more information, see [RFC 2047].

<note markdown=“1”> If you specify the ‘Source` parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.

</note>

[1]: tools.ietf.org/html/rfc2047

Returns:

(String)

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

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

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/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html

Returns:

(String)

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

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

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

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

Overview

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