Method: Aws::SES::Client#send_raw_email

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

#send_raw_email(params = {}) ⇒ `Types::SendRawEmailResponse`

Composes an email message and immediately queues it for sending.

This operation is more flexible than the ‘SendEmail` API operation. When you use the `SendRawEmail` operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you want to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments.

The ‘SendRawEmail` operation has the following requirements:

You can only send email from [verified email addresses or domains]. If you try to send email from an address that isn’t verified, the operation results in an “Email address not verified” error.
If your account is still in the [Amazon SES sandbox], you can only send email to other verified addresses in your account, or to addresses that are associated with the [Amazon SES mailbox simulator].
The maximum message size, including attachments, is 10 MB.
Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines.
If you send a single message to more than one recipient address, and one of the recipient addresses isn’t in a valid format (that is, it’s not in the format *UserName@Domain.TopLevelDomain*), Amazon SES rejects the entire message, even if the other addresses are valid.
Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group.
Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn’t preserved. For this reason, we highly recommend that you encode all content that isn’t 7-bit ASCII. For more information, see [MIME Encoding] in the *Amazon SES Developer Guide*.

Additionally, keep the following considerations in mind when using the ‘SendRawEmail` operation:

Although you can customize the message headers when using the ‘SendRawEmail` operation, Amazon SES will automatically apply its own `Message-ID` and `Date` headers; if you passed these headers when creating the message, they will be overwritten by the values that Amazon SES provides.
If you are using sending authorization to send on behalf of another user, ‘SendRawEmail` enables you to specify the cross-account identity for the email’s Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters ‘SourceArn`, `FromArn`, and/or `ReturnPathArn` to the API, or you can include the following X-headers in the header of your raw email:
- ‘X-SES-SOURCE-ARN`
- ‘X-SES-FROM-ARN`
- ‘X-SES-RETURN-PATH-ARN`
Do not include these X-headers in the DKIM signature; Amazon SES will remove them before sending the email.

For most common sending authorization scenarios, we recommend that you specify the ‘SourceIdentityArn` parameter and not the `FromIdentityArn` or `ReturnPathIdentityArn` parameters. If you only specify the `SourceIdentityArn` parameter, Amazon SES will set the From and Return Path addresses to the identity specified in `SourceIdentityArn`. For more information about sending authorization, see the [Using Sending Authorization with Amazon SES] in the *Amazon SES Developer Guide.*
For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your *sending quota*). For more information about sending quotas in Amazon SES, see [Managing Your Amazon SES Sending Limits] in the *Amazon SES Developer Guide.*

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html [2]: docs.aws.amazon.com/ses/latest/DeveloperGuide/request-production-access.html [3]: docs.aws.amazon.com/ses/latest/DeveloperGuide/mailbox-simulator.html [4]: docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html#send-email-mime-encoding [5]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html [6]: docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html

Examples:

Example: SendRawEmail


# The following example sends an email with an attachment:

resp = client.send_raw_email({
  destinations: [
  ], 
  from_arn: "", 
  raw_message: {
    data: "From: [email protected]\\nTo: [email protected]\\nSubject: Test email (contains an attachment)\\nMIME-Version: 1.0\\nContent-type: Multipart/Mixed; boundary=\"NextPart\"\\n\\n--NextPart\\nContent-Type: text/plain\\n\\nThis is the message body.\\n\\n--NextPart\\nContent-Type: text/plain;\\nContent-Disposition: attachment; filename=\"attachment.txt\"\\n\\nThis is the text in the attachment.\\n\\n--NextPart--", 
  }, 
  return_path_arn: "", 
  source: "", 
  source_arn: "", 
})

resp.to_h outputs the following:
{
  message_id: "EXAMPLEf3f73d99b-c63fb06f-d263-41f8-a0fb-d0dc67d56c07-000000", 
}

Request syntax with placeholder values


resp = client.send_raw_email({
  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",
})

Response structure


resp.message_id #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

: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
:destinations (Array<String>) —

A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
:raw_message (required, 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/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
: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
: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
: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
: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.
:configuration_set_name (String) —

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

Returns:

(Types::SendRawEmailResponse) —
Returns a response object which responds to the following methods:
- #message_id => String