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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Composes an email message and immediately queues it for sending. In order to send email using the SendEmail 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 maximum message size is 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 SendEmail operation several times to send the message to each group.

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

data SendEmail = SendEmail' {
- returnPath :: Maybe Text
- configurationSetName :: Maybe Text
- sourceArn :: Maybe Text
- returnPathArn :: Maybe Text
- tags :: Maybe [MessageTag]
- replyToAddresses :: Maybe [Text]
- source :: Text
- destination :: Destination
- message :: Message
}
newSendEmail :: Text -> Destination -> Message -> SendEmail
sendEmail_returnPath :: Lens' SendEmail (Maybe Text)
sendEmail_configurationSetName :: Lens' SendEmail (Maybe Text)
sendEmail_sourceArn :: Lens' SendEmail (Maybe Text)
sendEmail_returnPathArn :: Lens' SendEmail (Maybe Text)
sendEmail_tags :: Lens' SendEmail (Maybe [MessageTag])
sendEmail_replyToAddresses :: Lens' SendEmail (Maybe [Text])
sendEmail_source :: Lens' SendEmail Text
sendEmail_destination :: Lens' SendEmail Destination
sendEmail_message :: Lens' SendEmail Message
data SendEmailResponse = SendEmailResponse' {
- httpStatus :: Int
- messageId :: Text
}
newSendEmailResponse :: Int -> Text -> SendEmailResponse
sendEmailResponse_httpStatus :: Lens' SendEmailResponse Int
sendEmailResponse_messageId :: Lens' SendEmailResponse Text

Creating a Request

data SendEmail Source #

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

See: newSendEmail smart constructor.

Constructors

SendEmail'

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 SendEmail.
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.
tags :: Maybe [MessageTag]
A list of tags, in the form of name/value pairs, to apply to an email that you send using SendEmail. 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 in RFC 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.
message :: Message
The message to be sent.

Instances

Instances details

Eq SendEmail Source #
Instance details Defined in Amazonka.SES.SendEmail Methods (==) :: SendEmail -> SendEmail -> Bool # (/=) :: SendEmail -> SendEmail -> Bool #
Read SendEmail Source #
Instance details Defined in Amazonka.SES.SendEmail Methods readsPrec :: Int -> ReadS SendEmail # readList :: ReadS [SendEmail] # readPrec :: ReadPrec SendEmail # readListPrec :: ReadPrec [SendEmail] #
Show SendEmail Source #
Instance details Defined in Amazonka.SES.SendEmail Methods showsPrec :: Int -> SendEmail -> ShowS # show :: SendEmail -> String # showList :: [SendEmail] -> ShowS #
Generic SendEmail Source #
Instance details Defined in Amazonka.SES.SendEmail Associated Types type Rep SendEmail :: Type -> Type # Methods from :: SendEmail -> Rep SendEmail x # to :: Rep SendEmail x -> SendEmail #
NFData SendEmail Source #
Instance details Defined in Amazonka.SES.SendEmail Methods rnf :: SendEmail -> () #
Hashable SendEmail Source #
Instance details Defined in Amazonka.SES.SendEmail Methods hashWithSalt :: Int -> SendEmail -> Int # hash :: SendEmail -> Int #
AWSRequest SendEmail Source #
Instance details Defined in Amazonka.SES.SendEmail Associated Types type AWSResponse SendEmail # Methods request :: SendEmail -> Request SendEmail # response :: MonadResource m => Logger -> Service -> Proxy SendEmail -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendEmail))) #
ToHeaders SendEmail Source #
Instance details Defined in Amazonka.SES.SendEmail Methods toHeaders :: SendEmail -> [Header] #
ToPath SendEmail Source #
Instance details Defined in Amazonka.SES.SendEmail Methods toPath :: SendEmail -> ByteString #
ToQuery SendEmail Source #
Instance details Defined in Amazonka.SES.SendEmail Methods toQuery :: SendEmail -> QueryString #
type Rep SendEmail Source #
Instance details Defined in Amazonka.SES.SendEmail type Rep SendEmail = D1 ('MetaData "SendEmail" "Amazonka.SES.SendEmail" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "SendEmail'" '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 "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 "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Message))))))
type AWSResponse SendEmail Source #
Instance details Defined in Amazonka.SES.SendEmail type AWSResponse SendEmail = SendEmailResponse

newSendEmail Source #

Arguments

:: Text	`$sel:source:SendEmail'`
-> Destination	`$sel:destination:SendEmail'`
-> Message	`$sel:message:SendEmail'`
-> SendEmail

Create a value of SendEmail 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:SendEmail', sendEmail_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:SendEmail', sendEmail_configurationSetName - The name of the configuration set to use when you send an email using SendEmail.

$sel:sourceArn:SendEmail', sendEmail_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:SendEmail', sendEmail_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:tags:SendEmail', sendEmail_tags - A list of tags, in the form of name/value pairs, to apply to an email that you send using SendEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

$sel:replyToAddresses:SendEmail', sendEmail_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:SendEmail', sendEmail_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 in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

$sel:destination:SendEmail', sendEmail_destination - The destination for this email, composed of To:, CC:, and BCC: fields.

$sel:message:SendEmail', sendEmail_message - The message to be sent.

Request Lenses

sendEmail_returnPath :: Lens' SendEmail (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.

sendEmail_configurationSetName :: Lens' SendEmail (Maybe Text) Source #

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

sendEmail_sourceArn :: Lens' SendEmail (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.

sendEmail_returnPathArn :: Lens' SendEmail (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.

sendEmail_tags :: Lens' SendEmail (Maybe [MessageTag]) Source #

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

sendEmail_replyToAddresses :: Lens' SendEmail (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.

sendEmail_source :: Lens' SendEmail 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 in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

sendEmail_destination :: Lens' SendEmail Destination Source #

The destination for this email, composed of To:, CC:, and BCC: fields.

sendEmail_message :: Lens' SendEmail Message Source #

The message to be sent.

Destructuring the Response

data SendEmailResponse Source #

Represents a unique message ID.

See: newSendEmailResponse smart constructor.

Constructors

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

Instances

Instances details

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

newSendEmailResponse Source #

Arguments

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

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

$sel:messageId:SendEmailResponse', sendEmailResponse_messageId - The unique message identifier returned from the SendEmail action.

Response Lenses

sendEmailResponse_httpStatus :: Lens' SendEmailResponse Int Source #

The response's http status code.

sendEmailResponse_messageId :: Lens' SendEmailResponse Text Source #

The unique message identifier returned from the SendEmail action.