String headerName
The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
String headerValue
Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").
String name
Content text
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).
Content html
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.
String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
bounce action is taken. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
String smtpReplyCode
The SMTP reply code, as defined by RFC 5321.
String statusCode
The SMTP enhanced status code, as defined by RFC 3463.
String message
Human-readable text to include in the bounce message.
String sender
The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
String recipient
The email address of the recipient of the bounced email.
String recipientArn
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 receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide.
String bounceType
The reason for the bounce. You must provide either this parameter or
RecipientDsnFields
.
RecipientDsnFields recipientDsnFields
Recipient-related DSN fields, most of which would normally be filled in
automatically when provided with a BounceType
. You must
provide either this parameter or BounceType
.
String name
String ruleSetName
The name of the rule set to create. The name must:
String originalRuleSetName
The name of the rule set to clone.
ReceiptFilter filter
A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it.
String ruleSetName
The name of the rule set to which to add the rule.
String after
The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list.
ReceiptRule rule
A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
String ruleSetName
The name of the rule set to create. The name must:
String identity
The identity that is associated with the policy that you want to delete.
You can specify the identity by using its name or by using its Amazon
Resource Name (ARN). Examples: [email protected]
,
example.com
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.
To successfully call this API, you must own the identity.
String policyName
The name of the policy to be deleted.
String identity
The identity to be removed from the list of identities for the AWS Account.
String filterName
The name of the IP address filter to delete.
String ruleSetName
The name of the receipt rule set to delete.
String emailAddress
An email address to be removed from the list of verified addresses.
ReceiptRuleSetMetadata metadata
The metadata for the currently active receipt rule set. The metadata consists of the rule set name and a timestamp of when the rule set was created.
com.amazonaws.internal.SdkInternalList<T> rules
The receipt rules that belong to the active rule set.
ReceiptRule rule
A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.
String ruleSetName
The name of the receipt rule set to describe.
ReceiptRuleSetMetadata metadata
The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set was created.
com.amazonaws.internal.SdkInternalList<T> rules
A list of the receipt rules that belong to the specified receipt rule set.
com.amazonaws.internal.SdkInternalList<T> toAddresses
The To: field(s) of the message.
com.amazonaws.internal.SdkInternalList<T> ccAddresses
The CC: field(s) of the message.
com.amazonaws.internal.SdkInternalList<T> bccAddresses
The BCC: field(s) of the message.
String name
The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
String value
The value of the header to add. Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").
com.amazonaws.internal.SdkInternalList<T> identities
A list of one or more verified identities - email addresses, domains, or both.
com.amazonaws.internal.SdkInternalMap<K,V> dkimAttributes
The DKIM attributes for an email address or a domain.
com.amazonaws.internal.SdkInternalList<T> identities
A list of one or more identities.
com.amazonaws.internal.SdkInternalMap<K,V> mailFromDomainAttributes
A map of identities to custom MAIL FROM attributes.
com.amazonaws.internal.SdkInternalList<T> identities
A list of one or more identities. You can specify an identity by using
its name or by using its Amazon Resource Name (ARN). Examples:
[email protected]
, example.com
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.
com.amazonaws.internal.SdkInternalMap<K,V> notificationAttributes
A map of Identity to IdentityNotificationAttributes.
String identity
The identity for which the policies will be retrieved. You can specify an
identity by using its name or by using its Amazon Resource Name (ARN).
Examples: [email protected]
, example.com
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.
To successfully call this API, you must own the identity.
com.amazonaws.internal.SdkInternalList<T> policyNames
A list of the names of policies to be retrieved. You can retrieve a
maximum of 20 policies at a time. If you do not know the names of the
policies that are attached to the identity, you can use
ListIdentityPolicies
.
com.amazonaws.internal.SdkInternalMap<K,V> policies
A map of policy names to policies.
com.amazonaws.internal.SdkInternalList<T> identities
A list of identities.
com.amazonaws.internal.SdkInternalMap<K,V> verificationAttributes
A map of Identities to IdentityVerificationAttributes objects.
Double max24HourSend
The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1 signifies an unlimited quota.
Double maxSendRate
The maximum number of emails that Amazon SES can accept from the user's account per second.
Double sentLast24Hours
The number of emails sent during the previous 24 hours.
com.amazonaws.internal.SdkInternalList<T> sendDataPoints
A list of data points, each of which represents 15 minutes of activity.
Boolean dkimEnabled
True if DKIM signing is enabled for email sent from the identity; false otherwise.
String dkimVerificationStatus
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.)
com.amazonaws.internal.SdkInternalList<T> dkimTokens
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.
String mailFromDomain
The custom MAIL FROM domain that the identity is configured to use.
String mailFromDomainStatus
The state that indicates whether Amazon SES has successfully read the MX
record required for custom MAIL FROM domain setup. If the state is
Success
, Amazon SES uses the specified custom MAIL FROM
domain when the verified identity sends an email. All other states
indicate that Amazon SES takes the action described by
BehaviorOnMXFailure
.
String behaviorOnMXFailure
The action that Amazon SES takes if it cannot successfully read the
required MX record when you send an email. A value of
UseDefaultValue
indicates that if Amazon SES cannot read the
required MX record, it uses amazonses.com (or a subdomain of that) as the
MAIL FROM domain. A value of RejectMessage
indicates that if
Amazon SES cannot read the required MX record, Amazon SES returns a
MailFromDomainNotVerified
error and does not send the email.
The custom MAIL FROM setup states that result in this behavior are
Pending
, Failed
, and
TemporaryFailure
.
String bounceTopic
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.
String complaintTopic
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.
String deliveryTopic
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.
Boolean forwardingEnabled
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.
String functionArn
String bucket
String topic
String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
Lambda action is taken. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
String functionArn
The Amazon Resource Name (ARN) of the AWS Lambda function. An example of
an AWS Lambda function ARN is
arn:aws:lambda:us-west-2:account-id:function:MyFunction
. For
more information about AWS Lambda, see the AWS
Lambda Developer Guide.
String invocationType
The invocation type of the AWS Lambda function. An invocation type of
RequestResponse
means that the execution of the function
will immediately result in a response, and a value of Event
means that the function will be invoked asynchronously. The default value
is Event
. For information about AWS Lambda invocation types,
see the AWS
Lambda Developer Guide.
RequestResponse
invocations. You should use Event
invocation in most cases.
Use RequestResponse
only when you want to make a mail flow
decision, such as whether to stop the receipt rule or the receipt rule
set.String identityType
The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed.
String nextToken
The token to use for pagination.
Integer maxItems
The maximum number of identities per page. Possible values are 1-1000 inclusive.
com.amazonaws.internal.SdkInternalList<T> identities
A list of identities.
String nextToken
The token used for pagination.
String identity
The identity that is associated with the policy for which the policies
will be listed. You can specify an identity by using its name or by using
its Amazon Resource Name (ARN). Examples: [email protected]
,
example.com
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.
To successfully call this API, you must own the identity.
com.amazonaws.internal.SdkInternalList<T> policyNames
A list of names of policies that apply to the specified identity.
com.amazonaws.internal.SdkInternalList<T> filters
A list of IP address filter data structures, which each consist of a name, an IP address range, and whether to allow or block mail from it.
String nextToken
A token returned from a previous call to ListReceiptRuleSets
to indicate the position in the receipt rule set list.
com.amazonaws.internal.SdkInternalList<T> ruleSets
The metadata for the currently active receipt rule set. The metadata consists of the rule set name and the timestamp of when the rule set was created.
String nextToken
A token indicating that there are additional receipt rule sets available
to be listed. Pass this token to successive calls of
ListReceiptRuleSets
to retrieve up to 100 receipt rule sets
at a time.
com.amazonaws.internal.SdkInternalList<T> verifiedEmailAddresses
A list of email addresses that have been verified.
String reportingMta
The reporting MTA that attempted to deliver the message, formatted as
specified in RFC 3464 (
mta-name-type; mta-name
). The default value is
dns; inbound-smtp.[region].amazonaws.com
.
Date arrivalDate
When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.
com.amazonaws.internal.SdkInternalList<T> extensionFields
Additional X-headers to include in the DSN.
String identity
The identity to which the policy will apply. You can specify an identity
by using its name or by using its Amazon Resource Name (ARN). Examples:
[email protected]
, example.com
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.
To successfully call this API, you must own the identity.
String policyName
The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
String policy
The text of the policy in JSON format. The policy cannot exceed 4 KB.
For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.
ByteBuffer data
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
.
For more information, go to the Amazon SES Developer Guide.
S3Action s3Action
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
BounceAction bounceAction
Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
WorkmailAction workmailAction
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
LambdaAction lambdaAction
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
StopAction stopAction
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
AddHeaderAction addHeaderAction
Adds a header to the received email.
SNSAction sNSAction
Publishes the email content within a notification to Amazon SNS.
String name
The name of the IP address filter. The name must:
ReceiptIpFilter ipFilter
A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.
String policy
Indicates whether to block or allow incoming mail from the specified IP addresses.
String cidr
A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317.
String name
The name of the receipt rule. The name must:
Boolean enabled
If true
, the receipt rule is active. The default value is
false
.
String tlsPolicy
Specifies whether Amazon SES should require that incoming email is
delivered over a connection encrypted with Transport Layer Security
(TLS). If this parameter is set to Require
, Amazon SES will
bounce emails that are not received over TLS. The default is
Optional
.
com.amazonaws.internal.SdkInternalList<T> recipients
The recipient domains and email addresses to which the receipt rule applies. If this field is not specified, this rule will match all recipients under all verified domains.
com.amazonaws.internal.SdkInternalList<T> actions
An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
Boolean scanEnabled
If true
, then messages to which this receipt rule applies
are scanned for spam and viruses. The default value is false
.
String name
The name of the receipt rule set. The name must:
Date createdTimestamp
The date and time the receipt rule set was created.
String finalRecipient
The email address to which the message was ultimately delivered. This
corresponds to the Final-Recipient
in the DSN. If not
specified, FinalRecipient
will be set to the
Recipient
specified in the BouncedRecipientInfo
structure. Either FinalRecipient
or the recipient in
BouncedRecipientInfo
must be a recipient of the original
bounced message.
FinalRecipient
email address with
rfc 822;
, as described in RFC 3798.String action
The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.
String remoteMta
The MTA to which the remote MTA attempted to deliver the message,
formatted as specified in RFC 3464 (
mta-name-type; mta-name
). This parameter typically applies
only to propagating synchronous bounces.
String status
The status code that indicates what went wrong. This is required by RFC 3464.
String diagnosticCode
An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.
Date lastAttemptDate
The time the final delivery attempt was made, in RFC 822 date-time format.
com.amazonaws.internal.SdkInternalList<T> extensionFields
Additional X-headers to include in the DSN.
String ruleSetName
The name of the receipt rule set to reorder.
com.amazonaws.internal.SdkInternalList<T> ruleNames
A list of the specified receipt rule set's receipt rules in the order that you want to put them.
String name
String name
String topicArn
The ARN of the Amazon SNS topic to notify when the message is saved to
the Amazon S3 bucket. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
String bucketName
The name of the Amazon S3 bucket to which to save the received email.
String objectKeyPrefix
The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
String kmsKeyArn
The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:
arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses
.
For example, if your AWS account ID is 123456789012 and you want to use
the default master key in the US West (Oregon) region, the ARN of the
default master key would be
arn:aws:kms:us-west-2:123456789012:alias/aws/ses
. If you use
the default master key, you don't need to perform any extra steps to give
Amazon SES permission to use the key.For more information about key policies, see the AWS KMS Developer Guide. If you do not specify a master key, Amazon SES will not encrypt your emails.
String originalMessageId
The message ID of the message to be bounced.
String bounceSender
The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.
String explanation
Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.
MessageDsn messageDsn
Message-related DSN fields. If not specified, Amazon SES will choose the values.
com.amazonaws.internal.SdkInternalList<T> bouncedRecipientInfoList
A list of recipients of the bounced message, including the information
required to create the Delivery Status Notifications (DSNs) for the
recipients. You must specify at least one
BouncedRecipientInfo
in the list.
String bounceSenderArn
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 address in the "From" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.
String messageId
The message ID of the bounce message.
Date timestamp
Time of the data point.
Long deliveryAttempts
Number of emails that have been enqueued for sending.
Long bounces
Number of emails that have bounced.
Long complaints
Number of unwanted emails that were rejected by recipients.
Long rejects
Number of emails rejected by Amazon SES.
String 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.
Destination destination
The destination for this email, composed of To:, CC:, and BCC: fields.
Message message
The message to be sent.
com.amazonaws.internal.SdkInternalList<T> 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.
String returnPath
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.
String 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
[email protected]
, then you would specify the
SourceArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
, and
the Source
to be [email protected]
.
For more information about sending authorization, see the Amazon SES Developer Guide.
String 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
[email protected]
, then you would specify the
ReturnPathArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
, and
the ReturnPath
to be [email protected]
.
For more information about sending authorization, see the Amazon SES Developer Guide.
String messageId
The unique message identifier returned from the SendEmail
action.
String source
The identity's email address. If you do not provide a value for this parameter, you must specify a "From" address in the raw text of the message. (You can also specify both.)
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.
Source
parameter and have feedback
forwarding enabled, then bounces and complaints will be sent to this
email address. This takes precedence over any Return-Path header
that you might include in the raw text of the message. com.amazonaws.internal.SdkInternalList<T> destinations
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
RawMessage rawMessage
The raw text of the message. The client is responsible for ensuring the following:
String fromArn
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 specify a particular "From" address in the header of the raw email.
Instead of using this parameter, you can use the X-header
X-SES-FROM-ARN
in the raw message of the email. If you use
both the FromArn
parameter and the corresponding X-header,
Amazon SES uses the value of the FromArn
parameter.
SendRawEmail
in this guide, or see the Amazon SES Developer Guide. String 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
[email protected]
, then you would specify the
SourceArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
, and
the Source
to be [email protected]
.
Instead of using this parameter, you can use the X-header
X-SES-SOURCE-ARN
in the raw message of the email. If you use
both the SourceArn
parameter and the corresponding X-header,
Amazon SES uses the value of the SourceArn
parameter.
SendRawEmail
in this guide, or see the Amazon SES Developer Guide. String 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
[email protected]
, then you would specify the
ReturnPathArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
, and
the ReturnPath
to be [email protected]
.
Instead of using this parameter, you can use the X-header
X-SES-RETURN-PATH-ARN
in the raw message of the email. If
you use both the ReturnPathArn
parameter and the
corresponding X-header, Amazon SES uses the value of the
ReturnPathArn
parameter.
SendRawEmail
in this guide, or see the Amazon SES Developer Guide. String messageId
The unique message identifier returned from the SendRawEmail
action.
String ruleSetName
The name of the receipt rule set to make active. Setting this value to null disables all email receiving.
String identity
The identity for which to set bounce and complaint notification
forwarding. Examples: [email protected]
,
example.com
.
Boolean forwardingEnabled
Sets whether Amazon SES will forward bounce and complaint notifications
as email. true
specifies that Amazon SES will forward bounce
and complaint notifications as email, in addition to any Amazon SNS topic
publishing otherwise specified. false
specifies that Amazon
SES will publish bounce and complaint notifications only through Amazon
SNS. This value can only be set to false
when Amazon SNS
topics are set for both Bounce
and Complaint
notification types.
String identity
The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.
String mailFromDomain
The custom MAIL FROM domain that you want the verified identity to use.
The MAIL FROM domain must 1) be a subdomain of the verified identity, 2)
not be used in a "From" address if the MAIL FROM domain is the
destination of email feedback forwarding (for more information, see the
Amazon SES Developer Guide), and 3) not be used to receive emails. A
value of null
disables the custom MAIL FROM setting for the
identity.
String behaviorOnMXFailure
The action that you want Amazon SES to take if it cannot successfully
read the required MX record when you send an email. If you choose
UseDefaultValue
, Amazon SES will use amazonses.com (or a
subdomain of that) as the MAIL FROM domain. If you choose
RejectMessage
, Amazon SES will return a
MailFromDomainNotVerified
error and not send the email.
The action specified in BehaviorOnMXFailure
is taken when
the custom MAIL FROM domain setup is in the Pending
,
Failed
, and TemporaryFailure
states.
String identity
The identity for which the Amazon SNS topic will be set. You can specify
an identity by using its name or by using its Amazon Resource Name (ARN).
Examples: [email protected]
, example.com
,
arn:aws:ses:us-east-1:123456789012:identity/example.com
.
String notificationType
The type of notifications that will be published to the specified Amazon SNS topic.
String snsTopic
The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter
is omitted from the request or a null value is passed,
SnsTopic
is cleared and publishing is disabled.
String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An
example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
String encoding
The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.
String scope
The scope to which the Stop action applies. That is, what is being stopped.
String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
stop action is taken. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
String ruleSetName
The name of the receipt rule set to which the receipt rule belongs.
ReceiptRule rule
A data structure that contains the updated receipt rule information.
String domain
The name of the domain to be verified for Easy DKIM signing.
com.amazonaws.internal.SdkInternalList<T> dkimTokens
A set of character strings that represent the domain's identity. If the identity is an email address, the tokens represent the domain of that address.
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 emails originating from that domain.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
String domain
The domain to be verified.
String verificationToken
A TXT record that must be placed in the DNS settings for the domain, in order to complete domain verification.
String emailAddress
The email address to be verified.
String emailAddress
The email address to be verified.
String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
WorkMail action is called. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
String organizationArn
The ARN of the Amazon WorkMail organization. An example of an Amazon
WorkMail organization ARN is
arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7
. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.
Copyright © 2016. All rights reserved.