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

Inherits:
Struct
  • Object
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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_set_name ⇒ String

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

Returns:

  • (String) 


4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
 
# File 'lib/aws-sdk-ses/types.rb', line 4532

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


4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
 
# File 'lib/aws-sdk-ses/types.rb', line 4532

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) 


4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
 
# File 'lib/aws-sdk-ses/types.rb', line 4532

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 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 &lt;CRLF&gt;, must not exceed 1,000 characters.

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

Returns:



4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
 
# File 'lib/aws-sdk-ses/types.rb', line 4532

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) 


4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
 
# File 'lib/aws-sdk-ses/types.rb', line 4532

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

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

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.

[1]: tools.ietf.org/html/rfc6531 [2]: en.wikipedia.org/wiki/Email_address#Local-part [3]: tools.ietf.org/html/rfc3492.html [4]: tools.ietf.org/html/rfc2047

Returns:

  • (String) 


4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
 
# File 'lib/aws-sdk-ses/types.rb', line 4532

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) 


4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
 
# File 'lib/aws-sdk-ses/types.rb', line 4532

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:



4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
 
# File 'lib/aws-sdk-ses/types.rb', line 4532

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