AWSSDK.SES

Amazon Simple Email Service

This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be used in conjunction with the Amazon SES Developer Guide.

Note

For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.

This document is generated from apis/email-2010-12-01.normal.json. See JuliaCloud/AWSCore.jl.

AWSSDK.SES.clone_receipt_rule_set — Function.

using AWSSDK.SES.clone_receipt_rule_set
clone_receipt_rule_set([::AWSConfig], arguments::Dict)
clone_receipt_rule_set([::AWSConfig]; RuleSetName=, OriginalRuleSetName=)

using AWSCore.Services.email
email([::AWSConfig], "CloneReceiptRuleSet", arguments::Dict)
email([::AWSConfig], "CloneReceiptRuleSet", RuleSetName=, OriginalRuleSetName=)

CloneReceiptRuleSet Operation

Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.

For information about setting up rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

RuleSetName = ::String – Required

The name of the rule set to create. The name must:

Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain less than 64 characters.

OriginalRuleSetName = ::String – Required

The name of the rule set to clone.

Returns

CloneReceiptRuleSetResponse

Exceptions

RuleSetDoesNotExistException, AlreadyExistsException or LimitExceededException.

Example: CloneReceiptRuleSet

The following example creates a receipt rule set by cloning an existing one:

Input:

[
    "OriginalRuleSetName" => "RuleSetToClone",
    "RuleSetName" => "RuleSetToCreate"
]

See also: AWS API Documentation

AWSSDK.SES.create_configuration_set — Function.

using AWSSDK.SES.create_configuration_set
create_configuration_set([::AWSConfig], arguments::Dict)
create_configuration_set([::AWSConfig]; ConfigurationSet=)

using AWSCore.Services.email
email([::AWSConfig], "CreateConfigurationSet", arguments::Dict)
email([::AWSConfig], "CreateConfigurationSet", ConfigurationSet=)

CreateConfigurationSet Operation

Creates a configuration set.

Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

ConfigurationSet = ["Name" => <required> ::String] – Required

A data structure that contains the name of the configuration set.

Returns

CreateConfigurationSetResponse

Exceptions

ConfigurationSetAlreadyExistsException, InvalidConfigurationSetException or LimitExceededException.

See also: AWS API Documentation

AWSSDK.SES.create_configuration_set_event_destination — Function.

using AWSSDK.SES.create_configuration_set_event_destination
create_configuration_set_event_destination([::AWSConfig], arguments::Dict)
create_configuration_set_event_destination([::AWSConfig]; ConfigurationSetName=, EventDestination=)

using AWSCore.Services.email
email([::AWSConfig], "CreateConfigurationSetEventDestination", arguments::Dict)
email([::AWSConfig], "CreateConfigurationSetEventDestination", ConfigurationSetName=, EventDestination=)

CreateConfigurationSetEventDestination Operation

Creates a configuration set event destination.

Note

When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).

An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

ConfigurationSetName = ::String – Required

The name of the configuration set that the event destination should be associated with.

EventDestination = [ ... ] – Required

An object that describes the AWS service that email sending event information will be published to.

 EventDestination = [
        "Name" => <required> ::String,
        "Enabled" =>  ::Bool,
        "MatchingEventTypes" => <required> ["send", "reject", "bounce", "complaint", "delivery", "open", "click" or "renderingFailure", ...],
        "KinesisFirehoseDestination" =>  [
            "IAMRoleARN" => <required> ::String,
            "DeliveryStreamARN" => <required> ::String
        ],
        "CloudWatchDestination" =>  ["DimensionConfigurations" => <required> [[
                "DimensionName" => <required> ::String,
                "DimensionValueSource" => <required> "messageTag", "emailHeader" or "linkTag",
                "DefaultDimensionValue" => <required> ::String
            ], ...]],
        "SNSDestination" =>  ["TopicARN" => <required> ::String]
    ]

Returns

CreateConfigurationSetEventDestinationResponse

Exceptions

ConfigurationSetDoesNotExistException, EventDestinationAlreadyExistsException, InvalidCloudWatchDestinationException, InvalidFirehoseDestinationException, InvalidSNSDestinationException or LimitExceededException.

See also: AWS API Documentation

AWSSDK.SES.create_configuration_set_tracking_options — Function.

using AWSSDK.SES.create_configuration_set_tracking_options
create_configuration_set_tracking_options([::AWSConfig], arguments::Dict)
create_configuration_set_tracking_options([::AWSConfig]; ConfigurationSetName=, TrackingOptions=)

using AWSCore.Services.email
email([::AWSConfig], "CreateConfigurationSetTrackingOptions", arguments::Dict)
email([::AWSConfig], "CreateConfigurationSetTrackingOptions", ConfigurationSetName=, TrackingOptions=)

CreateConfigurationSetTrackingOptions Operation

Creates an association between a configuration set and a custom domain for open and click event tracking.

By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using configuration sets, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.

Arguments

ConfigurationSetName = ::String – Required

The name of the configuration set that the tracking options should be associated with.

TrackingOptions = ["CustomRedirectDomain" => ::String] – Required

Returns

CreateConfigurationSetTrackingOptionsResponse

Exceptions

ConfigurationSetDoesNotExistException, TrackingOptionsAlreadyExistsException or InvalidTrackingOptionsException.

See also: AWS API Documentation

AWSSDK.SES.create_receipt_filter — Function.

using AWSSDK.SES.create_receipt_filter
create_receipt_filter([::AWSConfig], arguments::Dict)
create_receipt_filter([::AWSConfig]; Filter=)

using AWSCore.Services.email
email([::AWSConfig], "CreateReceiptFilter", arguments::Dict)
email([::AWSConfig], "CreateReceiptFilter", Filter=)

CreateReceiptFilter Operation

Creates a new IP address filter.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

Filter = [ ... ] – Required

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.

 Filter = [
        "Name" => <required> ::String,
        "IpFilter" => <required> [
            "Policy" => <required> "Block" or "Allow",
            "Cidr" => <required> ::String
        ]
    ]

Returns

CreateReceiptFilterResponse

Exceptions

LimitExceededException or AlreadyExistsException.

Example: CreateReceiptFilter

The following example creates a new IP address filter:

Input:

[
    "Filter" => [
        "IpFilter" => [
            "Cidr" => "1.2.3.4/24",
            "Policy" => "Allow"
        ],
        "Name" => "MyFilter"
    ]
]

See also: AWS API Documentation

AWSSDK.SES.create_receipt_rule — Function.

using AWSSDK.SES.create_receipt_rule
create_receipt_rule([::AWSConfig], arguments::Dict)
create_receipt_rule([::AWSConfig]; RuleSetName=, Rule=, <keyword arguments>)

using AWSCore.Services.email
email([::AWSConfig], "CreateReceiptRule", arguments::Dict)
email([::AWSConfig], "CreateReceiptRule", RuleSetName=, Rule=, <keyword arguments>)

CreateReceiptRule Operation

Creates a receipt rule.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

RuleSetName = ::String – Required

The name of the rule set that the receipt rule will be added to.

After = ::String

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.

Rule = [ ... ] – Required

A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.

 Rule = [
        "Name" => <required> ::String,
        "Enabled" =>  ::Bool,
        "TlsPolicy" =>  "Require" or "Optional",
        "Recipients" =>  [::String, ...],
        "Actions" =>  [[
            "S3Action" =>  [
                "TopicArn" =>  ::String,
                "BucketName" => <required> ::String,
                "ObjectKeyPrefix" =>  ::String,
                "KmsKeyArn" =>  ::String
            ],
            "BounceAction" =>  [
                "TopicArn" =>  ::String,
                "SmtpReplyCode" => <required> ::String,
                "StatusCode" =>  ::String,
                "Message" => <required> ::String,
                "Sender" => <required> ::String
            ],
            "WorkmailAction" =>  [
                "TopicArn" =>  ::String,
                "OrganizationArn" => <required> ::String
            ],
            "LambdaAction" =>  [
                "TopicArn" =>  ::String,
                "FunctionArn" => <required> ::String,
                "InvocationType" =>  "Event" or "RequestResponse"
            ],
            "StopAction" =>  [
                "Scope" => <required> "RuleSet",
                "TopicArn" =>  ::String
            ],
            "AddHeaderAction" =>  [
                "HeaderName" => <required> ::String,
                "HeaderValue" => <required> ::String
            ],
            "SNSAction" =>  [
                "TopicArn" => <required> ::String,
                "Encoding" =>  "UTF-8" or "Base64"
            ]
        ], ...],
        "ScanEnabled" =>  ::Bool
    ]

Returns

CreateReceiptRuleResponse

Exceptions

InvalidSnsTopicException, InvalidS3ConfigurationException, InvalidLambdaFunctionException, AlreadyExistsException, RuleDoesNotExistException, RuleSetDoesNotExistException or LimitExceededException.

Example: CreateReceiptRule

The following example creates a new receipt rule:

Input:

[
    "After" => "",
    "Rule" => [
        "Actions" => [
            [
                "S3Action" => [
                    "BucketName" => "MyBucket",
                    "ObjectKeyPrefix" => "email"
                ]
            ]
        ],
        "Enabled" => true,
        "Name" => "MyRule",
        "ScanEnabled" => true,
        "TlsPolicy" => "Optional"
    ],
    "RuleSetName" => "MyRuleSet"
]

See also: AWS API Documentation

AWSSDK.SES.create_receipt_rule_set — Function.

