Network.AWS.SES.SendRawEmail

Composes an email message and immediately queues it for sending. When calling this operation, you may specify the message headers as well as the content. The SendRawEmail operation is particularly useful for sending multipart MIME emails (such as those that contain both a plain-text and an HTML version).

In order to send email using the SendRawEmail operation, your message must meet the following requirements:

• The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation will result in an "Email address not verified" error.
• If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
• The total size of the message, including attachments, must be smaller than 10 MB.
• The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain ), the entire message will be rejected, even if the message contains other recipients that are valid.
• The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. 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 the SendRawEmail operation several times to send the message to each group.

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

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

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

Creating a Request

sendRawEmail

Arguments

:: RawMessage

sreRawMessage

-> SendRawEmail

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:

• sreConfigurationSetName - The name of the configuration set to use when you send an email using SendRawEmail .
• sreSourceARN - 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 userexample.com , then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , and the Source to be userexample.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.
• sreDestinations - A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
• sreReturnPathARN - 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 feedbackexample.com , then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , and the ReturnPath to be feedbackexample.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.
• sreSource - 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 .
• sreFromARN - 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.
• sreTags - 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.
• sreRawMessage - 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 . * Must be base64-encoded. * Per RFC 5321 , the maximum length of each line of text, including the CRLF, must not exceed 1,000 characters.

data SendRawEmail

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

See: sendRawEmail smart constructor.

Instances

Eq SendRawEmail

Methods

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

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

Data SendRawEmail

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SendRawEmail -> c SendRawEmail

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SendRawEmail

toConstr :: SendRawEmail -> Constr

dataTypeOf :: SendRawEmail -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SendRawEmail)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SendRawEmail)

gmapT :: (forall b. Data b => b -> b) -> SendRawEmail -> SendRawEmail

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SendRawEmail -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SendRawEmail -> r

gmapQ :: (forall d. Data d => d -> u) -> SendRawEmail -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SendRawEmail -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SendRawEmail -> m SendRawEmail

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SendRawEmail -> m SendRawEmail

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SendRawEmail -> m SendRawEmail

Read SendRawEmail

Methods

readsPrec :: Int -> ReadS SendRawEmail

readList :: ReadS [SendRawEmail]

readPrec :: ReadPrec SendRawEmail

readListPrec :: ReadPrec [SendRawEmail]

Show SendRawEmail

Methods

showsPrec :: Int -> SendRawEmail -> ShowS

show :: SendRawEmail -> String

showList :: [SendRawEmail] -> ShowS

Generic SendRawEmail

Associated Types

type Rep SendRawEmail :: * -> *

Methods

from :: SendRawEmail -> Rep SendRawEmail x

to :: Rep SendRawEmail x -> SendRawEmail

Hashable SendRawEmail

Methods

hashWithSalt :: Int -> SendRawEmail -> Int

hash :: SendRawEmail -> Int

NFData SendRawEmail

Methods

rnf :: SendRawEmail -> ()

AWSRequest SendRawEmail

Associated Types

type Rs SendRawEmail :: *

Methods

request :: SendRawEmail -> Request SendRawEmail

response :: MonadResource m => Logger -> Service -> Proxy * SendRawEmail -> ClientResponse -> m (Response SendRawEmail)

ToQuery SendRawEmail

Methods

toQuery :: SendRawEmail -> QueryString

ToPath SendRawEmail

Methods

toPath :: SendRawEmail -> ByteString

ToHeaders SendRawEmail

Methods

toHeaders :: SendRawEmail -> [Header]

type Rep SendRawEmail

type Rep SendRawEmail = D1 (MetaData "SendRawEmail" "Network.AWS.SES.SendRawEmail" "amazonka-ses-1.5.0-IX6fk8AIUZF8NF0Dlao5KP" False) (C1 (MetaCons "SendRawEmail'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sreConfigurationSetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sreSourceARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_sreDestinations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_sreReturnPathARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sreSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sreFromARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_sreTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [MessageTag]))) (S1 (MetaSel (Just Symbol "_sreRawMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RawMessage))))))

type Rs SendRawEmail

type Rs SendRawEmail = SendRawEmailResponse

Request Lenses

sreConfigurationSetName :: Lens' SendRawEmail (Maybe Text)

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

sreSourceARN :: Lens' SendRawEmail (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 userexample.com , then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , and the Source to be userexample.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.

sreDestinations :: Lens' SendRawEmail [Text]

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

sreReturnPathARN :: Lens' SendRawEmail (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 feedbackexample.com , then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , and the ReturnPath to be feedbackexample.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.

sreSource :: Lens' SendRawEmail (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.) 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 .

sreFromARN :: Lens' SendRawEmail (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.

sreTags :: Lens' SendRawEmail [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.

sreRawMessage :: Lens' SendRawEmail RawMessage

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 . * Must be base64-encoded. * Per RFC 5321 , the maximum length of each line of text, including the CRLF, must not exceed 1,000 characters.

Destructuring the Response

sendRawEmailResponse

Arguments

:: Int

srersResponseStatus

-> Text

srersMessageId

-> SendRawEmailResponse

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:

• srersResponseStatus - -- | The response status code.
• srersMessageId - The unique message identifier returned from the SendRawEmail action.

data SendRawEmailResponse

Represents a unique message ID.

See: sendRawEmailResponse smart constructor.

Instances

Eq SendRawEmailResponse

Methods

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

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

Data SendRawEmailResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SendRawEmailResponse -> c SendRawEmailResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SendRawEmailResponse

toConstr :: SendRawEmailResponse -> Constr

dataTypeOf :: SendRawEmailResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SendRawEmailResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SendRawEmailResponse)

gmapT :: (forall b. Data b => b -> b) -> SendRawEmailResponse -> SendRawEmailResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SendRawEmailResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SendRawEmailResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> SendRawEmailResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SendRawEmailResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SendRawEmailResponse -> m SendRawEmailResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SendRawEmailResponse -> m SendRawEmailResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SendRawEmailResponse -> m SendRawEmailResponse

Read SendRawEmailResponse

Methods

readsPrec :: Int -> ReadS SendRawEmailResponse

readList :: ReadS [SendRawEmailResponse]

readPrec :: ReadPrec SendRawEmailResponse

readListPrec :: ReadPrec [SendRawEmailResponse]

Show SendRawEmailResponse

Methods

showsPrec :: Int -> SendRawEmailResponse -> ShowS

show :: SendRawEmailResponse -> String

showList :: [SendRawEmailResponse] -> ShowS

Generic SendRawEmailResponse

Associated Types

type Rep SendRawEmailResponse :: * -> *

Methods

from :: SendRawEmailResponse -> Rep SendRawEmailResponse x

to :: Rep SendRawEmailResponse x -> SendRawEmailResponse

NFData SendRawEmailResponse

Methods

rnf :: SendRawEmailResponse -> ()

type Rep SendRawEmailResponse

type Rep SendRawEmailResponse = D1 (MetaData "SendRawEmailResponse" "Network.AWS.SES.SendRawEmail" "amazonka-ses-1.5.0-IX6fk8AIUZF8NF0Dlao5KP" False) (C1 (MetaCons "SendRawEmailResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_srersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_srersMessageId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

Response Lenses

srersResponseStatus :: Lens' SendRawEmailResponse Int

• - | The response status code.

srersMessageId :: Lens' SendRawEmailResponse Text

The unique message identifier returned from the SendRawEmail action.