JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.simpleemail

Class AmazonSimpleEmailServiceClient

    • Constructor Detail

      • AmazonSimpleEmailServiceClient

        @Deprecated
public AmazonSimpleEmailServiceClient()
        Constructs a new client to invoke service methods on Amazon SES. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        See Also:
        DefaultAWSCredentialsProviderChain

      • AmazonSimpleEmailServiceClient

        @Deprecated
public AmazonSimpleEmailServiceClient(ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on Amazon SES. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        clientConfiguration - The client configuration options controlling how this client connects to Amazon SES (ex: proxy settings, retry counts, etc.).
        See Also:
        DefaultAWSCredentialsProviderChain

      • AmazonSimpleEmailServiceClient

        @Deprecated
public AmazonSimpleEmailServiceClient(AWSCredentials awsCredentials)
        Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonSimpleEmailServiceClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
        Constructs a new client to invoke service methods on Amazon SES using the specified AWS account credentials.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

      • AmazonSimpleEmailServiceClient

        @Deprecated
public AmazonSimpleEmailServiceClient(AWSCredentials awsCredentials,
 ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on Amazon SES using the specified AWS account credentials and client configuration options.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to Amazon SES (ex: proxy settings, retry counts, etc.).

      • AmazonSimpleEmailServiceClient

        @Deprecated
public AmazonSimpleEmailServiceClient(AWSCredentialsProvider awsCredentialsProvider)
        Constructs a new client to invoke service methods on Amazon SES using the specified AWS account credentials provider.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

      • AmazonSimpleEmailServiceClient

        @Deprecated
public AmazonSimpleEmailServiceClient(AWSCredentialsProvider awsCredentialsProvider,
 ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on Amazon SES using the specified AWS account credentials provider and client configuration options.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to Amazon SES (ex: proxy settings, retry counts, etc.).

    • Method Detail

      • cloneReceiptRuleSet

        public CloneReceiptRuleSetResult cloneReceiptRuleSet(CloneReceiptRuleSetRequest request)

        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.

        Specified by:
        cloneReceiptRuleSet in interface AmazonSimpleEmailService
        Parameters:
        cloneReceiptRuleSetRequest - Represents a request to create a receipt rule set by cloning an existing one. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the CloneReceiptRuleSet operation returned by the service.
        Throws:
        RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.
        AlreadyExistsException - Indicates that a resource could not be created because of a naming conflict.
        LimitExceededException - Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
        See Also:
        AWS API Documentation

        Samples:
        • CloneReceiptRuleSet
          The following example creates a receipt rule set by cloning an existing one:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
CloneReceiptRuleSetRequest request = new CloneReceiptRuleSetRequest().withRuleSetName("RuleSetToCreate").withOriginalRuleSetName("RuleSetToClone");
CloneReceiptRuleSetResult response = client.cloneReceiptRuleSet(request);

      • createReceiptFilter

        public CreateReceiptFilterResult createReceiptFilter(CreateReceiptFilterRequest request)

        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.

        Specified by:
        createReceiptFilter in interface AmazonSimpleEmailService
        Parameters:
        createReceiptFilterRequest - Represents a request to create a new IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the CreateReceiptFilter operation returned by the service.
        Throws:
        LimitExceededException - Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
        AlreadyExistsException - Indicates that a resource could not be created because of a naming conflict.
        See Also:
        AWS API Documentation

        Samples:
        • CreateReceiptFilter
          The following example creates a new IP address filter:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
CreateReceiptFilterRequest request = new CreateReceiptFilterRequest().withFilter(new ReceiptFilter().withName("MyFilter").withIpFilter(
 new ReceiptIpFilter().withPolicy("Allow").withCidr("1.2.3.4/24")));
CreateReceiptFilterResult response = client.createReceiptFilter(request);

      • createReceiptRule

        public CreateReceiptRuleResult createReceiptRule(CreateReceiptRuleRequest request)

        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.

        Specified by:
        createReceiptRule in interface AmazonSimpleEmailService
        Parameters:
        createReceiptRuleRequest - Represents a request to create a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the CreateReceiptRule operation returned by the service.
        Throws:
        InvalidSnsTopicException - Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
        InvalidS3ConfigurationException - Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
        InvalidLambdaFunctionException - Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
        AlreadyExistsException - Indicates that a resource could not be created because of a naming conflict.
        RuleDoesNotExistException - Indicates that the provided receipt rule does not exist.
        RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.
        LimitExceededException - Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
        See Also:
        AWS API Documentation

        Samples:
        • CreateReceiptRule
          The following example creates a new receipt rule:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
CreateReceiptRuleRequest request = new CreateReceiptRuleRequest()
 .withRuleSetName("MyRuleSet")
 .withAfter("")
 .withRule(
 new ReceiptRule().withName("MyRule").withEnabled(true).withTlsPolicy("Optional")
 .withActions(new ReceiptAction().withS3Action(new S3Action().withBucketName("MyBucket").withObjectKeyPrefix("email")))
 .withScanEnabled(true));
CreateReceiptRuleResult response = client.createReceiptRule(request);

      • createReceiptRuleSet

        public CreateReceiptRuleSetResult createReceiptRuleSet(CreateReceiptRuleSetRequest request)

        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.

        Specified by:
        createReceiptRuleSet in interface AmazonSimpleEmailService
        Parameters:
        createReceiptRuleSetRequest - Represents a request to create an empty receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the CreateReceiptRuleSet operation returned by the service.
        Throws:
        AlreadyExistsException - Indicates that a resource could not be created because of a naming conflict.
        LimitExceededException - Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
        See Also:
        AWS API Documentation

        Samples:
        • CreateReceiptRuleSet
          The following example creates an empty receipt rule set:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
CreateReceiptRuleSetRequest request = new CreateReceiptRuleSetRequest().withRuleSetName("MyRuleSet");
CreateReceiptRuleSetResult response = client.createReceiptRuleSet(request);

      • deleteIdentity

        public DeleteIdentityResult deleteIdentity(DeleteIdentityRequest request)

        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.

        Specified by:
        deleteIdentity in interface AmazonSimpleEmailService
        Parameters:
        deleteIdentityRequest - Represents a request to delete one of your Amazon SES identities (an email address or domain).
        Returns:
        Result of the DeleteIdentity operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • DeleteIdentity
          The following example deletes an identity from the list of identities that have been submitted for verification with Amazon SES:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
DeleteIdentityRequest request = new DeleteIdentityRequest().withIdentity("user@example.com");
DeleteIdentityResult response = client.deleteIdentity(request);

      • deleteIdentityPolicy

        public DeleteIdentityPolicyResult deleteIdentityPolicy(DeleteIdentityPolicyRequest request)

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

        This operation is for the identity owner only. If you have not verified the identity, it returns 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.

        Specified by:
        deleteIdentityPolicy in interface AmazonSimpleEmailService
        Parameters:
        deleteIdentityPolicyRequest - Represents a request to delete a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
        Returns:
        Result of the DeleteIdentityPolicy operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • DeleteIdentityPolicy
          The following example deletes a sending authorization policy for an identity:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
DeleteIdentityPolicyRequest request = new DeleteIdentityPolicyRequest().withIdentity("user@example.com").withPolicyName("MyPolicy");
DeleteIdentityPolicyResult response = client.deleteIdentityPolicy(request);

      • deleteReceiptFilter

        public DeleteReceiptFilterResult deleteReceiptFilter(DeleteReceiptFilterRequest request)

        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.

        Specified by:
        deleteReceiptFilter in interface AmazonSimpleEmailService
        Parameters:
        deleteReceiptFilterRequest - Represents a request to delete an IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the DeleteReceiptFilter operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • DeleteReceiptFilter
          The following example deletes an IP address filter:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
DeleteReceiptFilterRequest request = new DeleteReceiptFilterRequest().withFilterName("MyFilter");
DeleteReceiptFilterResult response = client.deleteReceiptFilter(request);

      • deleteReceiptRule

        public DeleteReceiptRuleResult deleteReceiptRule(DeleteReceiptRuleRequest request)

        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.

        Specified by:
        deleteReceiptRule in interface AmazonSimpleEmailService
        Parameters:
        deleteReceiptRuleRequest - Represents a request to delete a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the DeleteReceiptRule operation returned by the service.
        Throws:
        RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.
        See Also:
        AWS API Documentation

        Samples:
        • DeleteReceiptRule
          The following example deletes a receipt rule:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
DeleteReceiptRuleRequest request = new DeleteReceiptRuleRequest().withRuleSetName("MyRuleSet").withRuleName("MyRule");
DeleteReceiptRuleResult response = client.deleteReceiptRule(request);

      • deleteReceiptRuleSet

        public DeleteReceiptRuleSetResult deleteReceiptRuleSet(DeleteReceiptRuleSetRequest request)

        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.

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

        Specified by:
        deleteReceiptRuleSet in interface AmazonSimpleEmailService
        Parameters:
        deleteReceiptRuleSetRequest - Represents a request to delete a receipt rule set and all of the receipt rules it contains. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the DeleteReceiptRuleSet operation returned by the service.
        Throws:
        CannotDeleteException - Indicates that the delete operation could not be completed.
        See Also:
        AWS API Documentation

        Samples:
        • DeleteReceiptRuleSet
          The following example deletes a receipt rule set:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
DeleteReceiptRuleSetRequest request = new DeleteReceiptRuleSetRequest().withRuleSetName("MyRuleSet");
DeleteReceiptRuleSetResult response = client.deleteReceiptRuleSet(request);

      • deleteVerifiedEmailAddress

        public DeleteVerifiedEmailAddressResult deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest request)

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

        Specified by:
        deleteVerifiedEmailAddress in interface AmazonSimpleEmailService
        Parameters:
        deleteVerifiedEmailAddressRequest - Represents a request to delete an email address from the list of email addresses you have attempted to verify under your Amazon Web Services account.
        Returns:
        Result of the DeleteVerifiedEmailAddress operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • DeleteVerifiedEmailAddress
          The following example deletes an email address from the list of identities that have been submitted for verification with Amazon SES:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
DeleteVerifiedEmailAddressRequest request = new DeleteVerifiedEmailAddressRequest().withEmailAddress("user@example.com");
DeleteVerifiedEmailAddressResult response = client.deleteVerifiedEmailAddress(request);

      • describeActiveReceiptRuleSet

        public DescribeActiveReceiptRuleSetResult describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest request)

        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.

        Specified by:
        describeActiveReceiptRuleSet in interface AmazonSimpleEmailService
        Parameters:
        describeActiveReceiptRuleSetRequest - Represents a request to return the metadata and receipt rules for the receipt rule set that is currently active. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the DescribeActiveReceiptRuleSet operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • DescribeActiveReceiptRuleSet
          The following example returns the metadata and receipt rules for the receipt rule set that is currently active:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
DescribeActiveReceiptRuleSetRequest request = new DescribeActiveReceiptRuleSetRequest();
DescribeActiveReceiptRuleSetResult response = client.describeActiveReceiptRuleSet(request);

      • describeReceiptRule

        public DescribeReceiptRuleResult describeReceiptRule(DescribeReceiptRuleRequest request)

        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.

        Specified by:
        describeReceiptRule in interface AmazonSimpleEmailService
        Parameters:
        describeReceiptRuleRequest - Represents a request to return the details of a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the DescribeReceiptRule operation returned by the service.
        Throws:
        RuleDoesNotExistException - Indicates that the provided receipt rule does not exist.
        RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.
        See Also:
        AWS API Documentation

        Samples:
        • DescribeReceiptRule
          The following example returns the details of a receipt rule:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
DescribeReceiptRuleRequest request = new DescribeReceiptRuleRequest().withRuleSetName("MyRuleSet").withRuleName("MyRule");
DescribeReceiptRuleResult response = client.describeReceiptRule(request);

      • describeReceiptRuleSet

        public DescribeReceiptRuleSetResult describeReceiptRuleSet(DescribeReceiptRuleSetRequest request)

        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.

        Specified by:
        describeReceiptRuleSet in interface AmazonSimpleEmailService
        Parameters:
        describeReceiptRuleSetRequest - Represents a request to return the details of a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the DescribeReceiptRuleSet operation returned by the service.
        Throws:
        RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.
        See Also:
        AWS API Documentation

        Samples:
        • DescribeReceiptRuleSet
          The following example returns the metadata and receipt rules of a receipt rule set:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
DescribeReceiptRuleSetRequest request = new DescribeReceiptRuleSetRequest().withRuleSetName("MyRuleSet");
DescribeReceiptRuleSetResult response = client.describeReceiptRuleSet(request);

      • getAccountSendingEnabled

        public GetAccountSendingEnabledResult getAccountSendingEnabled(GetAccountSendingEnabledRequest request)

        Returns the email sending status of the Amazon SES account for the current Region.

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

        Specified by:
        getAccountSendingEnabled in interface AmazonSimpleEmailService
        Parameters:
        getAccountSendingEnabledRequest -
        Returns:
        Result of the GetAccountSendingEnabled operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • GetAccountSendingEnabled
          The following example returns if sending status for an account is enabled. (true / false):
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
GetAccountSendingEnabledRequest request = new GetAccountSendingEnabledRequest();
GetAccountSendingEnabledResult response = client.getAccountSendingEnabled(request);

      • getIdentityDkimAttributes

        public GetIdentityDkimAttributesResult getIdentityDkimAttributes(GetIdentityDkimAttributesRequest request)

        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.

        Specified by:
        getIdentityDkimAttributes in interface AmazonSimpleEmailService
        Parameters:
        getIdentityDkimAttributesRequest - Represents a request for the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this request also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published. For more information about Easy DKIM, see the Amazon SES Developer Guide.
        Returns:
        Result of the GetIdentityDkimAttributes operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • GetIdentityDkimAttributes
          The following example retrieves the Amazon SES Easy DKIM attributes for a list of identities:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
GetIdentityDkimAttributesRequest request = new GetIdentityDkimAttributesRequest().withIdentities("example.com", "user@example.com");
GetIdentityDkimAttributesResult response = client.getIdentityDkimAttributes(request);

      • getIdentityMailFromDomainAttributes

        public GetIdentityMailFromDomainAttributesResult getIdentityMailFromDomainAttributes(GetIdentityMailFromDomainAttributesRequest request)

        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.

        Specified by:
        getIdentityMailFromDomainAttributes in interface AmazonSimpleEmailService
        Parameters:
        getIdentityMailFromDomainAttributesRequest - Represents a request to return the Amazon SES custom MAIL FROM attributes for a list of identities. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.
        Returns:
        Result of the GetIdentityMailFromDomainAttributes operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • GetIdentityMailFromDomainAttributes
          The following example returns the custom MAIL FROM attributes for an identity:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
GetIdentityMailFromDomainAttributesRequest request = new GetIdentityMailFromDomainAttributesRequest().withIdentities("example.com");
GetIdentityMailFromDomainAttributesResult response = client.getIdentityMailFromDomainAttributes(request);

      • getIdentityNotificationAttributes

        public GetIdentityNotificationAttributesResult getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest request)

        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.

        Specified by:
        getIdentityNotificationAttributes in interface AmazonSimpleEmailService
        Parameters:
        getIdentityNotificationAttributesRequest - Represents a request to return the notification attributes for a list of identities you verified with Amazon SES. For information about Amazon SES notifications, see the Amazon SES Developer Guide.
        Returns:
        Result of the GetIdentityNotificationAttributes operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • GetIdentityNotificationAttributes
          The following example returns the notification attributes for an identity:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