using AWSSDK.SES.create_receipt_rule_set
create_receipt_rule_set([::AWSConfig], arguments::Dict)
create_receipt_rule_set([::AWSConfig]; RuleSetName=)

using AWSCore.Services.email
email([::AWSConfig], "CreateReceiptRuleSet", arguments::Dict)
email([::AWSConfig], "CreateReceiptRuleSet", RuleSetName=)

CreateReceiptRuleSet Operation

Creates an empty receipt rule set.

For information about setting up receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

RuleSetName = ::String – Required

The name of the rule set to create. The name must:

Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain less than 64 characters.

Returns

CreateReceiptRuleSetResponse

Exceptions

AlreadyExistsException or LimitExceededException.

Example: CreateReceiptRuleSet

The following example creates an empty receipt rule set:

Input:

[
    "RuleSetName" => "MyRuleSet"
]

See also: AWS API Documentation

AWSSDK.SES.create_template — Function.

using AWSSDK.SES.create_template
create_template([::AWSConfig], arguments::Dict)
create_template([::AWSConfig]; Template=)

using AWSCore.Services.email
email([::AWSConfig], "CreateTemplate", arguments::Dict)
email([::AWSConfig], "CreateTemplate", Template=)

CreateTemplate Operation

Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

Template = [ ... ] – Required

The content of the email, composed of a subject line, an HTML part, and a text-only part.

 Template = [
        "TemplateName" => <required> ::String,
        "SubjectPart" =>  ::String,
        "TextPart" =>  ::String,
        "HtmlPart" =>  ::String
    ]

Returns

CreateTemplateResponse

Exceptions

AlreadyExistsException, InvalidTemplateException or LimitExceededException.

See also: AWS API Documentation

AWSSDK.SES.delete_configuration_set — Function.

using AWSSDK.SES.delete_configuration_set
delete_configuration_set([::AWSConfig], arguments::Dict)
delete_configuration_set([::AWSConfig]; ConfigurationSetName=)

using AWSCore.Services.email
email([::AWSConfig], "DeleteConfigurationSet", arguments::Dict)
email([::AWSConfig], "DeleteConfigurationSet", ConfigurationSetName=)

DeleteConfigurationSet Operation

Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

ConfigurationSetName = ::String – Required

The name of the configuration set to delete.

Returns

DeleteConfigurationSetResponse

Exceptions

ConfigurationSetDoesNotExistException.

See also: AWS API Documentation

AWSSDK.SES.delete_configuration_set_event_destination — Function.

using AWSSDK.SES.delete_configuration_set_event_destination
delete_configuration_set_event_destination([::AWSConfig], arguments::Dict)
delete_configuration_set_event_destination([::AWSConfig]; ConfigurationSetName=, EventDestinationName=)

using AWSCore.Services.email
email([::AWSConfig], "DeleteConfigurationSetEventDestination", arguments::Dict)
email([::AWSConfig], "DeleteConfigurationSetEventDestination", ConfigurationSetName=, EventDestinationName=)

DeleteConfigurationSetEventDestination Operation

Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

ConfigurationSetName = ::String – Required

The name of the configuration set from which to delete the event destination.

EventDestinationName = ::String – Required

The name of the event destination to delete.

Returns

DeleteConfigurationSetEventDestinationResponse

Exceptions

ConfigurationSetDoesNotExistException or EventDestinationDoesNotExistException.

See also: AWS API Documentation

AWSSDK.SES.delete_configuration_set_tracking_options — Function.

using AWSSDK.SES.delete_configuration_set_tracking_options
delete_configuration_set_tracking_options([::AWSConfig], arguments::Dict)
delete_configuration_set_tracking_options([::AWSConfig]; ConfigurationSetName=)

using AWSCore.Services.email
email([::AWSConfig], "DeleteConfigurationSetTrackingOptions", arguments::Dict)
email([::AWSConfig], "DeleteConfigurationSetTrackingOptions", ConfigurationSetName=)

DeleteConfigurationSetTrackingOptions Operation

Deletes an association between a configuration set and a custom domain for open and click event tracking.

Note

Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.

Arguments

ConfigurationSetName = ::String – Required

The name of the configuration set from which you want to delete the tracking options.

Returns

DeleteConfigurationSetTrackingOptionsResponse

Exceptions

ConfigurationSetDoesNotExistException or TrackingOptionsDoesNotExistException.

See also: AWS API Documentation

AWSSDK.SES.delete_identity — Function.

using AWSSDK.SES.delete_identity
delete_identity([::AWSConfig], arguments::Dict)
delete_identity([::AWSConfig]; Identity=)

using AWSCore.Services.email
email([::AWSConfig], "DeleteIdentity", arguments::Dict)
email([::AWSConfig], "DeleteIdentity", Identity=)

DeleteIdentity Operation

Deletes the specified identity (an email address or a domain) from the list of verified identities.

You can execute this operation no more than once per second.

Arguments

Identity = ::String – Required

The identity to be removed from the list of identities for the AWS Account.

Returns

DeleteIdentityResponse

Example: DeleteIdentity

The following example deletes an identity from the list of identities that have been submitted for verification with Amazon SES:

Input:

[
    "Identity" => "user@example.com"
]

See also: AWS API Documentation

AWSSDK.SES.delete_identity_policy — Function.

using AWSSDK.SES.delete_identity_policy
delete_identity_policy([::AWSConfig], arguments::Dict)
delete_identity_policy([::AWSConfig]; Identity=, PolicyName=)

using AWSCore.Services.email
email([::AWSConfig], "DeleteIdentityPolicy", arguments::Dict)
email([::AWSConfig], "DeleteIdentityPolicy", Identity=, PolicyName=)

DeleteIdentityPolicy Operation

Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.

Note

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

Identity = ::String – Required

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: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

PolicyName = ::String – Required

The name of the policy to be deleted.

Returns

DeleteIdentityPolicyResponse

Example: DeleteIdentityPolicy

The following example deletes a sending authorization policy for an identity:

Input:

[
    "Identity" => "user@example.com",
    "PolicyName" => "MyPolicy"
]

See also: AWS API Documentation

AWSSDK.SES.delete_receipt_filter — Function.

using AWSSDK.SES.delete_receipt_filter
delete_receipt_filter([::AWSConfig], arguments::Dict)
delete_receipt_filter([::AWSConfig]; FilterName=)

using AWSCore.Services.email
email([::AWSConfig], "DeleteReceiptFilter", arguments::Dict)
email([::AWSConfig], "DeleteReceiptFilter", FilterName=)

DeleteReceiptFilter Operation

Deletes the specified IP address filter.

For information about managing IP address filters, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

FilterName = ::String – Required

The name of the IP address filter to delete.

Returns

DeleteReceiptFilterResponse

Example: DeleteReceiptFilter

The following example deletes an IP address filter:

Input:

[
    "FilterName" => "MyFilter"
]

See also: AWS API Documentation

AWSSDK.SES.delete_receipt_rule — Function.

using AWSSDK.SES.delete_receipt_rule
delete_receipt_rule([::AWSConfig], arguments::Dict)
delete_receipt_rule([::AWSConfig]; RuleSetName=, RuleName=)

using AWSCore.Services.email
email([::AWSConfig], "DeleteReceiptRule", arguments::Dict)
email([::AWSConfig], "DeleteReceiptRule", RuleSetName=, RuleName=)

DeleteReceiptRule Operation

Deletes the specified receipt rule.

For information about managing receipt rules, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

RuleSetName = ::String – Required

The name of the receipt rule set that contains the receipt rule to delete.

RuleName = ::String – Required

The name of the receipt rule to delete.

Returns

DeleteReceiptRuleResponse

Exceptions

RuleSetDoesNotExistException.

Example: DeleteReceiptRule

The following example deletes a receipt rule:

Input:

[
    "RuleName" => "MyRule",
    "RuleSetName" => "MyRuleSet"
]

See also: AWS API Documentation

AWSSDK.SES.delete_receipt_rule_set — Function.

using AWSSDK.SES.delete_receipt_rule_set
delete_receipt_rule_set([::AWSConfig], arguments::Dict)
delete_receipt_rule_set([::AWSConfig]; RuleSetName=)

using AWSCore.Services.email
email([::AWSConfig], "DeleteReceiptRuleSet", arguments::Dict)
email([::AWSConfig], "DeleteReceiptRuleSet", RuleSetName=)

DeleteReceiptRuleSet Operation

Deletes the specified receipt rule set and all of the receipt rules it contains.

Note

The currently active rule set cannot be deleted.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

RuleSetName = ::String – Required

The name of the receipt rule set to delete.

Returns

DeleteReceiptRuleSetResponse

Exceptions

CannotDeleteException.

Example: DeleteReceiptRuleSet

The following example deletes a receipt rule set:

Input:

[
    "RuleSetName" => "MyRuleSet"
]

See also: AWS API Documentation

AWSSDK.SES.delete_template — Function.

using AWSSDK.SES.delete_template
delete_template([::AWSConfig], arguments::Dict)
delete_template([::AWSConfig]; TemplateName=)

using AWSCore.Services.email
email([::AWSConfig], "DeleteTemplate", arguments::Dict)
email([::AWSConfig], "DeleteTemplate", TemplateName=)

DeleteTemplate Operation

Deletes an email template.

You can execute this operation no more than once per second.

Arguments

TemplateName = ::String – Required

The name of the template to be deleted.

Returns

DeleteTemplateResponse

See also: AWS API Documentation

