Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Sends an email message, with header and content specified by the client.
The SendRawEmail
action is useful for sending multipart MIME emails.
The raw text of the message must comply with Internet email standards;
otherwise, the message cannot be sent.
There are several important points to know about SendRawEmail
:
- You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide.
- The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.
- Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.
- The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list counts towards the 50-recipient limit.
- For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide.
- 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 parametersSourceArn
,FromArn
, and/orReturnPathArn
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, because they are removed by Amazon SES before sending the email. For the most common sending authorization use case, we recommend that you specify the
SourceIdentityArn
and do not specify either theFromIdentityArn
orReturnPathIdentityArn
. (The same note applies to the corresponding X-headers.) If you only specify theSourceIdentityArn
, Amazon SES will simply set the "From" address and the "Return Path" address to the identity specified inSourceIdentityArn
. For more information about sending authorization, see the Amazon SES Developer Guide.
See: AWS API Reference for SendRawEmail.
- sendRawEmail :: RawMessage -> SendRawEmail
- data SendRawEmail
- sreSourceARN :: Lens' SendRawEmail (Maybe Text)
- sreDestinations :: Lens' SendRawEmail [Text]
- sreReturnPathARN :: Lens' SendRawEmail (Maybe Text)
- sreSource :: Lens' SendRawEmail (Maybe Text)
- sreFromARN :: Lens' SendRawEmail (Maybe Text)
- sreRawMessage :: Lens' SendRawEmail RawMessage
- sendRawEmailResponse :: Int -> Text -> SendRawEmailResponse
- data SendRawEmailResponse
- srersResponseStatus :: Lens' SendRawEmailResponse Int
- srersMessageId :: Lens' SendRawEmailResponse Text
Creating a Request
Creates a value of SendRawEmail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data SendRawEmail Source
Represents a request instructing the service to send a raw email message.
This datatype can be used in application code to compose a message
consisting of source, destination, and raw message text. This object can
then be sent using the SendRawEmail
action.
See: sendRawEmail
smart constructor.
Request Lenses
sreSourceARN :: Lens' SendRawEmail (Maybe Text) Source
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.
For information about when to use this parameter, see the description of
SendRawEmail
in this guide, or see the
Amazon SES Developer Guide.
sreDestinations :: Lens' SendRawEmail [Text] Source
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
sreReturnPathARN :: Lens' SendRawEmail (Maybe Text) Source
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.
For information about when to use this parameter, see the description of
SendRawEmail
in this guide, or see the
Amazon SES Developer Guide.
sreSource :: Lens' SendRawEmail (Maybe Text) Source
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.
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.
sreFromARN :: Lens' SendRawEmail (Maybe Text) Source
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.
For information about when to use this parameter, see the description of
SendRawEmail
in this guide, or see the
Amazon SES Developer Guide.
sreRawMessage :: Lens' SendRawEmail RawMessage Source
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.
- Content must be base64-encoded, if MIME requires it.
Destructuring the Response
Creates a value of SendRawEmailResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data SendRawEmailResponse Source
Represents a unique message ID returned from a successful SendRawEmail
request.
See: sendRawEmailResponse
smart constructor.
Response Lenses
srersResponseStatus :: Lens' SendRawEmailResponse Int Source
The response status code.
srersMessageId :: Lens' SendRawEmailResponse Text Source
The unique message identifier returned from the SendRawEmail
action.