GetIdentityNotificationAttributesRequest request = new GetIdentityNotificationAttributesRequest().withIdentities("example.com");
GetIdentityNotificationAttributesResult response = client.getIdentityNotificationAttributes(request);

      • getIdentityPolicies

        public GetIdentityPoliciesResult getIdentityPolicies(GetIdentityPoliciesRequest request)

        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.

        This operation is for the identity owner only. If you have not verified the identity, it returns 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.

        Specified by:
        getIdentityPolicies in interface AmazonSimpleEmailService
        Parameters:
        getIdentityPoliciesRequest - Represents a request to return the requested sending authorization policies for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
        Returns:
        Result of the GetIdentityPolicies operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • GetIdentityPolicies
          The following example returns a sending authorization policy for an identity:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
GetIdentityPoliciesRequest request = new GetIdentityPoliciesRequest().withIdentity("example.com").withPolicyNames("MyPolicy");
GetIdentityPoliciesResult response = client.getIdentityPolicies(request);

      • getIdentityVerificationAttributes

        public GetIdentityVerificationAttributesResult getIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest request)

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

        Specified by:
        getIdentityVerificationAttributes in interface AmazonSimpleEmailService
        Parameters:
        getIdentityVerificationAttributesRequest - Represents a request to return the Amazon SES verification status of a list of identities. For domain identities, this request also returns the verification token. For information about verifying identities with Amazon SES, see the Amazon SES Developer Guide.
        Returns:
        Result of the GetIdentityVerificationAttributes operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • GetIdentityVerificationAttributes
          The following example returns the verification status and the verification token for a domain identity:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
