Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
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 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
SendEmail
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.
Synopsis
- sendEmail :: Text -> Destination -> Message -> SendEmail
- data SendEmail
- seReturnPath :: Lens' SendEmail (Maybe Text)
- seConfigurationSetName :: Lens' SendEmail (Maybe Text)
- seSourceARN :: Lens' SendEmail (Maybe Text)
- seReturnPathARN :: Lens' SendEmail (Maybe Text)
- seTags :: Lens' SendEmail [MessageTag]
- seReplyToAddresses :: Lens' SendEmail [Text]
- seSource :: Lens' SendEmail Text
- seDestination :: Lens' SendEmail Destination
- seMessage :: Lens' SendEmail Message
- sendEmailResponse :: Int -> Text -> SendEmailResponse
- data SendEmailResponse
- sersResponseStatus :: Lens' SendEmailResponse Int
- sersMessageId :: Lens' SendEmailResponse Text
Creating a Request
Creates a value of SendEmail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
seReturnPath
- 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 theReturnPath
parameter. TheReturnPath
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.seConfigurationSetName
- The name of the configuration set to use when you send an email usingSendEmail
.seSourceARN
- 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 theSource
parameter. For example, if the owner ofexample.com
(which has ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to send fromuser
example.com, then you would specify the
SourceArnto be
arn:aws:ses:us-east-1:123456789012:identityexample.com, and the
Sourceto be
userexample.com
. For more information about sending authorization, see the <http:docs.aws.amazon.comseslatestDeveloperGuide/sending-authorization.html Amazon SES Developer Guide> .seReturnPathARN
- 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 theReturnPath
parameter. For example, if the owner ofexample.com
(which has ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to usefeedback
example.com, then you would specify the
ReturnPathArnto be
arn:aws:ses:us-east-1:123456789012:identityexample.com, and the
ReturnPathto be
feedbackexample.com
. For more information about sending authorization, see the <http:docs.aws.amazon.comseslatestDeveloperGuide/sending-authorization.html Amazon SES Developer Guide> .seTags
- A list of tags, in the form of name/value pairs, to apply to an email that you send usingSendEmail
. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.seReplyToAddresses
- The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.seSource
- 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 theSourceArn
parameter. For more information about sending authorization, see the Amazon SES Developer Guide .seDestination
- The destination for this email, composed of To:, CC:, and BCC: fields.seMessage
- The message to be sent.
Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide .
See: sendEmail
smart constructor.
Instances
Request Lenses
seReturnPath :: 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.
seConfigurationSetName :: Lens' SendEmail (Maybe Text) Source #
The name of the configuration set to use when you send an email using SendEmail
.
seSourceARN :: 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: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> .
seReturnPathARN :: 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: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> .
seTags :: Lens' SendEmail [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.
seReplyToAddresses :: Lens' SendEmail [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.
seSource :: 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 .
seDestination :: Lens' SendEmail Destination Source #
The destination for this email, composed of To:, CC:, and BCC: fields.
Destructuring the Response
Creates a value of SendEmailResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sersResponseStatus
- -- | The response status code.sersMessageId
- The unique message identifier returned from theSendEmail
action.
data SendEmailResponse Source #
Represents a unique message ID.
See: sendEmailResponse
smart constructor.
Instances
Response Lenses
sersResponseStatus :: Lens' SendEmailResponse Int Source #
- - | The response status code.
sersMessageId :: Lens' SendEmailResponse Text Source #
The unique message identifier returned from the SendEmail
action.