Paws::SES - Perl Interface to AWS Amazon Simple Email Service
use Paws; my $obj = Paws->service('SES'); my $res = $obj->Method( Arg1 => $val1, Arg2 => [ 'V1', 'V2' ], # if Arg3 is an object, the HashRef will be used as arguments to the constructor # of the arguments type Arg3 => { Att1 => 'Val1' }, # if Arg4 is an array of objects, the HashRefs will be passed as arguments to # the constructor of the arguments type Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], );
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.
For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.
Each argument is described in detail in: Paws::SES::CloneReceiptRuleSet
Returns: a Paws::SES::CloneReceiptRuleSetResponse instance
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.
This action is throttled at one request per second.
Each argument is described in detail in: Paws::SES::CreateConfigurationSet
Returns: a Paws::SES::CreateConfigurationSetResponse instance
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.
Each argument is described in detail in: Paws::SES::CreateConfigurationSetEventDestination
Returns: a Paws::SES::CreateConfigurationSetEventDestinationResponse instance
Creates a configuration set event destination.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose.
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.
Each argument is described in detail in: Paws::SES::CreateReceiptFilter
Returns: a Paws::SES::CreateReceiptFilterResponse instance
Creates a new IP address filter.
For information about setting up IP address filters, see the Amazon SES Developer Guide.
Each argument is described in detail in: Paws::SES::CreateReceiptRule
Returns: a Paws::SES::CreateReceiptRuleResponse instance
Creates a receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
Each argument is described in detail in: Paws::SES::CreateReceiptRuleSet
Returns: a Paws::SES::CreateReceiptRuleSetResponse instance
Creates an empty receipt rule set.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
Each argument is described in detail in: Paws::SES::DeleteConfigurationSet
Returns: a Paws::SES::DeleteConfigurationSetResponse instance
Deletes a configuration set.
Each argument is described in detail in: Paws::SES::DeleteConfigurationSetEventDestination
Returns: a Paws::SES::DeleteConfigurationSetEventDestinationResponse instance
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.
Each argument is described in detail in: Paws::SES::DeleteIdentity
Returns: a Paws::SES::DeleteIdentityResponse instance
Deletes the specified identity (an email address or a domain) from the list of verified identities.
Each argument is described in detail in: Paws::SES::DeleteIdentityPolicy
Returns: a Paws::SES::DeleteIdentityPolicyResponse instance
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.
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.
Each argument is described in detail in: Paws::SES::DeleteReceiptFilter
Returns: a Paws::SES::DeleteReceiptFilterResponse instance
Deletes the specified IP address filter.
For information about managing IP address filters, see the Amazon SES Developer Guide.
Each argument is described in detail in: Paws::SES::DeleteReceiptRule
Returns: a Paws::SES::DeleteReceiptRuleResponse instance
Deletes the specified receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide.
Each argument is described in detail in: Paws::SES::DeleteReceiptRuleSet
Returns: a Paws::SES::DeleteReceiptRuleSetResponse instance
Deletes the specified receipt rule set and all of the receipt rules it contains.
The currently active rule set cannot be deleted.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
Each argument is described in detail in: Paws::SES::DeleteVerifiedEmailAddress
Returns: nothing
Deletes the specified email address from the list of verified addresses.
The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The DeleteIdentity action is now preferred.
Each argument is described in detail in: Paws::SES::DescribeActiveReceiptRuleSet
Returns: a Paws::SES::DescribeActiveReceiptRuleSetResponse instance
Returns the metadata and receipt rules for the receipt rule set that is currently active.
Each argument is described in detail in: Paws::SES::DescribeConfigurationSet
Returns: a Paws::SES::DescribeConfigurationSetResponse instance
Returns the details of the specified configuration set.
Each argument is described in detail in: Paws::SES::DescribeReceiptRule
Returns: a Paws::SES::DescribeReceiptRuleResponse instance
Returns the details of the specified receipt rule.
Each argument is described in detail in: Paws::SES::DescribeReceiptRuleSet
Returns: a Paws::SES::DescribeReceiptRuleSetResponse instance
Returns the details of the specified receipt rule set.
Each argument is described in detail in: Paws::SES::GetIdentityDkimAttributes
Returns: a Paws::SES::GetIdentityDkimAttributesResponse instance
Returns the current status of Easy DKIM signing for an entity. For domain name identities, this action 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 action 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 action 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.
Each argument is described in detail in: Paws::SES::GetIdentityMailFromDomainAttributes
Returns: a Paws::SES::GetIdentityMailFromDomainAttributesResponse instance
Returns the custom MAIL FROM attributes for a list of identities (email addresses and/or domains).
This action is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.
Each argument is described in detail in: Paws::SES::GetIdentityNotificationAttributes
Returns: a Paws::SES::GetIdentityNotificationAttributesResponse instance
Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.
This action 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.
Each argument is described in detail in: Paws::SES::GetIdentityPolicies
Returns: a Paws::SES::GetIdentityPoliciesResponse instance
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.
Each argument is described in detail in: Paws::SES::GetIdentityVerificationAttributes
Returns: a Paws::SES::GetIdentityVerificationAttributesResponse instance
Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.
This action is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.
Each argument is described in detail in: Paws::SES::GetSendQuota
Returns: a Paws::SES::GetSendQuotaResponse instance
Returns the user's current sending limits.
Each argument is described in detail in: Paws::SES::GetSendStatistics
Returns: a Paws::SES::GetSendStatisticsResponse instance
Returns the user's sending statistics. 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 interval.
Each argument is described in detail in: Paws::SES::ListConfigurationSets
Returns: a Paws::SES::ListConfigurationSetsResponse instance
Lists the configuration sets associated with your AWS account.
This action is throttled at one request per second and can return up to 50 configuration sets at a time.
Each argument is described in detail in: Paws::SES::ListIdentities
Returns: a Paws::SES::ListIdentitiesResponse instance
Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.
Each argument is described in detail in: Paws::SES::ListIdentityPolicies
Returns: a Paws::SES::ListIdentityPoliciesResponse instance
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 C<GetIdentityPolicies>.
Each argument is described in detail in: Paws::SES::ListReceiptFilters
Returns: a Paws::SES::ListReceiptFiltersResponse instance
Lists the IP address filters associated with your AWS account.
Each argument is described in detail in: Paws::SES::ListReceiptRuleSets
Returns: a Paws::SES::ListReceiptRuleSetsResponse instance
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 C<NextToken> that you can provide to the next call to C<ListReceiptRuleSets> to retrieve the additional entries.
Each argument is described in detail in: Paws::SES::ListVerifiedEmailAddresses
Returns: a Paws::SES::ListVerifiedEmailAddressesResponse instance
Returns a list containing all of the email addresses that have been verified.
The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of Domain Verification. The ListIdentities action is now preferred.
Each argument is described in detail in: Paws::SES::PutIdentityPolicy
Returns: a Paws::SES::PutIdentityPolicyResponse instance
Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
Each argument is described in detail in: Paws::SES::ReorderReceiptRuleSet
Returns: a Paws::SES::ReorderReceiptRuleSetResponse instance
Reorders the receipt rules within a receipt rule set.
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.
Each argument is described in detail in: Paws::SES::SendBounce
Returns: a Paws::SES::SendBounceResponse instance
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.
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.
Each argument is described in detail in: Paws::SES::SendEmail
Returns: a Paws::SES::SendEmailResponse instance
Composes an email message based on input data, and then immediately queues the message for sending.
There are several important points to know about SendEmail:
SendEmail
You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide.
The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.
Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.
For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide.
Each argument is described in detail in: Paws::SES::SendRawEmail
Returns: a Paws::SES::SendRawEmailResponse instance
Sends an email message, with header and content specified by the client. The C<SendRawEmail> action is useful for sending multipart MIME emails. The raw text of the message must comply with Internet email standards; otherwise, the message cannot be sent.
There are several important points to know about SendRawEmail:
SendRawEmail
The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list counts towards the 50-recipient limit.
Amazon SES overrides any Message-ID and Date headers you provide.
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:
SourceArn
FromArn
ReturnPathArn
X-SES-SOURCE-ARN
X-SES-FROM-ARN
X-SES-RETURN-PATH-ARN
Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.
For the most common sending authorization use case, we recommend that you specify the SourceIdentityArn and do not specify either the FromIdentityArn or ReturnPathIdentityArn. (The same note applies to the corresponding X-headers.) If you only specify the SourceIdentityArn, Amazon SES will simply set the "From" address and the "Return Path" address to the identity specified in SourceIdentityArn. For more information about sending authorization, see the Amazon SES Developer Guide.
SourceIdentityArn
FromIdentityArn
ReturnPathIdentityArn
Each argument is described in detail in: Paws::SES::SetActiveReceiptRuleSet
Returns: a Paws::SES::SetActiveReceiptRuleSetResponse instance
Sets the specified receipt rule set as the active receipt rule set.
To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null.
Each argument is described in detail in: Paws::SES::SetIdentityDkimEnabled
Returns: a Paws::SES::SetIdentityDkimEnabledResponse instance
Enables or disables Easy DKIM signing of email sent from an identity:
If Easy DKIM signing is enabled for a domain name identity (e.g., example.com), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (e.g., user@example.com).
example.com
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 (e.g., user@example.com), you can only enable Easy DKIM signing if the corresponding domain (e.g., example.com) has been set up for Easy DKIM using the AWS Console or the VerifyDomainDkim action.
VerifyDomainDkim
For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.
Each argument is described in detail in: Paws::SES::SetIdentityFeedbackForwardingEnabled
Returns: a Paws::SES::SetIdentityFeedbackForwardingEnabledResponse instance
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.
Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.
Each argument is described in detail in: Paws::SES::SetIdentityHeadersInNotificationsEnabled
Returns: a Paws::SES::SetIdentityHeadersInNotificationsEnabledResponse instance
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.
Each argument is described in detail in: Paws::SES::SetIdentityMailFromDomain
Returns: a Paws::SES::SetIdentityMailFromDomainResponse instance
Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).
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.
Each argument is described in detail in: Paws::SES::SetIdentityNotificationTopic
Returns: a Paws::SES::SetIdentityNotificationTopicResponse instance
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 C<Source>.
Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications. For more information, see SetIdentityFeedbackForwardingEnabled.
SetIdentityFeedbackForwardingEnabled
For more information about feedback notification, see the Amazon SES Developer Guide.
Each argument is described in detail in: Paws::SES::SetReceiptRulePosition
Returns: a Paws::SES::SetReceiptRulePositionResponse instance
Sets the position of the specified receipt rule in the receipt rule set.
Each argument is described in detail in: Paws::SES::UpdateConfigurationSetEventDestination
Returns: a Paws::SES::UpdateConfigurationSetEventDestinationResponse instance
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 or Amazon Kinesis Firehose. For information about using configuration sets, see the Amazon SES Developer Guide.
Each argument is described in detail in: Paws::SES::UpdateReceiptRule
Returns: a Paws::SES::UpdateReceiptRuleResponse instance
Updates a receipt rule.
Each argument is described in detail in: Paws::SES::VerifyDomainDkim
Returns: a Paws::SES::VerifyDomainDkimResponse instance
Returns a set of DKIM tokens for a domain. DKIM I<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.
To enable or disable Easy DKIM signing for a domain, use the SetIdentityDkimEnabled action.
SetIdentityDkimEnabled
Each argument is described in detail in: Paws::SES::VerifyDomainIdentity
Returns: a Paws::SES::VerifyDomainIdentityResponse instance
Verifies a domain.
Each argument is described in detail in: Paws::SES::VerifyEmailAddress
Verifies an email address. This action causes a confirmation email message to be sent to the specified address.
The VerifyEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The VerifyEmailIdentity action is now preferred.
Each argument is described in detail in: Paws::SES::VerifyEmailIdentity
Returns: a Paws::SES::VerifyEmailIdentityResponse instance
Paginator methods are helpers that repetively call methods that return partial results
If passed a sub as first parameter, it will call the sub for each element found in :
- Identities, passing the object as the first parameter, and the string 'Identities' as the second parameter
If not, it will return a a Paws::SES::ListIdentitiesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
param
This service class forms part of Paws
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.