GetIdentityVerificationAttributesRequest request = new GetIdentityVerificationAttributesRequest().withIdentities("example.com");
GetIdentityVerificationAttributesResult response = client.getIdentityVerificationAttributes(request);

      • getSendQuota

        public GetSendQuotaResult getSendQuota(GetSendQuotaRequest request)

        Provides the sending limits for the Amazon SES account.

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

        Specified by:
        getSendQuota in interface AmazonSimpleEmailService
        Parameters:
        getSendQuotaRequest -
        Returns:
        Result of the GetSendQuota operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • GetSendQuota
          The following example returns the Amazon SES sending limits for an AWS account:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
GetSendQuotaRequest request = new GetSendQuotaRequest();
GetSendQuotaResult response = client.getSendQuota(request);

      • getSendStatistics

        public GetSendStatisticsResult getSendStatistics(GetSendStatisticsRequest request)

        Provides sending statistics for the current Amazon Web Services Region. 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.

        Specified by:
        getSendStatistics in interface AmazonSimpleEmailService
        Parameters:
        getSendStatisticsRequest -
        Returns:
        Result of the GetSendStatistics operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • GetSendStatistics
          The following example returns Amazon SES sending statistics:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
GetSendStatisticsRequest request = new GetSendStatisticsRequest();
GetSendStatisticsResult response = client.getSendStatistics(request);

      • listConfigurationSets

        public ListConfigurationSetsResult listConfigurationSets(ListConfigurationSetsRequest request)

        Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region. 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 returns 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 also returns NextToken. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.

        Specified by:
        listConfigurationSets in interface AmazonSimpleEmailService
        Parameters:
        listConfigurationSetsRequest - Represents a request to list the configuration sets associated with your Amazon Web Services account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
        Returns:
        Result of the ListConfigurationSets operation returned by the service.
        See Also:
        AWS API Documentation

      • listIdentities

        public ListIdentitiesResult listIdentities(ListIdentitiesRequest request)

        Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status.

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

        It's recommended that for successive pagination calls of this API, you continue to the use the same parameter/value pairs as used in the original call, e.g., if you used IdentityType=Domain in the the original call and received a NextToken in the response, you should continue providing the IdentityType=Domain parameter for further NextToken calls; however, if you didn't provide the IdentityType parameter in the original call, then continue to not provide it for successive pagination calls. Using this protocol will ensure consistent results.

        Specified by:
        listIdentities in interface AmazonSimpleEmailService
        Parameters:
        listIdentitiesRequest - Represents a request to return a list of all identities (email addresses and domains) that you have attempted to verify under your Amazon Web Services account, regardless of verification status.
        Returns:
        Result of the ListIdentities operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • ListIdentities
          The following example lists the email address identities that have been submitted for verification with Amazon SES:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
