blib/lib/Paws/SESv2/SendBulkEmail.pm untested

filter: Statementstmt 0.0% 0 / 19 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 21 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SESv2::SendBulkEmail;
3 use Moose;
4 has BulkEmailEntries => (is => 'ro', isa => 'ArrayRef[Paws::SESv2::BulkEmailEntry]', required => 1);
5 has ConfigurationSetName => (is => 'ro', isa => 'Str');
6 has DefaultContent => (is => 'ro', isa => 'Paws::SESv2::BulkEmailContent', required => 1);
7 has DefaultEmailTags => (is => 'ro', isa => 'ArrayRef[Paws::SESv2::MessageTag]');
8 has FeedbackForwardingEmailAddress => (is => 'ro', isa => 'Str');
9 has FeedbackForwardingEmailAddressIdentityArn => (is => 'ro', isa => 'Str');
10 has FromEmailAddress => (is => 'ro', isa => 'Str');
11 has FromEmailAddressIdentityArn => (is => 'ro', isa => 'Str');
12 has ReplyToAddresses => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
13  
14 use MooseX::ClassAttribute;
15  
16 class_has _api_call => (isa => 'Str', is => 'ro', default => 'SendBulkEmail');
17 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v2/email/outbound-bulk-emails');
18 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
19 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SESv2::SendBulkEmailResponse');
20 1;
21  
22 ### main pod documentation begin ###
23  
24 =head1 NAME
25  
26 Paws::SESv2::SendBulkEmail - Arguments for method SendBulkEmail on L<Paws::SESv2>
27  
28 =head1 DESCRIPTION
29  
30 This class represents the parameters used for calling the method SendBulkEmail on the
31 L<Amazon Simple Email Service|Paws::SESv2> service. Use the attributes of this class
32 as arguments to method SendBulkEmail.
33  
34 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendBulkEmail.
35  
36 =head1 SYNOPSIS
37  
38 my $email = Paws->service('SESv2');
39 my $SendBulkEmailResponse = $email->SendBulkEmail(
40 BulkEmailEntries => [
41 {
42 Destination => {
43 BccAddresses => [ 'MyEmailAddress', ... ], # OPTIONAL
44 CcAddresses => [ 'MyEmailAddress', ... ], # OPTIONAL
45 ToAddresses => [ 'MyEmailAddress', ... ], # OPTIONAL
46 },
47 ReplacementEmailContent => {
48 ReplacementTemplate => {
49 ReplacementTemplateData =>
50 'MyEmailTemplateData', # max: 262144; OPTIONAL
51 }, # OPTIONAL
52 }, # OPTIONAL
53 ReplacementTags => [
54 {
55 Name => 'MyMessageTagName',
56 Value => 'MyMessageTagValue',
57  
58 },
59 ...
60 ], # OPTIONAL
61 },
62 ...
63 ],
64 DefaultContent => {
65 Template => {
66 TemplateArn => 'MyAmazonResourceName', # OPTIONAL
67 TemplateData => 'MyEmailTemplateData', # max: 262144; OPTIONAL
68 TemplateName => 'MyEmailTemplateName', # min: 1; OPTIONAL
69 }, # OPTIONAL
70 },
71 ConfigurationSetName => 'MyConfigurationSetName', # OPTIONAL
72 DefaultEmailTags => [
73 {
74 Name => 'MyMessageTagName',
75 Value => 'MyMessageTagValue',
76  
77 },
78 ...
79 ], # OPTIONAL
80 FeedbackForwardingEmailAddress => 'MyEmailAddress', # OPTIONAL
81 FeedbackForwardingEmailAddressIdentityArn =>
82 'MyAmazonResourceName', # OPTIONAL
83 FromEmailAddress => 'MyEmailAddress', # OPTIONAL
84 FromEmailAddressIdentityArn => 'MyAmazonResourceName', # OPTIONAL
85 ReplyToAddresses => [ 'MyEmailAddress', ... ], # OPTIONAL
86 );
87  
88 # Results:
89 my $BulkEmailEntryResults = $SendBulkEmailResponse->BulkEmailEntryResults;
90  
91 # Returns a L<Paws::SESv2::SendBulkEmailResponse> object.
92  
93 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.
94 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/SendBulkEmail>
95  
96 =head1 ATTRIBUTES
97  
98  
99 =head2 B<REQUIRED> BulkEmailEntries => ArrayRef[L<Paws::SESv2::BulkEmailEntry>]
100  
101 The list of bulk email entry objects.
102  
103  
104  
105 =head2 ConfigurationSetName => Str
106  
107 The name of the configuration set that you want to use when sending the
108 email.
109  
110  
111  
112 =head2 B<REQUIRED> DefaultContent => L<Paws::SESv2::BulkEmailContent>
113  
114 An object that contains the body of the message. You can specify a
115 template message.
116  
117  
118  
119 =head2 DefaultEmailTags => ArrayRef[L<Paws::SESv2::MessageTag>]
120  
121 A list of tags, in the form of name/value pairs, to apply to an email
122 that you send using the C<SendEmail> operation. Tags correspond to
123 characteristics of the email that you define, so that you can publish
124 email sending events.
125  
126  
127  
128 =head2 FeedbackForwardingEmailAddress => Str
129  
130 The address that you want bounce and complaint notifications to be sent
131 to.
132  
133  
134  
135 =head2 FeedbackForwardingEmailAddressIdentityArn => Str
136  
137 This parameter is used only for sending authorization. It is the ARN of
138 the identity that is associated with the sending authorization policy
139 that permits you to use the email address specified in the
140 C<FeedbackForwardingEmailAddress> parameter.
141  
142 For example, if the owner of example.com (which has ARN
143 arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
144 policy to it that authorizes you to use feedback@example.com, then you
145 would specify the C<FeedbackForwardingEmailAddressIdentityArn> to be
146 arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
147 C<FeedbackForwardingEmailAddress> to be feedback@example.com.
148  
149 For more information about sending authorization, see the Amazon SES
150 Developer Guide
151 (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html).
152  
153  
154  
155 =head2 FromEmailAddress => Str
156  
157 The email address that you want to use as the "From" address for the
158 email. The address that you specify has to be verified.
159  
160  
161  
162 =head2 FromEmailAddressIdentityArn => Str
163  
164 This parameter is used only for sending authorization. It is the ARN of
165 the identity that is associated with the sending authorization policy
166 that permits you to use the email address specified in the
167 C<FromEmailAddress> parameter.
168  
169 For example, if the owner of example.com (which has ARN
170 arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
171 policy to it that authorizes you to use sender@example.com, then you
172 would specify the C<FromEmailAddressIdentityArn> to be
173 arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
174 C<FromEmailAddress> to be sender@example.com.
175  
176 For more information about sending authorization, see the Amazon SES
177 Developer Guide
178 (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html).
179  
180  
181  
182 =head2 ReplyToAddresses => ArrayRef[Str|Undef]
183  
184 The "Reply-to" email addresses for the message. When the recipient
185 replies to the message, each Reply-to address receives the reply.
186  
187  
188  
189  
190 =head1 SEE ALSO
191  
192 This class forms part of L<Paws>, documenting arguments for method SendBulkEmail in L<Paws::SESv2>
193  
194 =head1 BUGS and CONTRIBUTIONS
195  
196 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
197  
198 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
199  
200 =cut
201