libZSservicesZSamazonka-sesZSamazonka-ses
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SES.SendRawEmail

Description

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@[SubDomain.]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

    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.

  • 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.
Synopsis

Creating a Request

data SendRawEmail Source #

Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer Guide.

See: newSendRawEmail smart constructor.

Constructors

SendRawEmail' 

Fields

  • configurationSetName :: Maybe Text

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

  • sourceArn :: Maybe Text

    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.

  • destinations :: Maybe [Text]

    A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.

  • returnPathArn :: Maybe Text

    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.

  • source :: Maybe Text

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

    Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. 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.

  • fromArn :: Maybe Text

    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.

  • tags :: Maybe [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.

  • rawMessage :: 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.

Instances

Instances details
Eq SendRawEmail Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

Methods

(==) :: SendRawEmail -> SendRawEmail -> Bool #

(/=) :: SendRawEmail -> SendRawEmail -> Bool #

Read SendRawEmail Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

Methods

readsPrec :: Int -> ReadS SendRawEmail #

readList :: ReadS [SendRawEmail] #

readPrec :: ReadPrec SendRawEmail #

readListPrec :: ReadPrec [SendRawEmail] #

Show SendRawEmail Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

Methods

showsPrec :: Int -> SendRawEmail -> ShowS #

show :: SendRawEmail -> String #

showList :: [SendRawEmail] -> ShowS #

Generic SendRawEmail Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

Associated Types

type Rep SendRawEmail :: Type -> Type #

Methods

from :: SendRawEmail -> Rep SendRawEmail x #

to :: Rep SendRawEmail x -> SendRawEmail #

NFData SendRawEmail Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

Methods

rnf :: SendRawEmail -> () #

Hashable SendRawEmail Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

Methods

hashWithSalt :: Int -> SendRawEmail -> Int #

hash :: SendRawEmail -> Int #

AWSRequest SendRawEmail Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

Associated Types

type AWSResponse SendRawEmail #

Methods

request :: SendRawEmail -> Request SendRawEmail #

response :: MonadResource m => Logger -> Service -> Proxy SendRawEmail -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendRawEmail))) #

ToHeaders SendRawEmail Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

Methods

toHeaders :: SendRawEmail -> [Header] #

ToPath SendRawEmail Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

Methods

toPath :: SendRawEmail -> ByteString #

ToQuery SendRawEmail Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

Methods

toQuery :: SendRawEmail -> QueryString #

type Rep SendRawEmail Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

type Rep SendRawEmail = D1 ('MetaData "SendRawEmail" "Amazonka.SES.SendRawEmail" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "SendRawEmail'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "configurationSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "destinations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "returnPathArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fromArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MessageTag])) :*: S1 ('MetaSel ('Just "rawMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RawMessage)))))
type AWSResponse SendRawEmail Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

type AWSResponse SendRawEmail = SendRawEmailResponse

newSendRawEmail Source #

Arguments

:: RawMessage

$sel:rawMessage:SendRawEmail'

-> SendRawEmail 

Create a value of SendRawEmail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:configurationSetName:SendRawEmail', sendRawEmail_configurationSetName - The name of the configuration set to use when you send an email using SendRawEmail.

$sel:sourceArn:SendRawEmail', sendRawEmail_sourceArn - 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.

$sel:destinations:SendRawEmail', sendRawEmail_destinations - A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.

$sel:returnPathArn:SendRawEmail', sendRawEmail_returnPathArn - 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.

$sel:source:SendRawEmail', sendRawEmail_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.)

Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. 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.

$sel:fromArn:SendRawEmail', sendRawEmail_fromArn - 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.

$sel:tags:SendRawEmail', sendRawEmail_tags - 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.

$sel:rawMessage:SendRawEmail', sendRawEmail_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.

Request Lenses

sendRawEmail_configurationSetName :: Lens' SendRawEmail (Maybe Text) Source #

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

sendRawEmail_sourceArn :: 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.

sendRawEmail_destinations :: Lens' SendRawEmail (Maybe [Text]) Source #

A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.

sendRawEmail_returnPathArn :: 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.

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

Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. 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.

sendRawEmail_fromArn :: 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.

sendRawEmail_tags :: Lens' SendRawEmail (Maybe [MessageTag]) Source #

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.

sendRawEmail_rawMessage :: Lens' SendRawEmail RawMessage Source #

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.

Destructuring the Response

data SendRawEmailResponse Source #

Represents a unique message ID.

See: newSendRawEmailResponse smart constructor.

Constructors

SendRawEmailResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • messageId :: Text

    The unique message identifier returned from the SendRawEmail action.

Instances

Instances details
Eq SendRawEmailResponse Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

Methods

(==) :: SendRawEmailResponse -> SendRawEmailResponse -> Bool #

(/=) :: SendRawEmailResponse -> SendRawEmailResponse -> Bool #

Read SendRawEmailResponse Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

Methods

readsPrec :: Int -> ReadS SendRawEmailResponse #

readList :: ReadS [SendRawEmailResponse] #

readPrec :: ReadPrec SendRawEmailResponse #

readListPrec :: ReadPrec [SendRawEmailResponse] #

Show SendRawEmailResponse Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

Methods

showsPrec :: Int -> SendRawEmailResponse -> ShowS #

show :: SendRawEmailResponse -> String #

showList :: [SendRawEmailResponse] -> ShowS #

Generic SendRawEmailResponse Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

Associated Types

type Rep SendRawEmailResponse :: Type -> Type #

Methods

from :: SendRawEmailResponse -> Rep SendRawEmailResponse x #

to :: Rep SendRawEmailResponse x -> SendRawEmailResponse #

NFData SendRawEmailResponse Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

Methods

rnf :: SendRawEmailResponse -> () #

type Rep SendRawEmailResponse Source # 
Instance details

Defined in Amazonka.SES.SendRawEmail

type Rep SendRawEmailResponse = D1 ('MetaData "SendRawEmailResponse" "Amazonka.SES.SendRawEmail" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "SendRawEmailResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "messageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSendRawEmailResponse Source #

Arguments

:: Int

$sel:httpStatus:SendRawEmailResponse'

-> Text

$sel:messageId:SendRawEmailResponse'

-> SendRawEmailResponse 

Create a value of SendRawEmailResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:SendRawEmailResponse', sendRawEmailResponse_httpStatus - The response's http status code.

$sel:messageId:SendRawEmailResponse', sendRawEmailResponse_messageId - The unique message identifier returned from the SendRawEmail action.

Response Lenses

sendRawEmailResponse_httpStatus :: Lens' SendRawEmailResponse Int Source #

The response's http status code.

sendRawEmailResponse_messageId :: Lens' SendRawEmailResponse Text Source #

The unique message identifier returned from the SendRawEmail action.