ListIdentitiesRequest request = new ListIdentitiesRequest().withIdentityType("EmailAddress").withNextToken("").withMaxItems(123);
ListIdentitiesResult response = client.listIdentities(request);

      • listIdentityPolicies

        public ListIdentityPoliciesResult listIdentityPolicies(ListIdentityPoliciesRequest request)

        Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This operation returns only a list. To get the actual policy content, use GetIdentityPolicies.

        This operation is for the identity owner only. If you have not verified the identity, it returns 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.

        Specified by:
        listIdentityPolicies in interface AmazonSimpleEmailService
        Parameters:
        listIdentityPoliciesRequest - Represents a request to return a list of sending authorization policies that are attached to an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
        Returns:
        Result of the ListIdentityPolicies operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • ListIdentityPolicies
          The following example returns a list of sending authorization policies that are attached to an identity:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
ListIdentityPoliciesRequest request = new ListIdentityPoliciesRequest().withIdentity("example.com");
ListIdentityPoliciesResult response = client.listIdentityPolicies(request);

      • listReceiptFilters

        public ListReceiptFiltersResult listReceiptFilters(ListReceiptFiltersRequest request)

        Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region.

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

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

        Specified by:
        listReceiptFilters in interface AmazonSimpleEmailService
        Parameters:
        listReceiptFiltersRequest - Represents a request to list the IP address filters that exist under your Amazon Web Services account. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the ListReceiptFilters operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • ListReceiptFilters
          The following example lists the IP address filters that are associated with an AWS account:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
ListReceiptFiltersRequest request = new ListReceiptFiltersRequest();
ListReceiptFiltersResult response = client.listReceiptFilters(request);

      • listReceiptRuleSets

        public ListReceiptRuleSetsResult listReceiptRuleSets(ListReceiptRuleSetsRequest request)

        Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region. If there are additional receipt rule sets to be retrieved, you 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.

        Specified by:
        listReceiptRuleSets in interface AmazonSimpleEmailService
        Parameters:
        listReceiptRuleSetsRequest - Represents a request to list the receipt rule sets that exist under your Amazon Web Services account. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the ListReceiptRuleSets operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • ListReceiptRuleSets
          The following example lists the receipt rule sets that exist under an AWS account:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
ListReceiptRuleSetsRequest request = new ListReceiptRuleSetsRequest().withNextToken("");
ListReceiptRuleSetsResult response = client.listReceiptRuleSets(request);

      • listVerifiedEmailAddresses

        public ListVerifiedEmailAddressesResult listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest request)

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

        Specified by:
        listVerifiedEmailAddresses in interface AmazonSimpleEmailService
        Parameters:
        listVerifiedEmailAddressesRequest -
        Returns:
        Result of the ListVerifiedEmailAddresses operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • ListVerifiedEmailAddresses
          The following example lists all email addresses that have been submitted for verification with Amazon SES:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
ListVerifiedEmailAddressesRequest request = new ListVerifiedEmailAddressesRequest();
ListVerifiedEmailAddressesResult response = client.listVerifiedEmailAddresses(request);

      • putIdentityPolicy

        public PutIdentityPolicyResult putIdentityPolicy(PutIdentityPolicyRequest request)

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

        This operation is for the identity owner only. If you have not verified the identity, it returns 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.

        Specified by:
        putIdentityPolicy in interface AmazonSimpleEmailService
        Parameters:
        putIdentityPolicyRequest - Represents a request to add or update a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
        Returns:
        Result of the PutIdentityPolicy operation returned by the service.
        Throws:
        InvalidPolicyException - Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error.
        See Also:
        AWS API Documentation

        Samples:
        • PutIdentityPolicy
          The following example adds a sending authorization policy to an identity:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
PutIdentityPolicyRequest request = new PutIdentityPolicyRequest()
 .withIdentity("example.com")
 .withPolicyName("MyPolicy")
 .withPolicy(
 "{\"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\"}]}");
