Network.AWS.SES.SendTemplatedEmail

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 total size of the message, including attachments, must be less than 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.

Creating a Request

sendTemplatedEmail

Arguments

:: Text

steSource

-> Destination

steDestination

-> Text

steTemplate

-> Text

steTemplateData

-> SendTemplatedEmail

Creates a value of SendTemplatedEmail with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• steReturnPath - 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.
• steConfigurationSetName - The name of the configuration set to use when you send an email using SendTemplatedEmail .
• steSourceARN - 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:identityexample.com , and the Source to be userexample.com . For more information about sending authorization, see the <http:docs.aws.amazon.comseslatestDeveloperGuide/sending-authorization.html Amazon SES Developer Guide> .
• steReturnPathARN - 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:identityexample.com , and the ReturnPath to be feedbackexample.com . For more information about sending authorization, see the <http:docs.aws.amazon.comseslatestDeveloperGuide/sending-authorization.html Amazon SES Developer Guide> .
• steTemplateARN - The ARN of the template to use when sending this email.
• steTags - 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.
• steReplyToAddresses - The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
• steSource - 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 .
• steDestination - The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.
• steTemplate - The template to use when sending this email.
• steTemplateData - 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.

data SendTemplatedEmail

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

See: sendTemplatedEmail smart constructor.

Instances

Eq SendTemplatedEmail

Methods

(==) :: SendTemplatedEmail -> SendTemplatedEmail -> Bool

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

Data SendTemplatedEmail

Methods

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

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

toConstr :: SendTemplatedEmail -> Constr

dataTypeOf :: SendTemplatedEmail -> DataType

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

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

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

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

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

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

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

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

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

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

Read SendTemplatedEmail

Methods

readsPrec :: Int -> ReadS SendTemplatedEmail

readList :: ReadS [SendTemplatedEmail]

readPrec :: ReadPrec SendTemplatedEmail

readListPrec :: ReadPrec [SendTemplatedEmail]

Show SendTemplatedEmail

Methods

showsPrec :: Int -> SendTemplatedEmail -> ShowS

show :: SendTemplatedEmail -> String

showList :: [SendTemplatedEmail] -> ShowS

Generic SendTemplatedEmail

Associated Types

type Rep SendTemplatedEmail :: * -> *

Methods

from :: SendTemplatedEmail -> Rep SendTemplatedEmail x

to :: Rep SendTemplatedEmail x -> SendTemplatedEmail

Hashable SendTemplatedEmail

Methods

hashWithSalt :: Int -> SendTemplatedEmail -> Int

hash :: SendTemplatedEmail -> Int

NFData SendTemplatedEmail

Methods

rnf :: SendTemplatedEmail -> ()

AWSRequest SendTemplatedEmail

Associated Types

type Rs SendTemplatedEmail :: *

Methods

request :: SendTemplatedEmail -> Request SendTemplatedEmail

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * SendTemplatedEmail -> ClientResponse -> m (Response SendTemplatedEmail)

ToHeaders SendTemplatedEmail

Methods

toHeaders :: SendTemplatedEmail -> [Header]

ToPath SendTemplatedEmail

Methods

toPath :: SendTemplatedEmail -> ByteString

ToQuery SendTemplatedEmail

Methods

toQuery :: SendTemplatedEmail -> QueryString

type Rep SendTemplatedEmail

type Rep SendTemplatedEmail = D1 * (MetaData "SendTemplatedEmail" "Network.AWS.SES.SendTemplatedEmail" "amazonka-ses-1.6.0-Gb8e1E6FgybCfuSzgoBDRc" False) (C1 * (MetaCons "SendTemplatedEmail'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_steReturnPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_steConfigurationSetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_steSourceARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_steReturnPathARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_steTemplateARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_steTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [MessageTag]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_steReplyToAddresses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_steSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_steDestination") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Destination)) ((:*:) * (S1 * (MetaSel (Just Symbol "_steTemplate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_steTemplateData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))))

type Rs SendTemplatedEmail

type Rs SendTemplatedEmail = SendTemplatedEmailResponse

Request Lenses

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

steConfigurationSetName :: Lens' SendTemplatedEmail (Maybe Text)

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

steSourceARN :: Lens' SendTemplatedEmail (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:identityexample.com , and the Source to be userexample.com . For more information about sending authorization, see the <http:docs.aws.amazon.comseslatestDeveloperGuide/sending-authorization.html Amazon SES Developer Guide> .

steReturnPathARN :: Lens' SendTemplatedEmail (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:identityexample.com , and the ReturnPath to be feedbackexample.com . For more information about sending authorization, see the <http:docs.aws.amazon.comseslatestDeveloperGuide/sending-authorization.html Amazon SES Developer Guide> .

steTemplateARN :: Lens' SendTemplatedEmail (Maybe Text)

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

steTags :: Lens' SendTemplatedEmail [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.

steReplyToAddresses :: Lens' SendTemplatedEmail [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.

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

steDestination :: Lens' 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.

steTemplate :: Lens' SendTemplatedEmail Text

The template to use when sending this email.

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

Destructuring the Response

sendTemplatedEmailResponse

Arguments

:: Int

stersResponseStatus

-> Text

stersMessageId

-> SendTemplatedEmailResponse

Creates a value of SendTemplatedEmailResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• stersResponseStatus - -- | The response status code.
• stersMessageId - The unique message identifier returned from the SendTemplatedEmail action.

data SendTemplatedEmailResponse

See: sendTemplatedEmailResponse smart constructor.

Instances

Eq SendTemplatedEmailResponse

Methods

(==) :: SendTemplatedEmailResponse -> SendTemplatedEmailResponse -> Bool

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

Data SendTemplatedEmailResponse

Methods

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

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

toConstr :: SendTemplatedEmailResponse -> Constr

dataTypeOf :: SendTemplatedEmailResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read SendTemplatedEmailResponse

Methods

readsPrec :: Int -> ReadS SendTemplatedEmailResponse

readList :: ReadS [SendTemplatedEmailResponse]

readPrec :: ReadPrec SendTemplatedEmailResponse

readListPrec :: ReadPrec [SendTemplatedEmailResponse]

Show SendTemplatedEmailResponse

Methods

showsPrec :: Int -> SendTemplatedEmailResponse -> ShowS

show :: SendTemplatedEmailResponse -> String

showList :: [SendTemplatedEmailResponse] -> ShowS

Generic SendTemplatedEmailResponse

Associated Types

type Rep SendTemplatedEmailResponse :: * -> *

Methods

from :: SendTemplatedEmailResponse -> Rep SendTemplatedEmailResponse x

to :: Rep SendTemplatedEmailResponse x -> SendTemplatedEmailResponse

NFData SendTemplatedEmailResponse

Methods

rnf :: SendTemplatedEmailResponse -> ()

type Rep SendTemplatedEmailResponse

type Rep SendTemplatedEmailResponse = D1 * (MetaData "SendTemplatedEmailResponse" "Network.AWS.SES.SendTemplatedEmail" "amazonka-ses-1.6.0-Gb8e1E6FgybCfuSzgoBDRc" False) (C1 * (MetaCons "SendTemplatedEmailResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_stersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_stersMessageId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))

Response Lenses

stersResponseStatus :: Lens' SendTemplatedEmailResponse Int

• - | The response status code.

stersMessageId :: Lens' SendTemplatedEmailResponse Text

The unique message identifier returned from the SendTemplatedEmail action.