send_raw_email
(**kwargs)¶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:
Additionally, keep the following considerations in mind when using the SendRawEmail
operation:
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.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
Warning
Don't include these X-headers in the DKIM signature. Amazon SES removes these before it sends the email.
If you only specify the SourceIdentityArn
parameter, Amazon SES sets the From and Return-Path addresses to the same identity that you specified.
For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide.
See also: AWS API Documentation
Request Syntax
response = client.send_raw_email(
Source='string',
Destinations=[
'string',
],
RawMessage={
'Data': b'bytes'
},
FromArn='string',
SourceArn='string',
ReturnPathArn='string',
Tags=[
{
'Name': 'string',
'Value': 'string'
},
],
ConfigurationSetName='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
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. 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?=
.
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.
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
[REQUIRED]
The raw email message itself. The message has to meet the following criteria:
The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding.
The To:, CC:, and BCC: headers in the raw message can contain a group list.
If you are using SendRawEmail
with sending authorization, you can include X-headers in the raw message to specify the "Source," "From," and "Return-Path" addresses. For more information, see the documentation for SendRawEmail
.
Warning
Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.
For more information, go to the Amazon SES Developer Guide.
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
For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.
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
For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.
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
For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.
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.
Contains the name and value of a tag that you can provide to SendEmail
or SendRawEmail
to apply to an email.
Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
The name of the tag. The name must:
The value of the tag. The value must:
SendRawEmail
.dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
Represents a unique message ID.
MessageId (string) --
The unique message identifier returned from the SendRawEmail
action.
Exceptions
SES.Client.exceptions.MessageRejected
SES.Client.exceptions.MailFromDomainNotVerifiedException
SES.Client.exceptions.ConfigurationSetDoesNotExistException
SES.Client.exceptions.ConfigurationSetSendingPausedException
SES.Client.exceptions.AccountSendingPausedException
Examples
The following example sends an email with an attachment:
response = client.send_raw_email(
Destinations=[
],
FromArn='',
RawMessage={
'Data': 'From: sender@example.com\nTo: recipient@example.com\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--',
},
ReturnPathArn='',
Source='',
SourceArn='',
)
print(response)
Expected Output:
{
'MessageId': 'EXAMPLEf3f73d99b-c63fb06f-d263-41f8-a0fb-d0dc67d56c07-000000',
'ResponseMetadata': {
'...': '...',
},
}