PutIdentityPolicyResult response = client.putIdentityPolicy(request);

      • reorderReceiptRuleSet

        public ReorderReceiptRuleSetResult reorderReceiptRuleSet(ReorderReceiptRuleSetRequest request)

        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, it is 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.

        Specified by:
        reorderReceiptRuleSet in interface AmazonSimpleEmailService
        Parameters:
        reorderReceiptRuleSetRequest - Represents a request to reorder the receipt rules within a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the ReorderReceiptRuleSet operation returned by the service.
        Throws:
        RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.
        RuleDoesNotExistException - Indicates that the provided receipt rule does not exist.
        See Also:
        AWS API Documentation

        Samples:
        • ReorderReceiptRuleSet
          The following example reorders the receipt rules within a receipt rule set:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
ReorderReceiptRuleSetRequest request = new ReorderReceiptRuleSetRequest().withRuleSetName("MyRuleSet").withRuleNames("MyRule", "MyOtherRule");
ReorderReceiptRuleSetResult response = client.reorderReceiptRuleSet(request);

      • sendBounce

        public SendBounceResult sendBounce(SendBounceRequest request)

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

        You cannot use this operation 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.

        Specified by:
        sendBounce in interface AmazonSimpleEmailService
        Parameters:
        sendBounceRequest - Represents a request to send a bounce message to the sender of an email you received through Amazon SES.
        Returns:
        Result of the SendBounce operation returned by the service.
        Throws:
        MessageRejectedException - Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
        See Also:
        AWS API Documentation

      • sendBulkTemplatedEmail

        public SendBulkTemplatedEmailResult sendBulkTemplatedEmail(SendBulkTemplatedEmailRequest request)

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

        To send email using this operation, your call must meet the following requirements:

        • The call must refer to an existing email template. You can create email templates using CreateTemplate.

        • The message must be sent from a verified email address or domain.

        • If your account is still in the Amazon SES sandbox, you may send only 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 maximum message size is 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 is 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 SendBulkTemplatedEmail operation several times to send the message to each group.

        • The number of destinations you can contact in a single call can be limited by your account's maximum sending rate.

        Specified by:
        sendBulkTemplatedEmail in interface AmazonSimpleEmailService
        Parameters:
        sendBulkTemplatedEmailRequest - Represents a request to send a templated email to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the SendBulkTemplatedEmail operation returned by the service.
        Throws:
        MessageRejectedException - Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
        MailFromDomainNotVerifiedException - Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.
        ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.
        TemplateDoesNotExistException - Indicates that the Template object you specified does not exist in your Amazon SES account.
        ConfigurationSetSendingPausedException - Indicates that email sending is disabled for the configuration set.

        You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.

        AccountSendingPausedException - Indicates that email sending is disabled for your entire Amazon SES account.

        You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.

        See Also:
        AWS API Documentation

      • sendEmail

        public SendEmailResult sendEmail(SendEmailRequest request)

        Composes an email message and immediately queues it for sending. To send email using this 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 results 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 maximum message size is 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 is 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.

        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.

        Specified by:
        sendEmail in interface AmazonSimpleEmailService
        Parameters:
        sendEmailRequest - Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the SendEmail operation returned by the service.
        Throws:
        MessageRejectedException - Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
        MailFromDomainNotVerifiedException - Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.
        ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.
        ConfigurationSetSendingPausedException - Indicates that email sending is disabled for the configuration set.

        You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.

        AccountSendingPausedException - Indicates that email sending is disabled for your entire Amazon SES account.

        You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.

        See Also:
        AWS API Documentation

        Samples:
        • SendEmail
          The following example sends a formatted email:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SendEmailRequest request = new SendEmailRequest()
 .withSource("sender@example.com")
 .withDestination(
 new Destination().withToAddresses("recipient1@example.com", "recipient2@example.com").withCcAddresses("recipient3@example.com")
 .withBccAddresses(new ArrayList()))
 .withMessage(
 new Message()
 .withSubject(new Content().withData("Test email").withCharset("UTF-8"))
 .withBody(
 new Body()
 .withText(new Content().withData("This is the message body in text format.").withCharset("UTF-8"))
 .withHtml(
 new Content()
 .withData(
 "This message body contains HTML formatting. It can, for example, contain links like this one: Amazon SES Developer Guide.")
 .withCharset("UTF-8")))).withReplyToAddresses(new ArrayList()).withReturnPath("")
 .withSourceArn("").withReturnPathArn("");