AWSSDK.SES.delete_verified_email_address — Function.

using AWSSDK.SES.delete_verified_email_address
delete_verified_email_address([::AWSConfig], arguments::Dict)
delete_verified_email_address([::AWSConfig]; EmailAddress=)

using AWSCore.Services.email
email([::AWSConfig], "DeleteVerifiedEmailAddress", arguments::Dict)
email([::AWSConfig], "DeleteVerifiedEmailAddress", EmailAddress=)

DeleteVerifiedEmailAddress Operation

Deprecated. Use the DeleteIdentity operation to delete email addresses and domains.

Arguments

EmailAddress = ::String – Required

An email address to be removed from the list of verified addresses.

Example: DeleteVerifiedEmailAddress

The following example deletes an email address from the list of identities that have been submitted for verification with Amazon SES:

Input:

[
    "EmailAddress" => "user@example.com"
]

See also: AWS API Documentation

AWSSDK.SES.describe_active_receipt_rule_set — Function.

using AWSSDK.SES.describe_active_receipt_rule_set
describe_active_receipt_rule_set([::AWSConfig], arguments::Dict)
describe_active_receipt_rule_set([::AWSConfig]; )

using AWSCore.Services.email
email([::AWSConfig], "DescribeActiveReceiptRuleSet", arguments::Dict)
email([::AWSConfig], "DescribeActiveReceiptRuleSet", )

DescribeActiveReceiptRuleSet Operation

Returns the metadata and receipt rules for the receipt rule set that is currently active.

For information about setting up receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

Returns

DescribeActiveReceiptRuleSetResponse

Example: DescribeActiveReceiptRuleSet

The following example returns the metadata and receipt rules for the receipt rule set that is currently active:

Input:

[

]

Output:

Dict(
    "Metadata" => Dict(
        "CreatedTimestamp" => "2016-07-15T16:25:59.607Z",
        "Name" => "default-rule-set"
    ),
    "Rules" => [
        Dict(
            "Actions" => [
                Dict(
                    "S3Action" => Dict(
                        "BucketName" => "MyBucket",
                        "ObjectKeyPrefix" => "email"
                    )
                )
            ],
            "Enabled" => true,
            "Name" => "MyRule",
            "ScanEnabled" => true,
            "TlsPolicy" => "Optional"
        )
    ]
)

See also: AWS API Documentation

AWSSDK.SES.describe_configuration_set — Function.

using AWSSDK.SES.describe_configuration_set
describe_configuration_set([::AWSConfig], arguments::Dict)
describe_configuration_set([::AWSConfig]; ConfigurationSetName=, <keyword arguments>)

using AWSCore.Services.email
email([::AWSConfig], "DescribeConfigurationSet", arguments::Dict)
email([::AWSConfig], "DescribeConfigurationSet", ConfigurationSetName=, <keyword arguments>)

DescribeConfigurationSet Operation

Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

ConfigurationSetName = ::String – Required

The name of the configuration set to describe.

ConfigurationSetAttributeNames = ["eventDestinations" or "trackingOptions", ...]

A list of configuration set attributes to return.

Returns

DescribeConfigurationSetResponse

Exceptions

ConfigurationSetDoesNotExistException.

See also: AWS API Documentation

AWSSDK.SES.describe_receipt_rule — Function.

using AWSSDK.SES.describe_receipt_rule
describe_receipt_rule([::AWSConfig], arguments::Dict)
describe_receipt_rule([::AWSConfig]; RuleSetName=, RuleName=)

using AWSCore.Services.email
email([::AWSConfig], "DescribeReceiptRule", arguments::Dict)
email([::AWSConfig], "DescribeReceiptRule", RuleSetName=, RuleName=)

DescribeReceiptRule Operation

Returns the details of the specified receipt rule.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

RuleSetName = ::String – Required

The name of the receipt rule set that the receipt rule belongs to.

RuleName = ::String – Required

The name of the receipt rule.

Returns

DescribeReceiptRuleResponse

Exceptions

RuleDoesNotExistException or RuleSetDoesNotExistException.

Example: DescribeReceiptRule

The following example returns the details of a receipt rule:

Input:

[
    "RuleName" => "MyRule",
    "RuleSetName" => "MyRuleSet"
]

Output:

Dict(
    "Rule" => Dict(
        "Actions" => [
            Dict(
                "S3Action" => Dict(
                    "BucketName" => "MyBucket",
                    "ObjectKeyPrefix" => "email"
                )
            )
        ],
        "Enabled" => true,
        "Name" => "MyRule",
        "ScanEnabled" => true,
        "TlsPolicy" => "Optional"
    )
)

See also: AWS API Documentation

AWSSDK.SES.describe_receipt_rule_set — Function.

using AWSSDK.SES.describe_receipt_rule_set
describe_receipt_rule_set([::AWSConfig], arguments::Dict)
describe_receipt_rule_set([::AWSConfig]; RuleSetName=)

using AWSCore.Services.email
email([::AWSConfig], "DescribeReceiptRuleSet", arguments::Dict)
email([::AWSConfig], "DescribeReceiptRuleSet", RuleSetName=)

DescribeReceiptRuleSet Operation

Returns the details of the specified receipt rule set.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

RuleSetName = ::String – Required

The name of the receipt rule set to describe.

Returns

DescribeReceiptRuleSetResponse

Exceptions

RuleSetDoesNotExistException.

Example: DescribeReceiptRuleSet

The following example returns the metadata and receipt rules of a receipt rule set:

Input:

[
    "RuleSetName" => "MyRuleSet"
]

Output:

Dict(
    "Metadata" => Dict(
        "CreatedTimestamp" => "2016-07-15T16:25:59.607Z",
        "Name" => "MyRuleSet"
    ),
    "Rules" => [
        Dict(
            "Actions" => [
                Dict(
                    "S3Action" => Dict(
                        "BucketName" => "MyBucket",
                        "ObjectKeyPrefix" => "email"
                    )
                )
            ],
            "Enabled" => true,
            "Name" => "MyRule",
            "ScanEnabled" => true,
            "TlsPolicy" => "Optional"
        )
    ]
)

See also: AWS API Documentation

AWSSDK.SES.get_identity_dkim_attributes — Function.

using AWSSDK.SES.get_identity_dkim_attributes
get_identity_dkim_attributes([::AWSConfig], arguments::Dict)
get_identity_dkim_attributes([::AWSConfig]; Identities=)

using AWSCore.Services.email
email([::AWSConfig], "GetIdentityDkimAttributes", arguments::Dict)
email([::AWSConfig], "GetIdentityDkimAttributes", Identities=)

GetIdentityDkimAttributes Operation

Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.

This operation takes a list of identities as input and returns the following information for each:

Whether Easy DKIM signing is enabled or disabled.
A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.
Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.

This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.

For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.

Arguments

Identities = [::String, ...] – Required

A list of one or more verified identities - email addresses, domains, or both.

Returns

GetIdentityDkimAttributesResponse

Example: GetIdentityDkimAttributes

The following example retrieves the Amazon SES Easy DKIM attributes for a list of identities:

Input:

[
    "Identities" => [
        "example.com",
        "user@example.com"
    ]
]

Output:

Dict(
    "DkimAttributes" => Dict(
        "example.com" => Dict(
            "DkimEnabled" => true,
            "DkimTokens" => [
                "EXAMPLEjcs5xoyqytjsotsijas7236gr",
                "EXAMPLEjr76cvoc6mysspnioorxsn6ep",
                "EXAMPLEkbmkqkhlm2lyz77ppkulerm4k"
            ],
            "DkimVerificationStatus" => "Success"
        ),
        "user@example.com" => Dict(
            "DkimEnabled" => false,
            "DkimVerificationStatus" => "NotStarted"
        )
    )
)

See also: AWS API Documentation

AWSSDK.SES.get_identity_mail_from_domain_attributes — Function.

using AWSSDK.SES.get_identity_mail_from_domain_attributes
get_identity_mail_from_domain_attributes([::AWSConfig], arguments::Dict)
get_identity_mail_from_domain_attributes([::AWSConfig]; Identities=)

using AWSCore.Services.email
email([::AWSConfig], "GetIdentityMailFromDomainAttributes", arguments::Dict)
email([::AWSConfig], "GetIdentityMailFromDomainAttributes", Identities=)

GetIdentityMailFromDomainAttributes Operation

Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).

This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.

Arguments

Identities = [::String, ...] – Required

A list of one or more identities.

Returns

GetIdentityMailFromDomainAttributesResponse

Example: GetIdentityMailFromDomainAttributes

The following example returns the custom MAIL FROM attributes for an identity:

Input:

[
    "Identities" => [
        "example.com"
    ]
]

Output:

Dict(
    "MailFromDomainAttributes" => Dict(
        "example.com" => Dict(
            "BehaviorOnMXFailure" => "UseDefaultValue",
            "MailFromDomain" => "bounces.example.com",
            "MailFromDomainStatus" => "Success"
        )
    )
)

See also: AWS API Documentation

AWSSDK.SES.get_identity_notification_attributes — Function.

using AWSSDK.SES.get_identity_notification_attributes
get_identity_notification_attributes([::AWSConfig], arguments::Dict)
get_identity_notification_attributes([::AWSConfig]; Identities=)

using AWSCore.Services.email
email([::AWSConfig], "GetIdentityNotificationAttributes", arguments::Dict)
email([::AWSConfig], "GetIdentityNotificationAttributes", Identities=)

