« blib/lib/Paws/SES/SendBounceResponse.pm
↑ Summary
blib/lib/Paws/SES/SendBulkTemplatedEmailResponse.pm »
| 1 | |||
| 2 | package Paws::SES::SendBulkTemplatedEmail; | ||
| 3 | use Moose; | ||
| 4 | has ConfigurationSetName => (is => 'ro', isa => 'Str'); | ||
| 5 | has DefaultTags => (is => 'ro', isa => 'ArrayRef[Paws::SES::MessageTag]'); | ||
| 6 | has DefaultTemplateData => (is => 'ro', isa => 'Str'); | ||
| 7 | has Destinations => (is => 'ro', isa => 'ArrayRef[Paws::SES::BulkEmailDestination]', required => 1); | ||
| 8 | has ReplyToAddresses => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 9 | has ReturnPath => (is => 'ro', isa => 'Str'); | ||
| 10 | has ReturnPathArn => (is => 'ro', isa => 'Str'); | ||
| 11 | has Source => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has SourceArn => (is => 'ro', isa => 'Str'); | ||
| 13 | has Template => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | has TemplateArn => (is => 'ro', isa => 'Str'); | ||
| 15 | |||
| 16 | use MooseX::ClassAttribute; | ||
| 17 | |||
| 18 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SendBulkTemplatedEmail'); | ||
| 19 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SES::SendBulkTemplatedEmailResponse'); | ||
| 20 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'SendBulkTemplatedEmailResult'); | ||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::SES::SendBulkTemplatedEmail - Arguments for method SendBulkTemplatedEmail on L<Paws::SES> | ||
| 28 | |||
| 29 | =head1 DESCRIPTION | ||
| 30 | |||
| 31 | This class represents the parameters used for calling the method SendBulkTemplatedEmail on the | ||
| 32 | L<Amazon Simple Email Service|Paws::SES> service. Use the attributes of this class | ||
| 33 | as arguments to method SendBulkTemplatedEmail. | ||
| 34 | |||
| 35 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendBulkTemplatedEmail. | ||
| 36 | |||
| 37 | =head1 SYNOPSIS | ||
| 38 | |||
| 39 | my $email = Paws->service('SES'); | ||
| 40 | my $SendBulkTemplatedEmailResponse = $email->SendBulkTemplatedEmail( | ||
| 41 | Destinations => [ | ||
| 42 | { | ||
| 43 | Destination => { | ||
| 44 | BccAddresses => [ 'MyAddress', ... ], # OPTIONAL | ||
| 45 | CcAddresses => [ 'MyAddress', ... ], # OPTIONAL | ||
| 46 | ToAddresses => [ 'MyAddress', ... ], # OPTIONAL | ||
| 47 | }, | ||
| 48 | ReplacementTags => [ | ||
| 49 | { | ||
| 50 | Name => 'MyMessageTagName', | ||
| 51 | Value => 'MyMessageTagValue', | ||
| 52 | |||
| 53 | }, | ||
| 54 | ... | ||
| 55 | ], # OPTIONAL | ||
| 56 | ReplacementTemplateData => 'MyTemplateData', # max: 262144; OPTIONAL | ||
| 57 | }, | ||
| 58 | ... | ||
| 59 | ], | ||
| 60 | Source => 'MyAddress', | ||
| 61 | Template => 'MyTemplateName', | ||
| 62 | ConfigurationSetName => 'MyConfigurationSetName', # OPTIONAL | ||
| 63 | DefaultTags => [ | ||
| 64 | { | ||
| 65 | Name => 'MyMessageTagName', | ||
| 66 | Value => 'MyMessageTagValue', | ||
| 67 | |||
| 68 | }, | ||
| 69 | ... | ||
| 70 | ], # OPTIONAL | ||
| 71 | DefaultTemplateData => 'MyTemplateData', # OPTIONAL | ||
| 72 | ReplyToAddresses => [ 'MyAddress', ... ], # OPTIONAL | ||
| 73 | ReturnPath => 'MyAddress', # OPTIONAL | ||
| 74 | ReturnPathArn => 'MyAmazonResourceName', # OPTIONAL | ||
| 75 | SourceArn => 'MyAmazonResourceName', # OPTIONAL | ||
| 76 | TemplateArn => 'MyAmazonResourceName', # OPTIONAL | ||
| 77 | ); | ||
| 78 | |||
| 79 | # Results: | ||
| 80 | my $Status = $SendBulkTemplatedEmailResponse->Status; | ||
| 81 | |||
| 82 | # Returns a L<Paws::SES::SendBulkTemplatedEmailResponse> object. | ||
| 83 | |||
| 84 | 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. | ||
| 85 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/SendBulkTemplatedEmail> | ||
| 86 | |||
| 87 | =head1 ATTRIBUTES | ||
| 88 | |||
| 89 | |||
| 90 | =head2 ConfigurationSetName => Str | ||
| 91 | |||
| 92 | The name of the configuration set to use when you send an email using | ||
| 93 | C<SendBulkTemplatedEmail>. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 DefaultTags => ArrayRef[L<Paws::SES::MessageTag>] | ||
| 98 | |||
| 99 | A list of tags, in the form of name/value pairs, to apply to an email | ||
| 100 | that you send to a destination using C<SendBulkTemplatedEmail>. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 DefaultTemplateData => Str | ||
| 105 | |||
| 106 | A list of replacement values to apply to the template when replacement | ||
| 107 | data is not specified in a Destination object. These values act as a | ||
| 108 | default or fallback option when no other data is available. | ||
| 109 | |||
| 110 | The template data is a JSON object, typically consisting of key-value | ||
| 111 | pairs in which the keys correspond to replacement tags in the email | ||
| 112 | template. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> Destinations => ArrayRef[L<Paws::SES::BulkEmailDestination>] | ||
| 117 | |||
| 118 | One or more C<Destination> objects. All of the recipients in a | ||
| 119 | C<Destination> will receive the same version of the email. You can | ||
| 120 | specify up to 50 C<Destination> objects within a C<Destinations> array. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 ReplyToAddresses => ArrayRef[Str|Undef] | ||
| 125 | |||
| 126 | The reply-to email address(es) for the message. If the recipient | ||
| 127 | replies to the message, each reply-to address will receive the reply. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head2 ReturnPath => Str | ||
| 132 | |||
| 133 | The email address that bounces and complaints will be forwarded to when | ||
| 134 | feedback forwarding is enabled. If the message cannot be delivered to | ||
| 135 | the recipient, then an error message will be returned from the | ||
| 136 | recipient's ISP; this message will then be forwarded to the email | ||
| 137 | address specified by the C<ReturnPath> parameter. The C<ReturnPath> | ||
| 138 | parameter is never overwritten. This email address must be either | ||
| 139 | individually verified with Amazon SES, or from a domain that has been | ||
| 140 | verified with Amazon SES. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head2 ReturnPathArn => Str | ||
| 145 | |||
| 146 | This parameter is used only for sending authorization. It is the ARN of | ||
| 147 | the identity that is associated with the sending authorization policy | ||
| 148 | that permits you to use the email address specified in the | ||
| 149 | C<ReturnPath> parameter. | ||
| 150 | |||
| 151 | For example, if the owner of C<example.com> (which has ARN | ||
| 152 | C<arn:aws:ses:us-east-1:123456789012:identity/example.com>) attaches a | ||
| 153 | policy to it that authorizes you to use C<feedback@example.com>, then | ||
| 154 | you would specify the C<ReturnPathArn> to be | ||
| 155 | C<arn:aws:ses:us-east-1:123456789012:identity/example.com>, and the | ||
| 156 | C<ReturnPath> to be C<feedback@example.com>. | ||
| 157 | |||
| 158 | For more information about sending authorization, see the Amazon SES | ||
| 159 | Developer Guide | ||
| 160 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). | ||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | =head2 B<REQUIRED> Source => Str | ||
| 165 | |||
| 166 | The email address that is sending the email. This email address must be | ||
| 167 | either individually verified with Amazon SES, or from a domain that has | ||
| 168 | been verified with Amazon SES. For information about verifying | ||
| 169 | identities, see the Amazon SES Developer Guide | ||
| 170 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html). | ||
| 171 | |||
| 172 | If you are sending on behalf of another user and have been permitted to | ||
| 173 | do so by a sending authorization policy, then you must also specify the | ||
| 174 | C<SourceArn> parameter. For more information about sending | ||
| 175 | authorization, see the Amazon SES Developer Guide | ||
| 176 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). | ||
| 177 | |||
| 178 | Amazon SES does not support the SMTPUTF8 extension, as described in | ||
| 179 | RFC6531 (https://tools.ietf.org/html/rfc6531). For this reason, the | ||
| 180 | I<local part> of a source email address (the part of the email address | ||
| 181 | that precedes the @ sign) may only contain 7-bit ASCII characters | ||
| 182 | (https://en.wikipedia.org/wiki/Email_address#Local-part). If the | ||
| 183 | I<domain part> of an address (the part after the @ sign) contains | ||
| 184 | non-ASCII characters, they must be encoded using Punycode, as described | ||
| 185 | in RFC3492 (https://tools.ietf.org/html/rfc3492.html). The sender name | ||
| 186 | (also known as the I<friendly name>) may contain non-ASCII characters. | ||
| 187 | These characters must be encoded using MIME encoded-word syntax, as | ||
| 188 | described in RFC 2047 (https://tools.ietf.org/html/rfc2047). MIME | ||
| 189 | encoded-word syntax uses the following form: | ||
| 190 | C<=?charset?encoding?encoded-text?=>. | ||
| 191 | |||
| 192 | |||
| 193 | |||
| 194 | =head2 SourceArn => Str | ||
| 195 | |||
| 196 | This parameter is used only for sending authorization. It is the ARN of | ||
| 197 | the identity that is associated with the sending authorization policy | ||
| 198 | that permits you to send for the email address specified in the | ||
| 199 | C<Source> parameter. | ||
| 200 | |||
| 201 | For example, if the owner of C<example.com> (which has ARN | ||
| 202 | C<arn:aws:ses:us-east-1:123456789012:identity/example.com>) attaches a | ||
| 203 | policy to it that authorizes you to send from C<user@example.com>, then | ||
| 204 | you would specify the C<SourceArn> to be | ||
| 205 | C<arn:aws:ses:us-east-1:123456789012:identity/example.com>, and the | ||
| 206 | C<Source> to be C<user@example.com>. | ||
| 207 | |||
| 208 | For more information about sending authorization, see the Amazon SES | ||
| 209 | Developer Guide | ||
| 210 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). | ||
| 211 | |||
| 212 | |||
| 213 | |||
| 214 | =head2 B<REQUIRED> Template => Str | ||
| 215 | |||
| 216 | The template to use when sending this email. | ||
| 217 | |||
| 218 | |||
| 219 | |||
| 220 | =head2 TemplateArn => Str | ||
| 221 | |||
| 222 | The ARN of the template to use when sending this email. | ||
| 223 | |||
| 224 | |||
| 225 | |||
| 226 | |||
| 227 | =head1 SEE ALSO | ||
| 228 | |||
| 229 | This class forms part of L<Paws>, documenting arguments for method SendBulkTemplatedEmail in L<Paws::SES> | ||
| 230 | |||
| 231 | =head1 BUGS and CONTRIBUTIONS | ||
| 232 | |||
| 233 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 234 | |||
| 235 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 236 | |||
| 237 | =cut | ||
| 238 |