SendEmailResult response = client.sendEmail(request);

      • sendRawEmail

        public SendRawEmailResult sendRawEmail(SendRawEmailRequest request)

        Composes an email message and immediately queues it for sending.

        This operation is more flexible than the SendEmail operation. When you use the SendRawEmail operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you need to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments.

        The SendRawEmail operation has the following requirements:

        • You can only send email from verified email addresses or domains. If you try to send email from an address that isn't verified, the operation results in an "Email address not verified" error.

        • If your account is still in the Amazon SES sandbox, you can only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox simulator.

        • The maximum message size, including attachments, is 10 MB.

        • Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines.

        • If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a valid format (that is, it's not in the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even if the other addresses are valid.

        • Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group.

        • Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn't preserved. For this reason, we highly recommend that you encode all content that isn't 7-bit ASCII. For more information, see MIME Encoding 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 automatically applies its own Message-ID and Date headers; if you passed these headers when creating the message, they are 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, 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

          Don't include these X-headers in the DKIM signature. Amazon SES removes these before it sends the email.

          If you only specify the SourceIdentityArn parameter, Amazon SES sets the From and Return-Path addresses to the same identity that you specified.

          For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide.

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

        Specified by:
        sendRawEmail in interface AmazonSimpleEmailService
        Parameters:
        sendRawEmailRequest - Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the SendRawEmail operation returned by the service.
        Throws:
        MessageRejectedException - Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
        MailFromDomainNotVerifiedException - Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.
        ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.
        ConfigurationSetSendingPausedException - Indicates that email sending is disabled for the configuration set.

        You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.

        AccountSendingPausedException - Indicates that email sending is disabled for your entire Amazon SES account.

        You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.

        See Also:
        AWS API Documentation

        Samples:
        • SendRawEmail
          The following example sends an email with an attachment:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SendRawEmailRequest request = new SendRawEmailRequest()
 .withSource("")
 .withDestinations(new ArrayList())
 .withRawMessage(
 new RawMessage().withData(ByteBuffer
 .wrap("From: sender@example.com\\nTo: recipient@example.com\\nSubject: Test email (contains an attachment)\\nMIME-Version: 1.0\\nContent-type: Multipart/Mixed; boundary=\"NextPart\"\\n\\n--NextPart\\nContent-Type: text/plain\\n\\nThis is the message body.\\n\\n--NextPart\\nContent-Type: text/plain;\\nContent-Disposition: attachment; filename=\"attachment.txt\"\\n\\nThis is the text in the attachment.\\n\\n--NextPart--"
 .getBytes()))).withFromArn("").withSourceArn("").withReturnPathArn("");
SendRawEmailResult response = client.sendRawEmail(request);

      • sendTemplatedEmail

        public SendTemplatedEmailResult sendTemplatedEmail(SendTemplatedEmailRequest request)

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

        To send email using this operation, your call 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 maximum message size is 10 MB.

        • Calls to the SendTemplatedEmail operation may only include one Destination parameter. A destination is a set of recipients that receives 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 is rejected, even if the message contains other recipients that are valid.

        If your call to the SendTemplatedEmail operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email.

        For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.

        Specified by:
        sendTemplatedEmail in interface AmazonSimpleEmailService
        Parameters:
        sendTemplatedEmailRequest - Represents a request to send a templated email using Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the SendTemplatedEmail operation returned by the service.
        Throws:
        MessageRejectedException - Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
        MailFromDomainNotVerifiedException - Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.
        ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.
        TemplateDoesNotExistException - Indicates that the Template object you specified does not exist in your Amazon SES account.
        ConfigurationSetSendingPausedException - Indicates that email sending is disabled for the configuration set.

        You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.

        AccountSendingPausedException - Indicates that email sending is disabled for your entire Amazon SES account.

        You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.

        See Also:
        AWS API Documentation

      • setActiveReceiptRuleSet

        public SetActiveReceiptRuleSetResult setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest request)

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

        Specified by:
        setActiveReceiptRuleSet in interface AmazonSimpleEmailService
        Parameters:
        setActiveReceiptRuleSetRequest - Represents a request to set a receipt rule set as the active receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the SetActiveReceiptRuleSet operation returned by the service.
        Throws:
        RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.
        See Also:
        AWS API Documentation

        Samples:
        • SetActiveReceiptRuleSet
          The following example sets the active receipt rule set:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SetActiveReceiptRuleSetRequest request = new SetActiveReceiptRuleSetRequest().withRuleSetName("RuleSetToActivate");
SetActiveReceiptRuleSetResult response = client.setActiveReceiptRuleSet(request);

      • setIdentityDkimEnabled

        public SetIdentityDkimEnabledResult setIdentityDkimEnabled(SetIdentityDkimEnabledRequest request)

        Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address.

        For email addresses (for example, user@example.com), you can only enable DKIM signing if the corresponding domain (in this case, example.com) has been set up to use Easy DKIM.

        You can enable DKIM signing for an identity at any time after you start the verification process for the identity, even if the verification process isn't complete.

        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.

        Specified by:
        setIdentityDkimEnabled in interface AmazonSimpleEmailService
        Parameters:
        setIdentityDkimEnabledRequest - Represents a request to enable or disable Amazon SES Easy DKIM signing for an identity. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.
        Returns:
        Result of the SetIdentityDkimEnabled operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • SetIdentityDkimEnabled
          The following example configures Amazon SES to Easy DKIM-sign the email sent from an identity:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SetIdentityDkimEnabledRequest request = new SetIdentityDkimEnabledRequest().withIdentity("user@example.com").withDkimEnabled(true);
SetIdentityDkimEnabledResult response = client.setIdentityDkimEnabled(request);

      • setIdentityFeedbackForwardingEnabled

        public SetIdentityFeedbackForwardingEnabledResult setIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest request)

        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.

        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.

        Specified by:
        setIdentityFeedbackForwardingEnabled in interface AmazonSimpleEmailService
        Parameters:
        setIdentityFeedbackForwardingEnabledRequest - Represents a request to enable or disable whether Amazon SES forwards you bounce and complaint notifications through email. For information about email feedback forwarding, see the Amazon SES Developer Guide.
        Returns:
        Result of the SetIdentityFeedbackForwardingEnabled operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • SetIdentityFeedbackForwardingEnabled
          The following example configures Amazon SES to forward an identity's bounces and complaints via email:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SetIdentityFeedbackForwardingEnabledRequest request = new SetIdentityFeedbackForwardingEnabledRequest().withIdentity("user@example.com")
 .withForwardingEnabled(true);
SetIdentityFeedbackForwardingEnabledResult response = client.setIdentityFeedbackForwardingEnabled(request);

      • setIdentityHeadersInNotificationsEnabled

        public SetIdentityHeadersInNotificationsEnabledResult setIdentityHeadersInNotificationsEnabled(SetIdentityHeadersInNotificationsEnabledRequest request)

        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.

        Specified by:
        setIdentityHeadersInNotificationsEnabled in interface AmazonSimpleEmailService
        Parameters:
        setIdentityHeadersInNotificationsEnabledRequest - Represents a request to set whether Amazon SES includes the original email headers in the Amazon SNS notifications of a specified type. For information about notifications, see the Amazon SES Developer Guide.
        Returns:
        Result of the SetIdentityHeadersInNotificationsEnabled operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • SetIdentityHeadersInNotificationsEnabled
          The following example configures Amazon SES to include the original email headers in the Amazon SNS bounce notifications for an identity:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SetIdentityHeadersInNotificationsEnabledRequest request = new SetIdentityHeadersInNotificationsEnabledRequest().withIdentity("user@example.com")
 .withNotificationType("Bounce").withEnabled(true);
