NAME

Paws::SES::SendBulkTemplatedEmail - Arguments for method SendBulkTemplatedEmail on Paws::SES

DESCRIPTION

This class represents the parameters used for calling the method SendBulkTemplatedEmail on the Amazon Simple Email Service service. Use the attributes of this class as arguments to method SendBulkTemplatedEmail.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendBulkTemplatedEmail.

SYNOPSIS

    my $email = Paws->service('SES');
    my $SendBulkTemplatedEmailResponse = $email->SendBulkTemplatedEmail(
      Destinations => [
        {
          Destination => {
            BccAddresses => [ 'MyAddress', ... ],    # OPTIONAL
            CcAddresses  => [ 'MyAddress', ... ],    # OPTIONAL
            ToAddresses  => [ 'MyAddress', ... ],    # OPTIONAL
          },
          ReplacementTags => [
            {
              Name  => 'MyMessageTagName',
              Value => 'MyMessageTagValue',
            },
            ...
          ],    # OPTIONAL
          ReplacementTemplateData => 'MyTemplateData',   # max: 262144; OPTIONAL
        },
        ...
      ],
      Source               => 'MyAddress',
      Template             => 'MyTemplateName',
      ConfigurationSetName => 'MyConfigurationSetName',    # OPTIONAL
      DefaultTags          => [
        {
          Name  => 'MyMessageTagName',
          Value => 'MyMessageTagValue',
        },
        ...
      ],                                                   # OPTIONAL
      DefaultTemplateData => 'MyTemplateData',             # OPTIONAL
      ReplyToAddresses    => [ 'MyAddress', ... ],         # OPTIONAL
      ReturnPath          => 'MyAddress',                  # OPTIONAL
      ReturnPathArn       => 'MyAmazonResourceName',       # OPTIONAL
      SourceArn           => 'MyAmazonResourceName',       # OPTIONAL
      TemplateArn         => 'MyAmazonResourceName',       # OPTIONAL
    );
    # Results:
    my $Status = $SendBulkTemplatedEmailResponse->Status;
    # Returns a L<Paws::SES::SendBulkTemplatedEmailResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/email/SendBulkTemplatedEmail>

ATTRIBUTES

ConfigurationSetName => Str

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

DefaultTags => ArrayRef[Paws::SES::MessageTag]

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

DefaultTemplateData => Str

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

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

REQUIRED Destinations => ArrayRef[Paws::SES::BulkEmailDestination]

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

ReplyToAddresses => ArrayRef[Str|Undef]

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

ReturnPath => Str

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the "ReturnPath" parameter. The "ReturnPath" parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

ReturnPathArn => Str

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the "ReturnPath" parameter.

For example, if the owner of "example.com" (which has ARN "arn:aws:ses:us-east-1:123456789012:identity/example.com") attaches a policy to it that authorizes you to use "feedback@example.com", then you would specify the "ReturnPathArn" to be "arn:aws:ses:us-east-1:123456789012:identity/example.com", and the "ReturnPath" to be "feedback@example.com".

For more information about sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html).

REQUIRED Source => Str

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html).

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the "SourceArn" parameter. For more information about sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html).

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 (https://tools.ietf.org/html/rfc6531). For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters (https://en.wikipedia.org/wiki/Email_address#Local-part). If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492 (https://tools.ietf.org/html/rfc3492.html). The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047 (https://tools.ietf.org/html/rfc2047). MIME encoded-word syntax uses the following form: "=?charset?encoding?encoded-text?=".

SourceArn => Str

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the "Source" parameter.

For example, if the owner of "example.com" (which has ARN "arn:aws:ses:us-east-1:123456789012:identity/example.com") attaches a policy to it that authorizes you to send from "user@example.com", then you would specify the "SourceArn" to be "arn:aws:ses:us-east-1:123456789012:identity/example.com", and the "Source" to be "user@example.com".

For more information about sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html).

REQUIRED Template => Str

The template to use when sending this email.

TemplateArn => Str

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

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>