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

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SES.SendEmail

Contents

Description

Composes an email message based on input data, and then immediately queues the message for sending.

There are several important points to know about SendEmail:

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

See: AWS API Reference for SendEmail.

Synopsis

Creating a Request

sendEmail Source

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:

data SendEmail Source

Represents a request instructing the service to send a single email message.

This datatype can be used in application code to compose a message consisting of source, destination, message, reply-to, and return-path parts. This object can then be sent using the SendEmail action.

See: sendEmail smart constructor.

Request Lenses

seReturnPath :: Lens' SendEmail (Maybe Text) Source

The email address to which bounces and complaints are to be forwarded 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.

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:identity\/example.com', and the Source to be 'user\'example.com'.

For more information about sending authorization, see the 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:identity\/example.com', and the ReturnPath to be 'feedback\'example.com'.

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

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.

In all cases, the email address 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.

seDestination :: Lens' SendEmail Destination Source

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

seMessage :: Lens' SendEmail Message Source

The message to be sent.

Destructuring the Response

sendEmailResponse Source

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:

Response Lenses

sersMessageId :: Lens' SendEmailResponse Text Source

The unique message identifier returned from the SendEmail action.