GetIdentityNotificationAttributes Operation

Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.

This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

Arguments

Identities = [::String, ...] – Required

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: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

Returns

GetIdentityNotificationAttributesResponse

Example: GetIdentityNotificationAttributes

The following example returns the notification attributes for an identity:

Input:

[
    "Identities" => [
        "example.com"
    ]
]

Output:

Dict(
    "NotificationAttributes" => Dict(
        "example.com" => Dict(
            "BounceTopic" => "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic",
            "ComplaintTopic" => "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic",
            "DeliveryTopic" => "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic",
            "ForwardingEnabled" => true,
            "HeadersInBounceNotificationsEnabled" => false,
            "HeadersInComplaintNotificationsEnabled" => false,
            "HeadersInDeliveryNotificationsEnabled" => false
        )
    )
)

See also: AWS API Documentation

AWSSDK.SES.get_identity_policies — Function.

using AWSSDK.SES.get_identity_policies
get_identity_policies([::AWSConfig], arguments::Dict)
get_identity_policies([::AWSConfig]; Identity=, PolicyNames=)

using AWSCore.Services.email
email([::AWSConfig], "GetIdentityPolicies", arguments::Dict)
email([::AWSConfig], "GetIdentityPolicies", Identity=, PolicyNames=)

GetIdentityPolicies Operation

Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.

Note

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

You can execute this operation no more than once per second.

Arguments

Identity = ::String – Required

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: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

PolicyNames = [::String, ...] – Required

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.

Returns

GetIdentityPoliciesResponse

Example: GetIdentityPolicies

The following example returns a sending authorization policy for an identity:

Input:

[
    "Identity" => "example.com",
    "PolicyNames" => [
        "MyPolicy"
    ]
]

Output:

Dict(
    "Policies" => Dict(
        "MyPolicy" => "{"Version":"2008-10-17","Statement":[{"Sid":"stmt1469123904194","Effect":"Allow","Principal":{"AWS":"arn:aws:iam::123456789012:root"},"Action":["ses:SendEmail","ses:SendRawEmail"],"Resource":"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com"}]}"
    )
)

See also: AWS API Documentation

AWSSDK.SES.get_identity_verification_attributes — Function.

using AWSSDK.SES.get_identity_verification_attributes
get_identity_verification_attributes([::AWSConfig], arguments::Dict)
get_identity_verification_attributes([::AWSConfig]; Identities=)

using AWSCore.Services.email
email([::AWSConfig], "GetIdentityVerificationAttributes", arguments::Dict)
email([::AWSConfig], "GetIdentityVerificationAttributes", Identities=)

GetIdentityVerificationAttributes Operation

Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.

The verification status of an email address is "Pending" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to "Success". If the link is not clicked within 24 hours, the verification status changes to "Failed." In that case, if you still want to verify the email address, you must restart the verification process from the beginning.

For domain identities, the domain's verification status is "Pending" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning.

This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.

Arguments

Identities = [::String, ...] – Required

A list of identities.

Returns

GetIdentityVerificationAttributesResponse

Example: GetIdentityVerificationAttributes

The following example returns the verification status and the verification token for a domain identity:

Input:

[
    "Identities" => [
        "example.com"
    ]
]

Output:

Dict(
    "VerificationAttributes" => Dict(
        "example.com" => Dict(
            "VerificationStatus" => "Success",
            "VerificationToken" => "EXAMPLE3VYb9EDI2nTOQRi/Tf6MI/6bD6THIGiP1MVY="
        )
    )
)

See also: AWS API Documentation

AWSSDK.SES.get_send_quota — Function.

using AWSSDK.SES.get_send_quota
get_send_quota([::AWSConfig])


using AWSCore.Services.email
email([::AWSConfig], "GetSendQuota",)

GetSendQuota Operation

Provides the sending limits for the Amazon SES account.

You can execute this operation no more than once per second.

Returns

GetSendQuotaResponse

Example: GetSendQuota

The following example returns the Amazon SES sending limits for an AWS account:

Output:

Dict(
    "Max24HourSend" => 200,
    "MaxSendRate" => 1,
    "SentLast24Hours" => 1
)

See also: AWS API Documentation

AWSSDK.SES.get_send_statistics — Function.

using AWSSDK.SES.get_send_statistics
get_send_statistics([::AWSConfig])


using AWSCore.Services.email
email([::AWSConfig], "GetSendStatistics",)

GetSendStatistics Operation

Provides sending statistics for the Amazon SES account. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time.

You can execute this operation no more than once per second.

Returns

GetSendStatisticsResponse

Example: GetSendStatistics

The following example returns Amazon SES sending statistics:

Output:

Dict(
    "SendDataPoints" => [
        Dict(
            "Bounces" => 0,
            "Complaints" => 0,
            "DeliveryAttempts" => 5,
            "Rejects" => 0,
            "Timestamp" => "2016-07-13T22:43:00Z"
        ),
        Dict(
            "Bounces" => 0,
            "Complaints" => 0,
            "DeliveryAttempts" => 3,
            "Rejects" => 0,
            "Timestamp" => "2016-07-13T23:13:00Z"
        ),
        Dict(
            "Bounces" => 0,
            "Complaints" => 0,
            "DeliveryAttempts" => 1,
            "Rejects" => 0,
            "Timestamp" => "2016-07-13T21:13:00Z"
        )
    ]
)

See also: AWS API Documentation

AWSSDK.SES.get_template — Function.

using AWSSDK.SES.get_template
get_template([::AWSConfig], arguments::Dict)
get_template([::AWSConfig]; TemplateName=)

using AWSCore.Services.email
email([::AWSConfig], "GetTemplate", arguments::Dict)
email([::AWSConfig], "GetTemplate", TemplateName=)

GetTemplate Operation

Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify.

You can execute this operation no more than once per second.

Arguments

TemplateName = ::String – Required

The name of the template you want to retrieve.

Returns

GetTemplateResponse

Exceptions

TemplateDoesNotExistException.

See also: AWS API Documentation

AWSSDK.SES.list_configuration_sets — Function.

