GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PAWS::SES (3)

.ds Aq ’

NAME

Paws::SES - Perl Interface to AWS Amazon Simple Email Service

CONTENTS

SYNOPSIS



  use Paws;

  my $obj = Paws->service(SES)->new;
  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 } ],
  );



DESCRIPTION

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.

METHODS

    DeleteIdentity(Identity => Str)

Each argument is described in detail in: Paws::SES::DeleteIdentity

Returns: a Paws::SES::DeleteIdentityResponse instance

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

This action is throttled at one request per second.

    DeleteIdentityPolicy(Identity => Str, PolicyName => Str)

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 (email address or 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.

This action is throttled at one request per second.

    DeleteVerifiedEmailAddress(EmailAddress => Str)

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.

This action is throttled at one request per second.

    GetIdentityDkimAttributes(Identities => ArrayRef[Str])

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:
o Whether Easy DKIM signing is enabled or disabled.
o A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.
o 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.

    GetIdentityNotificationAttributes(Identities => ArrayRef[Str])

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.

    GetIdentityPolicies(Identity => Str, PolicyNames => ArrayRef[Str])

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 (email address or 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.

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.

This action is throttled at one request per second.

    GetIdentityVerificationAttributes(Identities => ArrayRef[Str])

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.

    GetSendQuota( => )

Each argument is described in detail in: Paws::SES::GetSendQuota

Returns: a Paws::SES::GetSendQuotaResponse instance

Returns the user’s current sending limits.

This action is throttled at one request per second.

    GetSendStatistics( => )

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.

This action is throttled at one request per second.

    ListIdentities([IdentityType => Str, MaxItems => Int, NextToken => Str])

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 a specific AWS Account, regardless of verification status.

This action is throttled at one request per second.

    ListIdentityPolicies(Identity => Str)

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 (email address or domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies.

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.

This action is throttled at one request per second.

    ListVerifiedEmailAddresses( => )

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.

This action is throttled at one request per second.

    PutIdentityPolicy(Identity => Str, Policy => Str, PolicyName => Str)

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 (email address or domain).

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.

This action is throttled at one request per second.

    SendEmail(Destination => Paws::SES::Destination, Message => Paws::SES::Message, Source => Str, [ReplyToAddresses => ArrayRef[Str], ReturnPath => Str, ReturnPathArn => Str, SourceArn => Str])

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:
o 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.
o The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.
o 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.
o 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.

    SendRawEmail(RawMessage => Paws::SES::RawMessage, [Destinations => ArrayRef[Str], FromArn => Str, ReturnPathArn => Str, Source => Str, SourceArn => Str])

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 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:
o 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.
o The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.
o 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.
o 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.
o 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.
o 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:
o X-SES-SOURCE-ARN
o X-SES-FROM-ARN
o 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.

    SetIdentityDkimEnabled(DkimEnabled => Bool, Identity => Str)

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:
o 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).
o 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.

This action is throttled at one request per second.

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

    SetIdentityFeedbackForwardingEnabled(ForwardingEnabled => Bool, Identity => Str)

Each argument is described in detail in: Paws::SES::SetIdentityFeedbackForwardingEnabled

Returns: a Paws::SES::SetIdentityFeedbackForwardingEnabledResponse instance

Given an identity (email address or 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.

This action is throttled at one request per second.

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

    SetIdentityNotificationTopic(Identity => Str, NotificationType => Str, [SnsTopic => Str])

Each argument is described in detail in: Paws::SES::SetIdentityNotificationTopic

Returns: a Paws::SES::SetIdentityNotificationTopicResponse instance

Given an identity (email address or 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.

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

This action is throttled at one request per second.

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

    VerifyDomainDkim(Domain => Str)

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 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.

This action is throttled at one request per second.

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

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

    VerifyDomainIdentity(Domain => Str)

Each argument is described in detail in: Paws::SES::VerifyDomainIdentity

Returns: a Paws::SES::VerifyDomainIdentityResponse instance

Verifies a domain.

This action is throttled at one request per second.

    VerifyEmailAddress(EmailAddress => Str)

Each argument is described in detail in: Paws::SES::VerifyEmailAddress

Returns: nothing

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.

This action is throttled at one request per second.

    VerifyEmailIdentity(EmailAddress => Str)

Each argument is described in detail in: Paws::SES::VerifyEmailIdentity

Returns: a Paws::SES::VerifyEmailIdentityResponse instance

Verifies an email address. This action causes a confirmation email message to be sent to the specified address.

This action is throttled at one request per second.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PAWS::SES (3) 2015-08-06

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.