amazonka-ses-1.4.5: Amazon Simple Email Service SDK.

Copyright (c) 2013-2016 Brendan Hay Mozilla Public License, v. 2.0. Brendan Hay auto-generated non-portable (GHC extensions) None Haskell2010

Network.AWS.SES.SendRawEmail

Description

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.
• Amazon SES overrides any Message-ID and Date headers you provide.
• 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 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, 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 the FromIdentityArn or ReturnPathIdentityArn . (The same note applies to the corresponding X-headers.) If you only specify the SourceIdentityArn , Amazon SES will simply set the From address and the "Return Path" address to the identity specified in SourceIdentityArn . For more information about sending authorization, see the Amazon SES Developer Guide .

# Creating a Request

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.

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

 Source # Methods Source # Methodsgfoldl :: (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 #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 # Source # Methods Source # MethodsshowList :: [SendRawEmail] -> ShowS # Source # Associated Typestype Rep SendRawEmail :: * -> * # Methods Source # Methods Source # Methodsrnf :: SendRawEmail -> () # Source # Associated Typestype Rs SendRawEmail :: * # Methods Source # Methods Source # MethodstoHeaders :: SendRawEmail -> [Header] # Source # Methods type Rep SendRawEmail Source # type Rep SendRawEmail = D1 (MetaData "SendRawEmail" "Network.AWS.SES.SendRawEmail" "amazonka-ses-1.4.5-DhIaquVYmXCGGNLt54jVqA" 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 Source #

# Request Lenses

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

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.

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

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.

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 .

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.

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.

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.

# Destructuring the Response

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.

Represents a unique message ID.

See: sendRawEmailResponse smart constructor.

Instances

 Source # Methods Source # Methodsgfoldl :: (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 #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 # Source # Methods Source # Methods Source # Associated Typestype Rep SendRawEmailResponse :: * -> * # Methods Source # Methodsrnf :: SendRawEmailResponse -> () # Source # type Rep SendRawEmailResponse = D1 (MetaData "SendRawEmailResponse" "Network.AWS.SES.SendRawEmail" "amazonka-ses-1.4.5-DhIaquVYmXCGGNLt54jVqA" False) (C1 (MetaCons "SendRawEmailResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_srersResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_srersMessageId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

# Response Lenses

• - | The response status code.

The unique message identifier returned from the SendRawEmail action.