Network.AWS.SES.SendEmail

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 .

Creating a Request

sendEmail

Arguments

:: Text

seSource

-> Destination

seDestination

-> Message

seMessage

-> SendEmail

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 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.
• seConfigurationSetName - The name of the configuration set to use when you send an email using SendEmail .
• 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 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> .
• 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 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> .
• seTags - 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 - 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 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 - The destination for this email, composed of To:, CC:, and BCC: fields.
• seMessage - The message to be sent.

data SendEmail

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

Eq SendEmail

Methods

(==) :: SendEmail -> SendEmail -> Bool

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

Data SendEmail

Methods

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

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

toConstr :: SendEmail -> Constr

dataTypeOf :: SendEmail -> DataType

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

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

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

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

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

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

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

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

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

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

Read SendEmail

Methods

readsPrec :: Int -> ReadS SendEmail

readList :: ReadS [SendEmail]

readPrec :: ReadPrec SendEmail

readListPrec :: ReadPrec [SendEmail]

Show SendEmail

Methods

showsPrec :: Int -> SendEmail -> ShowS

show :: SendEmail -> String

showList :: [SendEmail] -> ShowS

Generic SendEmail

Associated Types

type Rep SendEmail :: * -> *

Methods

from :: SendEmail -> Rep SendEmail x

to :: Rep SendEmail x -> SendEmail

Hashable SendEmail

Methods

hashWithSalt :: Int -> SendEmail -> Int

hash :: SendEmail -> Int

NFData SendEmail

Methods

rnf :: SendEmail -> ()

AWSRequest SendEmail

Associated Types

type Rs SendEmail :: *

Methods

request :: SendEmail -> Request SendEmail

response :: MonadResource m => Logger -> Service -> Proxy * SendEmail -> ClientResponse -> m (Response SendEmail)

ToPath SendEmail

Methods

toPath :: SendEmail -> ByteString

ToHeaders SendEmail

Methods

toHeaders :: SendEmail -> [Header]

ToQuery SendEmail

Methods

toQuery :: SendEmail -> QueryString

type Rep SendEmail

type Rep SendEmail = D1 (MetaData "SendEmail" "Network.AWS.SES.SendEmail" "amazonka-ses-1.4.5-DhIaquVYmXCGGNLt54jVqA" False) (C1 (MetaCons "SendEmail'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_seReturnPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_seConfigurationSetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_seSourceARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_seReturnPathARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_seTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [MessageTag]))) (S1 (MetaSel (Just Symbol "_seReplyToAddresses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_seSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_seDestination") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Destination)) (S1 (MetaSel (Just Symbol "_seMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Message)))))))

type Rs SendEmail

type Rs SendEmail = SendEmailResponse

Request Lenses

seReturnPath :: Lens' SendEmail (Maybe Text)

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.

seConfigurationSetName :: Lens' SendEmail (Maybe Text)

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

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

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

seTags :: Lens' SendEmail [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.

seReplyToAddresses :: Lens' SendEmail [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.

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

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

seMessage :: Lens' SendEmail Message

The message to be sent.

Destructuring the Response

sendEmailResponse

Arguments

:: Int

sersResponseStatus

-> Text

sersMessageId

-> SendEmailResponse

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

data SendEmailResponse

Represents a unique message ID.

See: sendEmailResponse smart constructor.

Instances

Eq SendEmailResponse

Methods

(==) :: SendEmailResponse -> SendEmailResponse -> Bool

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

Data SendEmailResponse

Methods

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

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

toConstr :: SendEmailResponse -> Constr

dataTypeOf :: SendEmailResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read SendEmailResponse

Methods

readsPrec :: Int -> ReadS SendEmailResponse

readList :: ReadS [SendEmailResponse]

readPrec :: ReadPrec SendEmailResponse

readListPrec :: ReadPrec [SendEmailResponse]

Show SendEmailResponse

Methods

showsPrec :: Int -> SendEmailResponse -> ShowS

show :: SendEmailResponse -> String

showList :: [SendEmailResponse] -> ShowS

Generic SendEmailResponse

Associated Types

type Rep SendEmailResponse :: * -> *

Methods

from :: SendEmailResponse -> Rep SendEmailResponse x

to :: Rep SendEmailResponse x -> SendEmailResponse

NFData SendEmailResponse

Methods

rnf :: SendEmailResponse -> ()

type Rep SendEmailResponse

type Rep SendEmailResponse = D1 (MetaData "SendEmailResponse" "Network.AWS.SES.SendEmail" "amazonka-ses-1.4.5-DhIaquVYmXCGGNLt54jVqA" False) (C1 (MetaCons "SendEmailResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_sersResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_sersMessageId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

Response Lenses

sersResponseStatus :: Lens' SendEmailResponse Int

• - | The response status code.

sersMessageId :: Lens' SendEmailResponse Text

The unique message identifier returned from the SendEmail action.