using AWSSDK.SES.list_configuration_sets
list_configuration_sets([::AWSConfig], arguments::Dict)
list_configuration_sets([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.email
email([::AWSConfig], "ListConfigurationSets", arguments::Dict)
email([::AWSConfig], "ListConfigurationSets", <keyword arguments>)

ListConfigurationSets Operation

Provides a list of the configuration sets associated with your Amazon SES account. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.

You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.

Arguments

NextToken = ::String

A token returned from a previous call to ListConfigurationSets to indicate the position of the configuration set in the configuration set list.

MaxItems = ::Int

The number of configuration sets to return.

Returns

ListConfigurationSetsResponse

See also: AWS API Documentation

AWSSDK.SES.list_identities — Function.

using AWSSDK.SES.list_identities
list_identities([::AWSConfig], arguments::Dict)
list_identities([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.email
email([::AWSConfig], "ListIdentities", arguments::Dict)
email([::AWSConfig], "ListIdentities", <keyword arguments>)

ListIdentities Operation

Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.

You can execute this operation no more than once per second.

Arguments

IdentityType = "EmailAddress" or "Domain"

The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed.

NextToken = ::String

The token to use for pagination.

MaxItems = ::Int

The maximum number of identities per page. Possible values are 1-1000 inclusive.

Returns

ListIdentitiesResponse

Example: ListIdentities

The following example lists the email address identities that have been submitted for verification with Amazon SES:

Input:

[
    "IdentityType" => "EmailAddress",
    "MaxItems" => 123,
    "NextToken" => ""
]

Output:

Dict(
    "Identities" => [
        "user@example.com"
    ],
    "NextToken" => ""
)

See also: AWS API Documentation

AWSSDK.SES.list_identity_policies — Function.

using AWSSDK.SES.list_identity_policies
list_identity_policies([::AWSConfig], arguments::Dict)
list_identity_policies([::AWSConfig]; Identity=)

using AWSCore.Services.email
email([::AWSConfig], "ListIdentityPolicies", arguments::Dict)
email([::AWSConfig], "ListIdentityPolicies", Identity=)

ListIdentityPolicies Operation

Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies.

Note

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

You can execute this operation no more than once per second.

Arguments

Identity = ::String – Required

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: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

Returns

ListIdentityPoliciesResponse

Example: ListIdentityPolicies

The following example returns a list of sending authorization policies that are attached to an identity:

Input:

[
    "Identity" => "example.com"
]

Output:

Dict(
    "PolicyNames" => [
        "MyPolicy"
    ]
)

See also: AWS API Documentation

AWSSDK.SES.list_receipt_filters — Function.

using AWSSDK.SES.list_receipt_filters
list_receipt_filters([::AWSConfig], arguments::Dict)
list_receipt_filters([::AWSConfig]; )

using AWSCore.Services.email
email([::AWSConfig], "ListReceiptFilters", arguments::Dict)
email([::AWSConfig], "ListReceiptFilters", )

ListReceiptFilters Operation

Lists the IP address filters associated with your AWS account.

For information about managing IP address filters, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

Returns

ListReceiptFiltersResponse

Example: ListReceiptFilters

The following example lists the IP address filters that are associated with an AWS account:

Output:

Dict(
    "Filters" => [
        Dict(
            "IpFilter" => Dict(
                "Cidr" => "1.2.3.4/24",
                "Policy" => "Block"
            ),
            "Name" => "MyFilter"
        )
    ]
)

See also: AWS API Documentation

AWSSDK.SES.list_receipt_rule_sets — Function.

using AWSSDK.SES.list_receipt_rule_sets
list_receipt_rule_sets([::AWSConfig], arguments::Dict)
list_receipt_rule_sets([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.email
email([::AWSConfig], "ListReceiptRuleSets", arguments::Dict)
email([::AWSConfig], "ListReceiptRuleSets", <keyword arguments>)

ListReceiptRuleSets Operation

Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

NextToken = ::String

A token returned from a previous call to ListReceiptRuleSets to indicate the position in the receipt rule set list.

Returns

ListReceiptRuleSetsResponse

Example: ListReceiptRuleSets

The following example lists the receipt rule sets that exist under an AWS account:

Input:

[
    "NextToken" => ""
]

Output:

Dict(
    "NextToken" => "",
    "RuleSets" => [
        Dict(
            "CreatedTimestamp" => "2016-07-15T16:25:59.607Z",
            "Name" => "MyRuleSet"
        )
    ]
)

See also: AWS API Documentation

AWSSDK.SES.list_templates — Function.

using AWSSDK.SES.list_templates
list_templates([::AWSConfig], arguments::Dict)
list_templates([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.email
email([::AWSConfig], "ListTemplates", arguments::Dict)
email([::AWSConfig], "ListTemplates", <keyword arguments>)

ListTemplates Operation

Lists the email templates present in your Amazon SES account.

You can execute this operation no more than once per second.

Arguments

NextToken = ::String

The token to use for pagination.

MaxItems = ::Int

The maximum number of templates to return. This value must be at least 1 and less than or equal to 10. If you do not specify a value, or if you specify a value less than 1 or greater than 10, the operation will return up to 10 results.

Returns

ListTemplatesResponse

See also: AWS API Documentation

AWSSDK.SES.list_verified_email_addresses — Function.

using AWSSDK.SES.list_verified_email_addresses
list_verified_email_addresses([::AWSConfig])


using AWSCore.Services.email
email([::AWSConfig], "ListVerifiedEmailAddresses",)

ListVerifiedEmailAddresses Operation

Deprecated. Use the ListIdentities operation to list the email addresses and domains associated with your account.

Returns

ListVerifiedEmailAddressesResponse

Example: ListVerifiedEmailAddresses

The following example lists all email addresses that have been submitted for verification with Amazon SES:

Output:

Dict(
    "VerifiedEmailAddresses" => [
        "user1@example.com",
        "user2@example.com"
    ]
)

See also: AWS API Documentation

AWSSDK.SES.put_identity_policy — Function.

using AWSSDK.SES.put_identity_policy
put_identity_policy([::AWSConfig], arguments::Dict)
put_identity_policy([::AWSConfig]; Identity=, PolicyName=, Policy=)

using AWSCore.Services.email
email([::AWSConfig], "PutIdentityPolicy", arguments::Dict)
email([::AWSConfig], "PutIdentityPolicy", Identity=, PolicyName=, Policy=)

PutIdentityPolicy Operation

Adds or updates a sending authorization policy for the specified identity (an email address or a domain).

Note

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

You can execute this operation no more than once per second.

Arguments

Identity = ::String – Required

The identity that the policy will apply to. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

PolicyName = ::String – Required

The name of the policy.

The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

Policy = ::String – Required

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.

Returns

PutIdentityPolicyResponse

Exceptions

InvalidPolicyException.

Example: PutIdentityPolicy

The following example adds a sending authorization policy to an identity:

Input:

[
    "Identity" => "example.com",
    "Policy" => "{"Version":"2008-10-17","Statement":[{"Sid":"stmt1469123904194","Effect":"Allow","Principal":{"AWS":"arn:aws:iam::123456789012:root"},"Action":["ses:SendEmail","ses:SendRawEmail"],"Resource":"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com"}]}",
    "PolicyName" => "MyPolicy"
]

See also: AWS API Documentation

AWSSDK.SES.reorder_receipt_rule_set — Function.

using AWSSDK.SES.reorder_receipt_rule_set
reorder_receipt_rule_set([::AWSConfig], arguments::Dict)
reorder_receipt_rule_set([::AWSConfig]; RuleSetName=, RuleNames=)

using AWSCore.Services.email
email([::AWSConfig], "ReorderReceiptRuleSet", arguments::Dict)
email([::AWSConfig], "ReorderReceiptRuleSet", RuleSetName=, RuleNames=)

ReorderReceiptRuleSet Operation

Reorders the receipt rules within a receipt rule set.

Note

All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

RuleSetName = ::String – Required

The name of the receipt rule set to reorder.

RuleNames = [::String, ...] – Required

A list of the specified receipt rule set's receipt rules in the order that you want to put them.

Returns

ReorderReceiptRuleSetResponse

Exceptions

RuleSetDoesNotExistException or RuleDoesNotExistException.

Example: ReorderReceiptRuleSet

The following example reorders the receipt rules within a receipt rule set:

Input:

[
    "RuleNames" => [
        "MyRule",
        "MyOtherRule"
    ],
    "RuleSetName" => "MyRuleSet"
]

See also: AWS API Documentation

AWSSDK.SES.send_bounce — Function.

using AWSSDK.SES.send_bounce
send_bounce([::AWSConfig], arguments::Dict)
send_bounce([::AWSConfig]; OriginalMessageId=, BounceSender=, BouncedRecipientInfoList=, <keyword arguments>)

using AWSCore.Services.email
email([::AWSConfig], "SendBounce", arguments::Dict)
email([::AWSConfig], "SendBounce", OriginalMessageId=, BounceSender=, BouncedRecipientInfoList=, <keyword arguments>)

SendBounce Operation

Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.

Note

You cannot use this API to send generic bounces for mail that was not received by Amazon SES.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

OriginalMessageId = ::String – Required

The message ID of the message to be bounced.

BounceSender = ::String – Required

The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.

Explanation = ::String

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 = [ ... ]

Message-related DSN fields. If not specified, Amazon SES will choose the values.

 MessageDsn = [
        "ReportingMta" => <required> ::String,
        "ArrivalDate" =>  timestamp,
        "ExtensionFields" =>  [[
            "Name" => <required> ::String,
            "Value" => <required> ::String
        ], ...]
    ]

BouncedRecipientInfoList = [[ ... ], ...] – Required

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.

 BouncedRecipientInfoList = [[
        "Recipient" => <required> ::String,
        "RecipientArn" =>  ::String,
        "BounceType" =>  "DoesNotExist", "MessageTooLarge", "ExceededQuota", "ContentRejected", "Undefined" or "TemporaryFailure",
        "RecipientDsnFields" =>  [
            "FinalRecipient" =>  ::String,
            "Action" => <required> "failed", "delayed", "delivered", "relayed" or "expanded",
            "RemoteMta" =>  ::String,
            "Status" => <required> ::String,
            "DiagnosticCode" =>  ::String,
            "LastAttemptDate" =>  timestamp,
            "ExtensionFields" =>  [[
                "Name" => <required> ::String,
                "Value" => <required> ::String
            ], ...]
        ]
    ], ...]

BounceSenderArn = ::String

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.

Returns

SendBounceResponse

Exceptions

MessageRejected.

See also: AWS API Documentation

AWSSDK.SES.send_bulk_templated_email — Function.

using AWSSDK.SES.send_bulk_templated_email
send_bulk_templated_email([::AWSConfig], arguments::Dict)
send_bulk_templated_email([::AWSConfig]; Source=, Template=, Destinations=, <keyword arguments>)

using AWSCore.Services.email
email([::AWSConfig], "SendBulkTemplatedEmail", arguments::Dict)
email([::AWSConfig], "SendBulkTemplatedEmail", Source=, Template=, Destinations=, <keyword arguments>)

SendBulkTemplatedEmail Operation

Composes an email message to multiple destinations. The message body is created using an email template.

In order to send email using the SendBulkTemplatedEmail operation, your call to the API must meet the following requirements:

The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.
The message must be sent from a verified email address or domain.
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 less than 10 MB.
Each Destination parameter 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.

Arguments

Source = ::String – Required

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.

SourceArn = ::String

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.

ReplyToAddresses = [::String, ...]

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

ReturnPath = ::String

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.

ReturnPathArn = ::String

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.

ConfigurationSetName = ::String

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

DefaultTags = [[ ... ], ...]

A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

 DefaultTags = [[
        "Name" => <required> ::String,
        "Value" => <required> ::String
    ], ...]

Template = ::String – Required

The template to use when sending this email.

TemplateArn = ::String

The ARN of the template to use when sending this email.

DefaultTemplateData = ::String

A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Destinations = [[ ... ], ...] – Required

One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

 Destinations = [[
        "Destination" => <required> [
            "ToAddresses" =>  [::String, ...],
            "CcAddresses" =>  [::String, ...],
            "BccAddresses" =>  [::String, ...]
        ],
        "ReplacementTags" =>  [[
            "Name" => <required> ::String,
            "Value" => <required> ::String
        ], ...],
        "ReplacementTemplateData" =>  ::String
    ], ...]

Returns

SendBulkTemplatedEmailResponse

Exceptions

MessageRejected, MailFromDomainNotVerifiedException, ConfigurationSetDoesNotExistException or TemplateDoesNotExistException.

See also: AWS API Documentation

AWSSDK.SES.send_email — Function.

using AWSSDK.SES.send_email
send_email([::AWSConfig], arguments::Dict)
send_email([::AWSConfig]; Source=, Destination=, Message=, <keyword arguments>)

using AWSCore.Services.email
email([::AWSConfig], "SendEmail", arguments::Dict)
email([::AWSConfig], "SendEmail", Source=, Destination=, Message=, <keyword arguments>)

SendEmail Operation

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.

Arguments

Source = ::String – Required

Destination = [ ... ] – Required

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

 Destination = [
        "ToAddresses" =>  [::String, ...],
        "CcAddresses" =>  [::String, ...],
        "BccAddresses" =>  [::String, ...]
    ]

Message = [ ... ] – Required

The message to be sent.

 Message = [
        "Subject" => <required> [
            "Data" => <required> ::String,
            "Charset" =>  ::String
        ],
        "Body" => <required> [
            "Text" =>  [
                "Data" => <required> ::String,
                "Charset" =>  ::String
            ],
            "Html" =>  [
                "Data" => <required> ::String,
                "Charset" =>  ::String
            ]
        ]
    ]

ReplyToAddresses = [::String, ...]

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

ReturnPath = ::String

SourceArn = ::String

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

ReturnPathArn = ::String

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

Tags = [[ ... ], ...]

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.

 Tags = [[
        "Name" => <required> ::String,
        "Value" => <required> ::String
    ], ...]

ConfigurationSetName = ::String

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

Returns

SendEmailResponse

Exceptions

MessageRejected, MailFromDomainNotVerifiedException or ConfigurationSetDoesNotExistException.

Example: SendEmail

The following example sends a formatted email:

Input:

[
    "Destination" => [
        "BccAddresses" => [

        ],
        "CcAddresses" => [
            "recipient3@example.com"
        ],
        "ToAddresses" => [
            "recipient1@example.com",
            "recipient2@example.com"
        ]
    ],
    "Message" => [
        "Body" => [
            "Html" => [
                "Charset" => "UTF-8",
                "Data" => "This message body contains HTML formatting. It can, for example, contain links like this one: <a class="ulink" href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide" target="_blank">Amazon SES Developer Guide</a>."
            ],
            "Text" => [
                "Charset" => "UTF-8",
                "Data" => "This is the message body in text format."
            ]
        ],
        "Subject" => [
            "Charset" => "UTF-8",
            "Data" => "Test email"
        ]
    ],
    "ReplyToAddresses" => [

    ],
    "ReturnPath" => "",
    "ReturnPathArn" => "",
    "Source" => "sender@example.com",
    "SourceArn" => ""
]

Output:

Dict(
    "MessageId" => "EXAMPLE78603177f-7a5433e7-8edb-42ae-af10-f0181f34d6ee-000000"
)

See also: AWS API Documentation

AWSSDK.SES.send_raw_email — Function.

using AWSSDK.SES.send_raw_email
send_raw_email([::AWSConfig], arguments::Dict)
send_raw_email([::AWSConfig]; RawMessage=, <keyword arguments>)

using AWSCore.Services.email
email([::AWSConfig], "SendRawEmail", arguments::Dict)
email([::AWSConfig], "SendRawEmail", RawMessage=, <keyword arguments>)

SendRawEmail Operation

Composes an email message and immediately queues it for sending. When calling this operation, you may specify the message headers as well as the content. The SendRawEmail operation is particularly useful for sending multipart MIME emails (such as those that contain both a plain-text and an HTML version).

In order to send email using the SendRawEmail 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 SendRawEmail 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.

Additionally, keep the following considerations in mind when using the SendRawEmail operation:

Although you can customize the message headers when using the SendRawEmail operation, Amazon SES will automatically apply its own Message-ID and Date headers; if you passed these headers when creating the message, they will be overwritten by the values that Amazon SES provides.
If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn to the API, or you can include the following X-headers in the header of your raw email:
- X-SES-SOURCE-ARN
- X-SES-FROM-ARN
- X-SES-RETURN-PATH-ARN
Important
Do not include these X-headers in the DKIM signature; Amazon SES will remove them before sending the email.
For most common sending authorization scenarios, we recommend that you specify the SourceIdentityArn parameter and not the FromIdentityArn or ReturnPathIdentityArn parameters. If you only specify the SourceIdentityArn parameter, Amazon SES will set the From and Return Path addresses to the identity specified in SourceIdentityArn. For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide.

Arguments

Source = ::String

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.

Note

If you specify the 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.

Destinations = [::String, ...]

A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.

RawMessage = ["Data" => <required> blob] – Required

The raw text of the message. The client is responsible for ensuring the following:

Message must contain a header and a body, separated by a blank line.
All required header fields must be present.
Each part of a multipart MIME message must be formatted properly.
MIME content types must be among those supported by Amazon SES. For more information, go to the Amazon SES Developer Guide.
Must be base64-encoded.
Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.

FromArn = ::String

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.

Note

For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

SourceArn = ::String

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.

Note

For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

ReturnPathArn = ::String

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.

Note

For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

Tags = [[ ... ], ...]

A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

 Tags = [[
        "Name" => <required> ::String,
        "Value" => <required> ::String
    ], ...]

ConfigurationSetName = ::String

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

Returns

SendRawEmailResponse

Exceptions

MessageRejected, MailFromDomainNotVerifiedException or ConfigurationSetDoesNotExistException.

Example: SendRawEmail

The following example sends an email with an attachment:

Input:

[
    "Destinations" => [

    ],
    "FromArn" => "",
    "RawMessage" => [
        "Data" => "From: sender@example.com
To: recipient@example.com
Subject: Test email (contains an attachment)
MIME-Version: 1.0
Content-type: Multipart/Mixed; boundary="NextPart"

--NextPart
Content-Type: text/plain

This is the message body.

--NextPart
Content-Type: text/plain;
Content-Disposition: attachment; filename="attachment.txt"

This is the text in the attachment.

--NextPart--"
    ],
    "ReturnPathArn" => "",
    "Source" => "",
    "SourceArn" => ""
]

Output:

Dict(
    "MessageId" => "EXAMPLEf3f73d99b-c63fb06f-d263-41f8-a0fb-d0dc67d56c07-000000"
)

See also: AWS API Documentation

AWSSDK.SES.send_templated_email — Function.

using AWSSDK.SES.send_templated_email
send_templated_email([::AWSConfig], arguments::Dict)
send_templated_email([::AWSConfig]; Source=, Destination=, Template=, TemplateData=, <keyword arguments>)

using AWSCore.Services.email
email([::AWSConfig], "SendTemplatedEmail", arguments::Dict)
email([::AWSConfig], "SendTemplatedEmail", Source=, Destination=, Template=, TemplateData=, <keyword arguments>)

SendTemplatedEmail Operation

Composes an email message using an email template and immediately queues it for sending.

In order to send email using the SendTemplatedEmail operation, your call to the API must meet the following requirements:

The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.
The message must be sent from a verified email address or domain.
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 less than 10 MB.
Calls to the SendTemplatedEmail operation may only include one Destination parameter. A destination is a set of recipients who will receive the same version of the email. The Destination parameter can include up to 50 recipients, across the To:, CC: and BCC: fields.
The Destination parameter 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.

Arguments

Source = ::String – Required

Destination = [ ... ] – Required

The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.

 Destination = [
        "ToAddresses" =>  [::String, ...],
        "CcAddresses" =>  [::String, ...],
        "BccAddresses" =>  [::String, ...]
    ]

ReplyToAddresses = [::String, ...]

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

ReturnPath = ::String

SourceArn = ::String

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

ReturnPathArn = ::String

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

Tags = [[ ... ], ...]

A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

 Tags = [[
        "Name" => <required> ::String,
        "Value" => <required> ::String
    ], ...]

ConfigurationSetName = ::String

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

Template = ::String – Required

The template to use when sending this email.

TemplateArn = ::String

The ARN of the template to use when sending this email.

TemplateData = ::String – Required

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Returns

SendTemplatedEmailResponse

Exceptions

MessageRejected, MailFromDomainNotVerifiedException, ConfigurationSetDoesNotExistException or TemplateDoesNotExistException.

See also: AWS API Documentation

AWSSDK.SES.set_active_receipt_rule_set — Function.

using AWSSDK.SES.set_active_receipt_rule_set
set_active_receipt_rule_set([::AWSConfig], arguments::Dict)
set_active_receipt_rule_set([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.email
email([::AWSConfig], "SetActiveReceiptRuleSet", arguments::Dict)
email([::AWSConfig], "SetActiveReceiptRuleSet", <keyword arguments>)

SetActiveReceiptRuleSet Operation

Sets the specified receipt rule set as the active receipt rule set.

Note

To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

RuleSetName = ::String

The name of the receipt rule set to make active. Setting this value to null disables all email receiving.

Returns

SetActiveReceiptRuleSetResponse

Exceptions

RuleSetDoesNotExistException.

Example: SetActiveReceiptRuleSet

The following example sets the active receipt rule set:

Input:

[
    "RuleSetName" => "RuleSetToActivate"
]

See also: AWS API Documentation

AWSSDK.SES.set_identity_dkim_enabled — Function.

using AWSSDK.SES.set_identity_dkim_enabled
set_identity_dkim_enabled([::AWSConfig], arguments::Dict)
set_identity_dkim_enabled([::AWSConfig]; Identity=, DkimEnabled=)

using AWSCore.Services.email
email([::AWSConfig], "SetIdentityDkimEnabled", arguments::Dict)
email([::AWSConfig], "SetIdentityDkimEnabled", Identity=, DkimEnabled=)

SetIdentityDkimEnabled Operation

Enables or disables Easy DKIM signing of email sent from an identity:

If Easy DKIM signing is enabled for a domain name identity (such as example.com), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (for example, user@example.com).
If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.

For email addresses (for example, user@example.com), you can only enable Easy DKIM signing if the corresponding domain (in this case, example.com) has been set up for Easy DKIM using the AWS Console or the VerifyDomainDkim operation.

You can execute this operation no more than once per second.

For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.

Arguments

Identity = ::String – Required

The identity for which DKIM signing should be enabled or disabled.

DkimEnabled = ::Bool – Required

Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it.

Returns

SetIdentityDkimEnabledResponse

Example: SetIdentityDkimEnabled

The following example configures Amazon SES to Easy DKIM-sign the email sent from an identity:

Input:

[
    "DkimEnabled" => true,
    "Identity" => "user@example.com"
]

See also: AWS API Documentation

AWSSDK.SES.set_identity_feedback_forwarding_enabled — Function.

using AWSSDK.SES.set_identity_feedback_forwarding_enabled
set_identity_feedback_forwarding_enabled([::AWSConfig], arguments::Dict)
set_identity_feedback_forwarding_enabled([::AWSConfig]; Identity=, ForwardingEnabled=)

using AWSCore.Services.email
email([::AWSConfig], "SetIdentityFeedbackForwardingEnabled", arguments::Dict)
email([::AWSConfig], "SetIdentityFeedbackForwardingEnabled", Identity=, ForwardingEnabled=)

SetIdentityFeedbackForwardingEnabled Operation

Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.

Note

Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.

You can execute this operation no more than once per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

Arguments

Identity = ::String – Required

The identity for which to set bounce and complaint notification forwarding. Examples: user@example.com, example.com.

ForwardingEnabled = ::Bool – Required

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.

Returns

SetIdentityFeedbackForwardingEnabledResponse

Example: SetIdentityFeedbackForwardingEnabled

The following example configures Amazon SES to forward an identity's bounces and complaints via email:

Input:

[
    "ForwardingEnabled" => true,
    "Identity" => "user@example.com"
]

See also: AWS API Documentation

AWSSDK.SES.set_identity_headers_in_notifications_enabled — Function.

using AWSSDK.SES.set_identity_headers_in_notifications_enabled
set_identity_headers_in_notifications_enabled([::AWSConfig], arguments::Dict)
set_identity_headers_in_notifications_enabled([::AWSConfig]; Identity=, NotificationType=, Enabled=)

using AWSCore.Services.email
email([::AWSConfig], "SetIdentityHeadersInNotificationsEnabled", arguments::Dict)
email([::AWSConfig], "SetIdentityHeadersInNotificationsEnabled", Identity=, NotificationType=, Enabled=)

SetIdentityHeadersInNotificationsEnabled Operation

Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.

You can execute this operation no more than once per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

Arguments

Identity = ::String – Required

The identity for which to enable or disable headers in notifications. Examples: user@example.com, example.com.

NotificationType = "Bounce", "Complaint" or "Delivery" – Required

The notification type for which to enable or disable headers in notifications.

Enabled = ::Bool – Required

Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES will include headers in notifications, and a value of false specifies that Amazon SES will not include headers in notifications.

This value can only be set when NotificationType is already set to use a particular Amazon SNS topic.

Returns

SetIdentityHeadersInNotificationsEnabledResponse

Example: SetIdentityHeadersInNotificationsEnabled

The following example configures Amazon SES to include the original email headers in the Amazon SNS bounce notifications for an identity:

Input:

[
    "Enabled" => true,
    "Identity" => "user@example.com",
    "NotificationType" => "Bounce"
]

See also: AWS API Documentation

AWSSDK.SES.set_identity_mail_from_domain — Function.

using AWSSDK.SES.set_identity_mail_from_domain
set_identity_mail_from_domain([::AWSConfig], arguments::Dict)
set_identity_mail_from_domain([::AWSConfig]; Identity=, <keyword arguments>)

using AWSCore.Services.email
email([::AWSConfig], "SetIdentityMailFromDomain", arguments::Dict)
email([::AWSConfig], "SetIdentityMailFromDomain", Identity=, <keyword arguments>)

SetIdentityMailFromDomain Operation

Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).

Important

To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

Identity = ::String – Required

The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.

MailFromDomain = ::String

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.

BehaviorOnMXFailure = "UseDefaultValue" or "RejectMessage"

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.

Returns

SetIdentityMailFromDomainResponse

Example: SetIdentityMailFromDomain

The following example configures Amazon SES to use a custom MAIL FROM domain for an identity:

Input:

[
    "BehaviorOnMXFailure" => "UseDefaultValue",
    "Identity" => "user@example.com",
    "MailFromDomain" => "bounces.example.com"
]

See also: AWS API Documentation

AWSSDK.SES.set_identity_notification_topic — Function.

using AWSSDK.SES.set_identity_notification_topic
set_identity_notification_topic([::AWSConfig], arguments::Dict)
set_identity_notification_topic([::AWSConfig]; Identity=, NotificationType=, <keyword arguments>)

using AWSCore.Services.email
email([::AWSConfig], "SetIdentityNotificationTopic", arguments::Dict)
email([::AWSConfig], "SetIdentityNotificationTopic", Identity=, NotificationType=, <keyword arguments>)

SetIdentityNotificationTopic Operation

Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that identity as the Source.

Note

Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications. For more information, see SetIdentityFeedbackForwardingEnabled.

You can execute this operation no more than once per second.

For more information about feedback notification, see the Amazon SES Developer Guide.

Arguments

Identity = ::String – Required

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: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

NotificationType = "Bounce", "Complaint" or "Delivery" – Required

The type of notifications that will be published to the specified Amazon SNS topic.

SnsTopic = ::String

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.

Returns

SetIdentityNotificationTopicResponse

Example: SetIdentityNotificationTopic

The following example sets the Amazon SNS topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with the specified identity as the Source:

Input:

[
    "Identity" => "user@example.com",
    "NotificationType" => "Bounce",
    "SnsTopic" => "arn:aws:sns:us-west-2:111122223333:MyTopic"
]

See also: AWS API Documentation

AWSSDK.SES.set_receipt_rule_position — Function.

using AWSSDK.SES.set_receipt_rule_position
set_receipt_rule_position([::AWSConfig], arguments::Dict)
set_receipt_rule_position([::AWSConfig]; RuleSetName=, RuleName=, <keyword arguments>)

using AWSCore.Services.email
email([::AWSConfig], "SetReceiptRulePosition", arguments::Dict)
email([::AWSConfig], "SetReceiptRulePosition", RuleSetName=, RuleName=, <keyword arguments>)

SetReceiptRulePosition Operation

Sets the position of the specified receipt rule in the receipt rule set.

For information about managing receipt rules, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

RuleSetName = ::String – Required

The name of the receipt rule set that contains the receipt rule to reposition.

RuleName = ::String – Required

The name of the receipt rule to reposition.

After = ::String

The name of the receipt rule after which to place the specified receipt rule.

Returns

SetReceiptRulePositionResponse

Exceptions

RuleSetDoesNotExistException or RuleDoesNotExistException.

Example: SetReceiptRulePosition

The following example sets the position of a receipt rule in a receipt rule set:

Input:

[
    "After" => "PutRuleAfterThisRule",
    "RuleName" => "RuleToReposition",
    "RuleSetName" => "MyRuleSet"
]

See also: AWS API Documentation

AWSSDK.SES.test_render_template — Function.

using AWSSDK.SES.test_render_template
test_render_template([::AWSConfig], arguments::Dict)
test_render_template([::AWSConfig]; TemplateName=, TemplateData=)

using AWSCore.Services.email
email([::AWSConfig], "TestRenderTemplate", arguments::Dict)
email([::AWSConfig], "TestRenderTemplate", TemplateName=, TemplateData=)

TestRenderTemplate Operation

Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.

You can execute this operation no more than once per second.

Arguments

TemplateName = ::String – Required

The name of the template that you want to render.

TemplateData = ::String – Required

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Returns

TestRenderTemplateResponse

Exceptions

TemplateDoesNotExistException, InvalidRenderingParameterException or MissingRenderingAttributeException.

See also: AWS API Documentation

AWSSDK.SES.update_configuration_set_event_destination — Function.

using AWSSDK.SES.update_configuration_set_event_destination
update_configuration_set_event_destination([::AWSConfig], arguments::Dict)
update_configuration_set_event_destination([::AWSConfig]; ConfigurationSetName=, EventDestination=)

using AWSCore.Services.email
email([::AWSConfig], "UpdateConfigurationSetEventDestination", arguments::Dict)
email([::AWSConfig], "UpdateConfigurationSetEventDestination", ConfigurationSetName=, EventDestination=)

UpdateConfigurationSetEventDestination Operation

Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.

Note

When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).

You can execute this operation no more than once per second.

Arguments

ConfigurationSetName = ::String – Required

The name of the configuration set that contains the event destination that you want to update.

EventDestination = [ ... ] – Required

The event destination object that you want to apply to the specified configuration set.

 EventDestination = [
        "Name" => <required> ::String,
        "Enabled" =>  ::Bool,
        "MatchingEventTypes" => <required> ["send", "reject", "bounce", "complaint", "delivery", "open", "click" or "renderingFailure", ...],
        "KinesisFirehoseDestination" =>  [
            "IAMRoleARN" => <required> ::String,
            "DeliveryStreamARN" => <required> ::String
        ],
        "CloudWatchDestination" =>  ["DimensionConfigurations" => <required> [[
                "DimensionName" => <required> ::String,
                "DimensionValueSource" => <required> "messageTag", "emailHeader" or "linkTag",
                "DefaultDimensionValue" => <required> ::String
            ], ...]],
        "SNSDestination" =>  ["TopicARN" => <required> ::String]
    ]

Returns

UpdateConfigurationSetEventDestinationResponse

Exceptions

ConfigurationSetDoesNotExistException, EventDestinationDoesNotExistException, InvalidCloudWatchDestinationException, InvalidFirehoseDestinationException or InvalidSNSDestinationException.

See also: AWS API Documentation

AWSSDK.SES.update_configuration_set_tracking_options — Function.

using AWSSDK.SES.update_configuration_set_tracking_options
update_configuration_set_tracking_options([::AWSConfig], arguments::Dict)
update_configuration_set_tracking_options([::AWSConfig]; ConfigurationSetName=, TrackingOptions=)

using AWSCore.Services.email
email([::AWSConfig], "UpdateConfigurationSetTrackingOptions", arguments::Dict)
email([::AWSConfig], "UpdateConfigurationSetTrackingOptions", ConfigurationSetName=, TrackingOptions=)

UpdateConfigurationSetTrackingOptions Operation

Modifies an association between a configuration set and a custom domain for open and click event tracking.

Arguments

ConfigurationSetName = ::String – Required

The name of the configuration set for which you want to update the custom tracking domain.

TrackingOptions = ["CustomRedirectDomain" => ::String] – Required

Returns

UpdateConfigurationSetTrackingOptionsResponse

Exceptions

ConfigurationSetDoesNotExistException, TrackingOptionsDoesNotExistException or InvalidTrackingOptionsException.

See also: AWS API Documentation

AWSSDK.SES.update_receipt_rule — Function.

using AWSSDK.SES.update_receipt_rule
update_receipt_rule([::AWSConfig], arguments::Dict)
update_receipt_rule([::AWSConfig]; RuleSetName=, Rule=)

using AWSCore.Services.email
email([::AWSConfig], "UpdateReceiptRule", arguments::Dict)
email([::AWSConfig], "UpdateReceiptRule", RuleSetName=, Rule=)

UpdateReceiptRule Operation

Updates a receipt rule.

For information about managing receipt rules, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

RuleSetName = ::String – Required

The name of the receipt rule set that the receipt rule belongs to.

Rule = [ ... ] – Required

A data structure that contains the updated receipt rule information.

 Rule = [
        "Name" => <required> ::String,
        "Enabled" =>  ::Bool,
        "TlsPolicy" =>  "Require" or "Optional",
        "Recipients" =>  [::String, ...],
        "Actions" =>  [[
            "S3Action" =>  [
                "TopicArn" =>  ::String,
                "BucketName" => <required> ::String,
                "ObjectKeyPrefix" =>  ::String,
                "KmsKeyArn" =>  ::String
            ],
            "BounceAction" =>  [
                "TopicArn" =>  ::String,
                "SmtpReplyCode" => <required> ::String,
                "StatusCode" =>  ::String,
                "Message" => <required> ::String,
                "Sender" => <required> ::String
            ],
            "WorkmailAction" =>  [
                "TopicArn" =>  ::String,
                "OrganizationArn" => <required> ::String
            ],
            "LambdaAction" =>  [
                "TopicArn" =>  ::String,
                "FunctionArn" => <required> ::String,
                "InvocationType" =>  "Event" or "RequestResponse"
            ],
            "StopAction" =>  [
                "Scope" => <required> "RuleSet",
                "TopicArn" =>  ::String
            ],
            "AddHeaderAction" =>  [
                "HeaderName" => <required> ::String,
                "HeaderValue" => <required> ::String
            ],
            "SNSAction" =>  [
                "TopicArn" => <required> ::String,
                "Encoding" =>  "UTF-8" or "Base64"
            ]
        ], ...],
        "ScanEnabled" =>  ::Bool
    ]

Returns

UpdateReceiptRuleResponse

Exceptions

InvalidSnsTopicException, InvalidS3ConfigurationException, InvalidLambdaFunctionException, RuleSetDoesNotExistException, RuleDoesNotExistException or LimitExceededException.

Example: UpdateReceiptRule

The following example updates a receipt rule to use an Amazon S3 action:

Input:

[
    "Rule" => [
        "Actions" => [
            [
                "S3Action" => [
                    "BucketName" => "MyBucket",
                    "ObjectKeyPrefix" => "email"
                ]
            ]
        ],
        "Enabled" => true,
        "Name" => "MyRule",
        "ScanEnabled" => true,
        "TlsPolicy" => "Optional"
    ],
    "RuleSetName" => "MyRuleSet"
]

See also: AWS API Documentation

AWSSDK.SES.update_template — Function.

using AWSSDK.SES.update_template
update_template([::AWSConfig], arguments::Dict)
update_template([::AWSConfig]; Template=)

using AWSCore.Services.email
email([::AWSConfig], "UpdateTemplate", arguments::Dict)
email([::AWSConfig], "UpdateTemplate", Template=)

UpdateTemplate Operation

Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

Template = [ ... ] – Required

 Template = [
        "TemplateName" => <required> ::String,
        "SubjectPart" =>  ::String,
        "TextPart" =>  ::String,
        "HtmlPart" =>  ::String
    ]

Returns

UpdateTemplateResponse

Exceptions

TemplateDoesNotExistException or InvalidTemplateException.

See also: AWS API Documentation

AWSSDK.SES.verify_domain_dkim — Function.

using AWSSDK.SES.verify_domain_dkim
verify_domain_dkim([::AWSConfig], arguments::Dict)
verify_domain_dkim([::AWSConfig]; Domain=)

using AWSCore.Services.email
email([::AWSConfig], "VerifyDomainDkim", arguments::Dict)
email([::AWSConfig], "VerifyDomainDkim", Domain=)

VerifyDomainDkim Operation

Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that represent your 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.

You can execute this operation no more than once per second.

To enable or disable Easy DKIM signing for a domain, use the SetIdentityDkimEnabled operation.

For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.

Arguments

Domain = ::String – Required

The name of the domain to be verified for Easy DKIM signing.

Returns

VerifyDomainDkimResponse

Example: VerifyDomainDkim

The following example generates DKIM tokens for a domain that has been verified with Amazon SES:

Input:

[
    "Domain" => "example.com"
]

Output:

Dict(
    "DkimTokens" => [
        "EXAMPLEq76owjnks3lnluwg65scbemvw",
        "EXAMPLEi3dnsj67hstzaj673klariwx2",
        "EXAMPLEwfbtcukvimehexktmdtaz6naj"
    ]
)

See also: AWS API Documentation

AWSSDK.SES.verify_domain_identity — Function.

using AWSSDK.SES.verify_domain_identity
verify_domain_identity([::AWSConfig], arguments::Dict)
verify_domain_identity([::AWSConfig]; Domain=)

using AWSCore.Services.email
email([::AWSConfig], "VerifyDomainIdentity", arguments::Dict)
email([::AWSConfig], "VerifyDomainIdentity", Domain=)

VerifyDomainIdentity Operation

Adds a domain to the list of identities for your Amazon SES account and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Arguments

Domain = ::String – Required

The domain to be verified.

Returns

VerifyDomainIdentityResponse

Example: VerifyDomainIdentity

The following example starts the domain verification process with Amazon SES:

Input:

[
    "Domain" => "example.com"
]

Output:

Dict(
    "VerificationToken" => "eoEmxw+YaYhb3h3iVJHuXMJXqeu1q1/wwmvjuEXAMPLE"
)

See also: AWS API Documentation

AWSSDK.SES.verify_email_address — Function.

using AWSSDK.SES.verify_email_address
verify_email_address([::AWSConfig], arguments::Dict)
verify_email_address([::AWSConfig]; EmailAddress=)

using AWSCore.Services.email
email([::AWSConfig], "VerifyEmailAddress", arguments::Dict)
email([::AWSConfig], "VerifyEmailAddress", EmailAddress=)

VerifyEmailAddress Operation

Deprecated. Use the VerifyEmailIdentity operation to verify a new email address.

Arguments

EmailAddress = ::String – Required

The email address to be verified.

Example: VerifyEmailAddress

The following example starts the email address verification process with Amazon SES:

Input:

[
    "EmailAddress" => "user@example.com"
]

See also: AWS API Documentation

AWSSDK.SES.verify_email_identity — Function.

using AWSSDK.SES.verify_email_identity
verify_email_identity([::AWSConfig], arguments::Dict)
verify_email_identity([::AWSConfig]; EmailAddress=)

using AWSCore.Services.email
email([::AWSConfig], "VerifyEmailIdentity", arguments::Dict)
email([::AWSConfig], "VerifyEmailIdentity", EmailAddress=)

VerifyEmailIdentity Operation

Adds an email address to the list of identities for your Amazon SES account and attempts to verify it. This operation causes a confirmation email message to be sent to the specified address.

You can execute this operation no more than once per second.

Arguments

EmailAddress = ::String – Required

The email address to be verified.

Returns

VerifyEmailIdentityResponse

Example: VerifyEmailIdentity

The following example starts the email address verification process with Amazon SES:

Input:

[
    "EmailAddress" => "user@example.com"
]

See also: AWS API Documentation