blib/lib/Paws/SES/SendTemplatedEmail.pm untested

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