SetIdentityHeadersInNotificationsEnabledResult response = client.setIdentityHeadersInNotificationsEnabled(request);

      • setIdentityMailFromDomain

        public SetIdentityMailFromDomainResult setIdentityMailFromDomain(SetIdentityMailFromDomainRequest request)

        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. To ensure that your emails 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.

        Specified by:
        setIdentityMailFromDomain in interface AmazonSimpleEmailService
        Parameters:
        setIdentityMailFromDomainRequest - Represents a request to enable or disable the Amazon SES custom MAIL FROM domain setup for a verified identity. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.
        Returns:
        Result of the SetIdentityMailFromDomain operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • SetIdentityMailFromDomain
          The following example configures Amazon SES to use a custom MAIL FROM domain for an identity:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SetIdentityMailFromDomainRequest request = new SetIdentityMailFromDomainRequest().withIdentity("user@example.com")
 .withMailFromDomain("bounces.example.com").withBehaviorOnMXFailure("UseDefaultValue");
SetIdentityMailFromDomainResult response = client.setIdentityMailFromDomain(request);

      • setIdentityNotificationTopic

        public SetIdentityNotificationTopicResult setIdentityNotificationTopic(SetIdentityNotificationTopicRequest request)

        Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify.

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

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

        Specified by:
        setIdentityNotificationTopic in interface AmazonSimpleEmailService
        Parameters:
        setIdentityNotificationTopicRequest - Represents a request to specify the Amazon SNS topic to which Amazon SES publishes bounce, complaint, or delivery notifications for emails sent with that identity as the source. For information about Amazon SES notifications, see the Amazon SES Developer Guide.
        Returns:
        Result of the SetIdentityNotificationTopic operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • 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:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SetIdentityNotificationTopicRequest request = new SetIdentityNotificationTopicRequest().withIdentity("user@example.com").withNotificationType("Bounce")
 .withSnsTopic("arn:aws:sns:us-west-2:111122223333:MyTopic");
SetIdentityNotificationTopicResult response = client.setIdentityNotificationTopic(request);

      • setReceiptRulePosition

        public SetReceiptRulePositionResult setReceiptRulePosition(SetReceiptRulePositionRequest request)

        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.

        Specified by:
        setReceiptRulePosition in interface AmazonSimpleEmailService
        Parameters:
        setReceiptRulePositionRequest - Represents a request to set the position of a receipt rule in a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the SetReceiptRulePosition operation returned by the service.
        Throws:
        RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.
        RuleDoesNotExistException - Indicates that the provided receipt rule does not exist.
        See Also:
        AWS API Documentation

        Samples:
        • SetReceiptRulePosition
          The following example sets the position of a receipt rule in a receipt rule set:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
SetReceiptRulePositionRequest request = new SetReceiptRulePositionRequest().withRuleSetName("MyRuleSet").withRuleName("RuleToReposition")
 .withAfter("PutRuleAfterThisRule");
SetReceiptRulePositionResult response = client.setReceiptRulePosition(request);

      • testRenderTemplate

        public TestRenderTemplateResult testRenderTemplate(TestRenderTemplateRequest request)

        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.

        Specified by:
        testRenderTemplate in interface AmazonSimpleEmailService
        Parameters:
        testRenderTemplateRequest -
        Returns:
        Result of the TestRenderTemplate operation returned by the service.
        Throws:
        TemplateDoesNotExistException - Indicates that the Template object you specified does not exist in your Amazon SES account.
        InvalidRenderingParameterException - Indicates that one or more of the replacement values you provided is invalid. This error may occur when the TemplateData object contains invalid JSON.
        MissingRenderingAttributeException - Indicates that one or more of the replacement values for the specified template was not specified. Ensure that the TemplateData object contains references to all of the replacement tags in the specified template.
        See Also:
        AWS API Documentation

      • updateAccountSendingEnabled

        public UpdateAccountSendingEnabledResult updateAccountSendingEnabled(UpdateAccountSendingEnabledRequest request)

        Enables or disables email sending across your entire Amazon SES account in the current Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given Amazon Web Services Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds.

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

        Specified by:
        updateAccountSendingEnabled in interface AmazonSimpleEmailService
        Parameters:
        updateAccountSendingEnabledRequest - Represents a request to enable or disable the email sending capabilities for your entire Amazon SES account.
        Returns:
        Result of the UpdateAccountSendingEnabled operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • UpdateAccountSendingEnabled
          The following example updated the sending status for this account.
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
UpdateAccountSendingEnabledRequest request = new UpdateAccountSendingEnabledRequest().withEnabled(true);
UpdateAccountSendingEnabledResult response = client.updateAccountSendingEnabled(request);

      • updateConfigurationSetReputationMetricsEnabled

        public UpdateConfigurationSetReputationMetricsEnabledResult updateConfigurationSetReputationMetricsEnabled(UpdateConfigurationSetReputationMetricsEnabledRequest request)

        Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds.

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

        Specified by:
        updateConfigurationSetReputationMetricsEnabled in interface AmazonSimpleEmailService
        Parameters:
        updateConfigurationSetReputationMetricsEnabledRequest - Represents a request to modify the reputation metric publishing settings for a configuration set.
        Returns:
        Result of the UpdateConfigurationSetReputationMetricsEnabled operation returned by the service.
        Throws:
        ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.
        See Also:
        AWS API Documentation

        Samples:
        • UpdateConfigurationSetReputationMetricsEnabled
          Set the reputationMetricsEnabled flag for a specific configuration set.
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
UpdateConfigurationSetReputationMetricsEnabledRequest request = new UpdateConfigurationSetReputationMetricsEnabledRequest().withConfigurationSetName(
 "foo").withEnabled(true);
UpdateConfigurationSetReputationMetricsEnabledResult response = client.updateConfigurationSetReputationMetricsEnabled(request);

      • updateConfigurationSetSendingEnabled

        public UpdateConfigurationSetSendingEnabledResult updateConfigurationSetSendingEnabled(UpdateConfigurationSetSendingEnabledRequest request)

        Enables or disables email sending for messages sent using a specific configuration set in a given Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds.

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

        Specified by:
        updateConfigurationSetSendingEnabled in interface AmazonSimpleEmailService
        Parameters:
        updateConfigurationSetSendingEnabledRequest - Represents a request to enable or disable the email sending capabilities for a specific configuration set.
        Returns:
        Result of the UpdateConfigurationSetSendingEnabled operation returned by the service.
        Throws:
        ConfigurationSetDoesNotExistException - Indicates that the configuration set does not exist.
        See Also:
        AWS API Documentation

        Samples:
        • UpdateConfigurationSetReputationMetricsEnabled
          Set the sending enabled flag for a specific configuration set.
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
UpdateConfigurationSetSendingEnabledRequest request = new UpdateConfigurationSetSendingEnabledRequest().withConfigurationSetName("foo").withEnabled(
 true);
