Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SES.SendTemplatedEmail

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Composes an email message using an email template and immediately queues it for sending.

In order to send email using the SendTemplatedEmail operation, your call to the API must meet the following requirements:

The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.
The message must be sent from a verified email address or domain.
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 maximum message size is 10 MB.
Calls to the SendTemplatedEmail operation may only include one Destination parameter. A destination is a set of recipients who will receive the same version of the email. The Destination parameter can include up to 50 recipients, across the To:, CC: and BCC: fields.
The Destination parameter 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.

If your call to the SendTemplatedEmail operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email.

For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.

Synopsis

data SendTemplatedEmail = SendTemplatedEmail' {
- returnPath :: Maybe Text
- configurationSetName :: Maybe Text
- sourceArn :: Maybe Text
- returnPathArn :: Maybe Text
- templateArn :: Maybe Text
- tags :: Maybe [MessageTag]
- replyToAddresses :: Maybe [Text]
- source :: Text
- destination :: Destination
- template :: Text
- templateData :: Text
}
newSendTemplatedEmail :: Text -> Destination -> Text -> Text -> SendTemplatedEmail
sendTemplatedEmail_returnPath :: Lens' SendTemplatedEmail (Maybe Text)
sendTemplatedEmail_configurationSetName :: Lens' SendTemplatedEmail (Maybe Text)
sendTemplatedEmail_sourceArn :: Lens' SendTemplatedEmail (Maybe Text)
sendTemplatedEmail_returnPathArn :: Lens' SendTemplatedEmail (Maybe Text)
sendTemplatedEmail_templateArn :: Lens' SendTemplatedEmail (Maybe Text)
sendTemplatedEmail_tags :: Lens' SendTemplatedEmail (Maybe [MessageTag])
sendTemplatedEmail_replyToAddresses :: Lens' SendTemplatedEmail (Maybe [Text])
sendTemplatedEmail_source :: Lens' SendTemplatedEmail Text
sendTemplatedEmail_destination :: Lens' SendTemplatedEmail Destination
sendTemplatedEmail_template :: Lens' SendTemplatedEmail Text
sendTemplatedEmail_templateData :: Lens' SendTemplatedEmail Text
data SendTemplatedEmailResponse = SendTemplatedEmailResponse' {
- httpStatus :: Int
- messageId :: Text
}
newSendTemplatedEmailResponse :: Int -> Text -> SendTemplatedEmailResponse
sendTemplatedEmailResponse_httpStatus :: Lens' SendTemplatedEmailResponse Int
sendTemplatedEmailResponse_messageId :: Lens' SendTemplatedEmailResponse Text

Creating a Request

data SendTemplatedEmail Source #

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

See: newSendTemplatedEmail smart constructor.

Constructors

SendTemplatedEmail'

Fields

returnPath :: Maybe Text
The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
configurationSetName :: Maybe Text
The name of the configuration set to use when you send an email using SendTemplatedEmail.
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.
For more information about sending authorization, see the Amazon SES Developer Guide.
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.
For more information about sending authorization, see the Amazon SES Developer Guide.
templateArn :: Maybe Text
The ARN of the template to use when sending this email.
tags :: Maybe [MessageTag]
A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
replyToAddresses :: Maybe [Text]
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
source :: Text
The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
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 inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.
destination :: Destination
The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.
template :: Text
The template to use when sending this email.
templateData :: Text
A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Instances

Instances details

Eq SendTemplatedEmail Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail Methods (==) :: SendTemplatedEmail -> SendTemplatedEmail -> Bool # (/=) :: SendTemplatedEmail -> SendTemplatedEmail -> Bool #
Read SendTemplatedEmail Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail Methods readsPrec :: Int -> ReadS SendTemplatedEmail # readList :: ReadS [SendTemplatedEmail] # readPrec :: ReadPrec SendTemplatedEmail # readListPrec :: ReadPrec [SendTemplatedEmail] #
Show SendTemplatedEmail Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail Methods showsPrec :: Int -> SendTemplatedEmail -> ShowS # show :: SendTemplatedEmail -> String # showList :: [SendTemplatedEmail] -> ShowS #
Generic SendTemplatedEmail Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail Associated Types type Rep SendTemplatedEmail :: Type -> Type # Methods from :: SendTemplatedEmail -> Rep SendTemplatedEmail x # to :: Rep SendTemplatedEmail x -> SendTemplatedEmail #
NFData SendTemplatedEmail Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail Methods rnf :: SendTemplatedEmail -> () #
Hashable SendTemplatedEmail Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail Methods hashWithSalt :: Int -> SendTemplatedEmail -> Int # hash :: SendTemplatedEmail -> Int #
AWSRequest SendTemplatedEmail Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail Associated Types type AWSResponse SendTemplatedEmail # Methods request :: SendTemplatedEmail -> Request SendTemplatedEmail # response :: MonadResource m => Logger -> Service -> Proxy SendTemplatedEmail -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendTemplatedEmail))) #
ToHeaders SendTemplatedEmail Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail Methods toHeaders :: SendTemplatedEmail -> [Header] #
ToPath SendTemplatedEmail Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail Methods toPath :: SendTemplatedEmail -> ByteString #
ToQuery SendTemplatedEmail Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail Methods toQuery :: SendTemplatedEmail -> QueryString #
type Rep SendTemplatedEmail Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail type Rep SendTemplatedEmail = D1 ('MetaData "SendTemplatedEmail" "Amazonka.SES.SendTemplatedEmail" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "SendTemplatedEmail'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "returnPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "configurationSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "returnPathArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "templateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MessageTag])) :: (S1 ('MetaSel ('Just "replyToAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Destination) :: (S1 ('MetaSel ('Just "template") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "templateData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse SendTemplatedEmail Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail type AWSResponse SendTemplatedEmail = SendTemplatedEmailResponse

newSendTemplatedEmail Source #

Arguments

:: Text	`$sel:source:SendTemplatedEmail'`
-> Destination	`$sel:destination:SendTemplatedEmail'`
-> Text	`$sel:template:SendTemplatedEmail'`
-> Text	`$sel:templateData:SendTemplatedEmail'`
-> SendTemplatedEmail

Create a value of SendTemplatedEmail 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:returnPath:SendTemplatedEmail', sendTemplatedEmail_returnPath - The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

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

$sel:sourceArn:SendTemplatedEmail', sendTemplatedEmail_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.

For more information about sending authorization, see the Amazon SES Developer Guide.

$sel:returnPathArn:SendTemplatedEmail', sendTemplatedEmail_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.

For more information about sending authorization, see the Amazon SES Developer Guide.

$sel:templateArn:SendTemplatedEmail', sendTemplatedEmail_templateArn - The ARN of the template to use when sending this email.

$sel:tags:SendTemplatedEmail', sendTemplatedEmail_tags - A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

$sel:replyToAddresses:SendTemplatedEmail', sendTemplatedEmail_replyToAddresses - The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

$sel:source:SendTemplatedEmail', sendTemplatedEmail_source - The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

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 inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

$sel:destination:SendTemplatedEmail', sendTemplatedEmail_destination - The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.

$sel:template:SendTemplatedEmail', sendTemplatedEmail_template - The template to use when sending this email.

$sel:templateData:SendTemplatedEmail', sendTemplatedEmail_templateData - A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Request Lenses

sendTemplatedEmail_returnPath :: Lens' SendTemplatedEmail (Maybe Text) Source #

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

sendTemplatedEmail_configurationSetName :: Lens' SendTemplatedEmail (Maybe Text) Source #

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

sendTemplatedEmail_sourceArn :: Lens' SendTemplatedEmail (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.

For more information about sending authorization, see the Amazon SES Developer Guide.

sendTemplatedEmail_returnPathArn :: Lens' SendTemplatedEmail (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.

For more information about sending authorization, see the Amazon SES Developer Guide.

sendTemplatedEmail_templateArn :: Lens' SendTemplatedEmail (Maybe Text) Source #

The ARN of the template to use when sending this email.

sendTemplatedEmail_tags :: Lens' SendTemplatedEmail (Maybe [MessageTag]) Source #

A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

sendTemplatedEmail_replyToAddresses :: Lens' SendTemplatedEmail (Maybe [Text]) Source #

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

sendTemplatedEmail_source :: Lens' SendTemplatedEmail Text Source #

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

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 inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

sendTemplatedEmail_destination :: Lens' SendTemplatedEmail Destination Source #

The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.

sendTemplatedEmail_template :: Lens' SendTemplatedEmail Text Source #

The template to use when sending this email.

sendTemplatedEmail_templateData :: Lens' SendTemplatedEmail Text Source #

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Destructuring the Response

data SendTemplatedEmailResponse Source #

See: newSendTemplatedEmailResponse smart constructor.

Constructors

SendTemplatedEmailResponse'
Fields httpStatus :: Int The response's http status code. messageId :: Text The unique message identifier returned from the `SendTemplatedEmail` action.

Instances

Instances details

Eq SendTemplatedEmailResponse Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail Methods (==) :: SendTemplatedEmailResponse -> SendTemplatedEmailResponse -> Bool # (/=) :: SendTemplatedEmailResponse -> SendTemplatedEmailResponse -> Bool #
Read SendTemplatedEmailResponse Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail Methods readsPrec :: Int -> ReadS SendTemplatedEmailResponse # readList :: ReadS [SendTemplatedEmailResponse] # readPrec :: ReadPrec SendTemplatedEmailResponse # readListPrec :: ReadPrec [SendTemplatedEmailResponse] #
Show SendTemplatedEmailResponse Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail Methods showsPrec :: Int -> SendTemplatedEmailResponse -> ShowS # show :: SendTemplatedEmailResponse -> String # showList :: [SendTemplatedEmailResponse] -> ShowS #
Generic SendTemplatedEmailResponse Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail Associated Types type Rep SendTemplatedEmailResponse :: Type -> Type # Methods from :: SendTemplatedEmailResponse -> Rep SendTemplatedEmailResponse x # to :: Rep SendTemplatedEmailResponse x -> SendTemplatedEmailResponse #
NFData SendTemplatedEmailResponse Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail Methods rnf :: SendTemplatedEmailResponse -> () #
type Rep SendTemplatedEmailResponse Source #
Instance details Defined in Amazonka.SES.SendTemplatedEmail type Rep SendTemplatedEmailResponse = D1 ('MetaData "SendTemplatedEmailResponse" "Amazonka.SES.SendTemplatedEmail" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "SendTemplatedEmailResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "messageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSendTemplatedEmailResponse Source #

Arguments

:: Int	`$sel:httpStatus:SendTemplatedEmailResponse'`
-> Text	`$sel:messageId:SendTemplatedEmailResponse'`
-> SendTemplatedEmailResponse

Create a value of SendTemplatedEmailResponse 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:SendTemplatedEmailResponse', sendTemplatedEmailResponse_httpStatus - The response's http status code.

$sel:messageId:SendTemplatedEmailResponse', sendTemplatedEmailResponse_messageId - The unique message identifier returned from the SendTemplatedEmail action.

Response Lenses

sendTemplatedEmailResponse_httpStatus :: Lens' SendTemplatedEmailResponse Int Source #

The response's http status code.

sendTemplatedEmailResponse_messageId :: Lens' SendTemplatedEmailResponse Text Source #

The unique message identifier returned from the SendTemplatedEmail action.