| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.SES.Types
Contents
Description
- sES :: Service
- _MessageRejected :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidPolicyException :: AsError a => Getting (First ServiceError) a ServiceError
- data IdentityType
- data NotificationType
- data VerificationStatus
- data Body
- body :: Body
- bText :: Lens' Body (Maybe Content)
- bHTML :: Lens' Body (Maybe Content)
- data Content
- content :: Text -> Content
- cCharset :: Lens' Content (Maybe Text)
- cData :: Lens' Content Text
- data Destination
- destination :: Destination
- dBCCAddresses :: Lens' Destination [Text]
- dCCAddresses :: Lens' Destination [Text]
- dToAddresses :: Lens' Destination [Text]
- data IdentityDkimAttributes
- identityDkimAttributes :: Bool -> VerificationStatus -> IdentityDkimAttributes
- idaDkimTokens :: Lens' IdentityDkimAttributes [Text]
- idaDkimEnabled :: Lens' IdentityDkimAttributes Bool
- idaDkimVerificationStatus :: Lens' IdentityDkimAttributes VerificationStatus
- data IdentityNotificationAttributes
- identityNotificationAttributes :: Text -> Text -> Text -> Bool -> IdentityNotificationAttributes
- inaBounceTopic :: Lens' IdentityNotificationAttributes Text
- inaComplaintTopic :: Lens' IdentityNotificationAttributes Text
- inaDeliveryTopic :: Lens' IdentityNotificationAttributes Text
- inaForwardingEnabled :: Lens' IdentityNotificationAttributes Bool
- data IdentityVerificationAttributes
- identityVerificationAttributes :: VerificationStatus -> IdentityVerificationAttributes
- ivaVerificationToken :: Lens' IdentityVerificationAttributes (Maybe Text)
- ivaVerificationStatus :: Lens' IdentityVerificationAttributes VerificationStatus
- data Message
- message :: Content -> Body -> Message
- mSubject :: Lens' Message Content
- mBody :: Lens' Message Body
- data RawMessage
- rawMessage :: ByteString -> RawMessage
- rmData :: Lens' RawMessage ByteString
- data SendDataPoint
- sendDataPoint :: SendDataPoint
- sdpRejects :: Lens' SendDataPoint (Maybe Integer)
- sdpComplaints :: Lens' SendDataPoint (Maybe Integer)
- sdpDeliveryAttempts :: Lens' SendDataPoint (Maybe Integer)
- sdpBounces :: Lens' SendDataPoint (Maybe Integer)
- sdpTimestamp :: Lens' SendDataPoint (Maybe UTCTime)
Service Configuration
Errors
_MessageRejected :: AsError a => Getting (First ServiceError) a ServiceError Source
Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
_InvalidPolicyException :: AsError a => Getting (First ServiceError) a ServiceError Source
Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error.
IdentityType
data IdentityType Source
Constructors
| Domain | |
| EmailAddress |
Instances
NotificationType
data NotificationType Source
Instances
VerificationStatus
data VerificationStatus Source
Constructors
| Failed | |
| NotStarted | |
| Pending | |
| Success | |
| TemporaryFailure |
Instances
Body
Represents the body of the message. You can specify text, HTML, or both. If you use both, then the message should display correctly in the widest variety of email clients.
See: body smart constructor.
bText :: Lens' Body (Maybe Content) Source
The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).
bHTML :: Lens' Body (Maybe Content) Source
The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.
Content
Represents textual data, plus an optional character set specification.
By default, the text must be 7-bit ASCII, due to the constraints of the SMTP protocol. If the text must contain any other characters, then you must also specify a character set. Examples include UTF-8, ISO-8859-1, and Shift_JIS.
See: content smart constructor.
Destination
data Destination Source
Represents the destination of the message, consisting of To:, CC:, and BCC: fields.
By default, the string 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.
See: destination smart constructor.
destination :: Destination Source
Creates a value of Destination with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dBCCAddresses :: Lens' Destination [Text] Source
The BCC: field(s) of the message.
dCCAddresses :: Lens' Destination [Text] Source
The CC: field(s) of the message.
dToAddresses :: Lens' Destination [Text] Source
The To: field(s) of the message.
IdentityDkimAttributes
data IdentityDkimAttributes Source
Represents the DKIM attributes of a verified email address or a domain.
See: identityDkimAttributes smart constructor.
Arguments
| :: Bool | |
| -> VerificationStatus | |
| -> IdentityDkimAttributes |
Creates a value of IdentityDkimAttributes with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
idaDkimTokens :: Lens' IdentityDkimAttributes [Text] Source
A set of character strings that represent the domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
idaDkimEnabled :: Lens' IdentityDkimAttributes Bool Source
True if DKIM signing is enabled for email sent from the identity; false otherwise.
idaDkimVerificationStatus :: Lens' IdentityDkimAttributes VerificationStatus Source
Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)
IdentityNotificationAttributes
data IdentityNotificationAttributes Source
Represents the notification attributes of an identity, including whether an identity has Amazon Simple Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery notifications, and whether feedback forwarding is enabled for bounce and complaint notifications.
See: identityNotificationAttributes smart constructor.
Instances
identityNotificationAttributes Source
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Bool | |
| -> IdentityNotificationAttributes |
Creates a value of IdentityNotificationAttributes with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
inaBounceTopic :: Lens' IdentityNotificationAttributes Text Source
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.
inaComplaintTopic :: Lens' IdentityNotificationAttributes Text Source
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.
inaDeliveryTopic :: Lens' IdentityNotificationAttributes Text Source
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.
inaForwardingEnabled :: Lens' IdentityNotificationAttributes Bool Source
Describes whether Amazon SES will forward bounce and complaint
notifications as email. true indicates that Amazon SES will forward
bounce and complaint notifications as email, while false indicates
that bounce and complaint notifications will be published only to the
specified bounce and complaint Amazon SNS topics.
IdentityVerificationAttributes
data IdentityVerificationAttributes Source
Represents the verification attributes of a single identity.
See: identityVerificationAttributes smart constructor.
Instances
identityVerificationAttributes Source
Creates a value of IdentityVerificationAttributes with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ivaVerificationToken :: Lens' IdentityVerificationAttributes (Maybe Text) Source
The verification token for a domain identity. Null for email address identities.
ivaVerificationStatus :: Lens' IdentityVerificationAttributes VerificationStatus Source
The verification status of the identity: "Pending", "Success", "Failed", or "TemporaryFailure".
Message
Represents the message to be sent, composed of a subject and a body.
See: message smart constructor.
mSubject :: Lens' Message Content Source
The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
RawMessage
data RawMessage Source
Represents the raw data of the message.
See: rawMessage smart constructor.
Instances
Arguments
| :: ByteString | |
| -> RawMessage |
Creates a value of RawMessage with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rmData :: Lens' RawMessage ByteString Source
The raw data of the message. The client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, MIME encoding, and base64 encoding (if necessary).
The To:, CC:, and BCC: headers in the raw message can contain a group list.
If you are using SendRawEmail with sending authorization, you can
include X-headers in the raw message to specify the "Source,"
"From," and "Return-Path" addresses. For more information, see the
documentation for SendRawEmail.
Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.
For more information, go to the Amazon SES Developer Guide.
Note: This Lens automatically encodes and decodes Base64 data,
despite what the AWS documentation might say.
The underlying isomorphism will encode to Base64 representation during
serialisation, and decode from Base64 representation during deserialisation.
This Lens accepts and returns only raw unencoded data.
SendDataPoint
data SendDataPoint Source
Represents sending statistics data. Each SendDataPoint contains
statistics for a 15-minute period of sending activity.
See: sendDataPoint smart constructor.
sendDataPoint :: SendDataPoint Source
Creates a value of SendDataPoint with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdpRejects :: Lens' SendDataPoint (Maybe Integer) Source
Number of emails rejected by Amazon SES.
sdpComplaints :: Lens' SendDataPoint (Maybe Integer) Source
Number of unwanted emails that were rejected by recipients.
sdpDeliveryAttempts :: Lens' SendDataPoint (Maybe Integer) Source
Number of emails that have been enqueued for sending.
sdpBounces :: Lens' SendDataPoint (Maybe Integer) Source
Number of emails that have bounced.
sdpTimestamp :: Lens' SendDataPoint (Maybe UTCTime) Source
Time of the data point.