UpdateConfigurationSetSendingEnabledResult response = client.updateConfigurationSetSendingEnabled(request);

      • updateReceiptRule

        public UpdateReceiptRuleResult updateReceiptRule(UpdateReceiptRuleRequest request)

        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.

        Specified by:
        updateReceiptRule in interface AmazonSimpleEmailService
        Parameters:
        updateReceiptRuleRequest - Represents a request to update a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
        Returns:
        Result of the UpdateReceiptRule operation returned by the service.
        Throws:
        InvalidSnsTopicException - Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
        InvalidS3ConfigurationException - Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
        InvalidLambdaFunctionException - Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.
        RuleSetDoesNotExistException - Indicates that the provided receipt rule set does not exist.
        RuleDoesNotExistException - Indicates that the provided receipt rule does not exist.
        LimitExceededException - Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.
        See Also:
        AWS API Documentation

        Samples:
        • UpdateReceiptRule
          The following example updates a receipt rule to use an Amazon S3 action:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
UpdateReceiptRuleRequest request = new UpdateReceiptRuleRequest().withRuleSetName("MyRuleSet").withRule(
 new ReceiptRule().withName("MyRule").withEnabled(true).withTlsPolicy("Optional")
 .withActions(new ReceiptAction().withS3Action(new S3Action().withBucketName("MyBucket").withObjectKeyPrefix("email")))
 .withScanEnabled(true));
UpdateReceiptRuleResult response = client.updateReceiptRule(request);

      • verifyDomainDkim

        public VerifyDomainDkimResult verifyDomainDkim(VerifyDomainDkimRequest request)

        Returns a set of DKIM tokens for a domain identity.

        When you execute the VerifyDomainDkim operation, the domain that you specify is added to the list of identities that are associated with your account. This is true even if you haven't already associated the domain with your account by using the VerifyDomainIdentity operation. However, you can't send email from the domain until you either successfully verify it or you successfully set up DKIM for it.

        You use the tokens that are generated by this operation to create CNAME records. When Amazon SES detects that you've added these records to the DNS configuration for a domain, you can start sending email from that domain. You can start sending email even if you haven't added the TXT record provided by the VerifyDomainIdentity operation to the DNS configuration for your domain. All email that you send from the domain is authenticated using DKIM.

        To create the CNAME records for DKIM authentication, use the following values:

        • Name: token._domainkey.example.com

        • Type: CNAME

        • Value: token.dkim.amazonses.com

        In the preceding example, replace token with one of the tokens that are generated when you execute this operation. Replace example.com with your domain. Repeat this process for each token that's generated by this operation.

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

        Specified by:
        verifyDomainDkim in interface AmazonSimpleEmailService
        Parameters:
        verifyDomainDkimRequest - Represents a request to generate the CNAME records needed to set up Easy DKIM with Amazon SES. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.
        Returns:
        Result of the VerifyDomainDkim operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • VerifyDomainDkim
          The following example generates DKIM tokens for a domain that has been verified with Amazon SES:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
VerifyDomainDkimRequest request = new VerifyDomainDkimRequest().withDomain("example.com");
VerifyDomainDkimResult response = client.verifyDomainDkim(request);

      • verifyDomainIdentity

        public VerifyDomainIdentityResult verifyDomainIdentity(VerifyDomainIdentityRequest request)

        Adds a domain to the list of identities for your Amazon SES account in the current Amazon Web Services Region 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.

        Specified by:
        verifyDomainIdentity in interface AmazonSimpleEmailService
        Parameters:
        verifyDomainIdentityRequest - Represents a request to begin Amazon SES domain verification and to generate the TXT records that you must publish to the DNS server of your domain to complete the verification. For information about domain verification, see the Amazon SES Developer Guide.
        Returns:
        Result of the VerifyDomainIdentity operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • VerifyDomainIdentity
          The following example starts the domain verification process with Amazon SES:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
VerifyDomainIdentityRequest request = new VerifyDomainIdentityRequest().withDomain("example.com");
VerifyDomainIdentityResult response = client.verifyDomainIdentity(request);

      • verifyEmailAddress

        public VerifyEmailAddressResult verifyEmailAddress(VerifyEmailAddressRequest request)

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

        Specified by:
        verifyEmailAddress in interface AmazonSimpleEmailService
        Parameters:
        verifyEmailAddressRequest - Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.
        Returns:
        Result of the VerifyEmailAddress operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • VerifyEmailAddress
          The following example starts the email address verification process with Amazon SES:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
VerifyEmailAddressRequest request = new VerifyEmailAddressRequest().withEmailAddress("user@example.com");
VerifyEmailAddressResult response = client.verifyEmailAddress(request);

      • verifyEmailIdentity

        public VerifyEmailIdentityResult verifyEmailIdentity(VerifyEmailIdentityRequest request)

        Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address.

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

        Specified by:
        verifyEmailIdentity in interface AmazonSimpleEmailService
        Parameters:
        verifyEmailIdentityRequest - Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.
        Returns:
        Result of the VerifyEmailIdentity operation returned by the service.
        See Also:
        AWS API Documentation

        Samples:
        • VerifyEmailIdentity
          The following example starts the email address verification process with Amazon SES:
          AmazonSimpleEmailService client = AmazonSimpleEmailServiceClientBuilder.standard().build();
VerifyEmailIdentityRequest request = new VerifyEmailIdentityRequest().withEmailAddress("user@example.com");
VerifyEmailIdentityResult response = client.verifyEmailIdentity(request);

      • getCachedResponseMetadata

        public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

        Specified by:
        getCachedResponseMetadata in interface AmazonSimpleEmailService
        Parameters:
        request - The originally executed request
        Returns:
        The response metadata for the specified request, or null if none is available.
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /