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

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SES::SendBounce;
3 use Moose;
4 has BouncedRecipientInfoList => (is => 'ro', isa => 'ArrayRef[Paws::SES::BouncedRecipientInfo]', required => 1);
5 has BounceSender => (is => 'ro', isa => 'Str', required => 1);
6 has BounceSenderArn => (is => 'ro', isa => 'Str');
7 has Explanation => (is => 'ro', isa => 'Str');
8 has MessageDsn => (is => 'ro', isa => 'Paws::SES::MessageDsn');
9 has OriginalMessageId => (is => 'ro', isa => 'Str', required => 1);
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'SendBounce');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SES::SendBounceResponse');
15 class_has _result_key => (isa => 'Str', is => 'ro', default => 'SendBounceResult');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::SES::SendBounce - Arguments for method SendBounce on L<Paws::SES>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method SendBounce on the
27 L<Amazon Simple Email Service|Paws::SES> service. Use the attributes of this class
28 as arguments to method SendBounce.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendBounce.
31  
32 =head1 SYNOPSIS
33  
34 my $email = Paws->service('SES');
35 my $SendBounceResponse = $email->SendBounce(
36 BounceSender => 'MyAddress',
37 BouncedRecipientInfoList => [
38 {
39 Recipient => 'MyAddress',
40 BounceType => 'DoesNotExist'
41 , # values: DoesNotExist, MessageTooLarge, ExceededQuota, ContentRejected, Undefined, TemporaryFailure; OPTIONAL
42 RecipientArn => 'MyAmazonResourceName', # OPTIONAL
43 RecipientDsnFields => {
44 Action =>
45 'failed', # values: failed, delayed, delivered, relayed, expanded
46 Status => 'MyDsnStatus',
47 DiagnosticCode => 'MyDiagnosticCode', # OPTIONAL
48 ExtensionFields => [
49 {
50 Name => 'MyExtensionFieldName',
51 Value => 'MyExtensionFieldValue',
52  
53 },
54 ...
55 ], # OPTIONAL
56 FinalRecipient => 'MyAddress',
57 LastAttemptDate => '1970-01-01T01:00:00', # OPTIONAL
58 RemoteMta => 'MyRemoteMta', # OPTIONAL
59 }, # OPTIONAL
60 },
61 ...
62 ],
63 OriginalMessageId => 'MyMessageId',
64 BounceSenderArn => 'MyAmazonResourceName', # OPTIONAL
65 Explanation => 'MyExplanation', # OPTIONAL
66 MessageDsn => {
67 ReportingMta => 'MyReportingMta',
68 ArrivalDate => '1970-01-01T01:00:00', # OPTIONAL
69 ExtensionFields => [
70 {
71 Name => 'MyExtensionFieldName',
72 Value => 'MyExtensionFieldValue',
73  
74 },
75 ...
76 ], # OPTIONAL
77 }, # OPTIONAL
78 );
79  
80 # Results:
81 my $MessageId = $SendBounceResponse->MessageId;
82  
83 # Returns a L<Paws::SES::SendBounceResponse> object.
84  
85 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.
86 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/SendBounce>
87  
88 =head1 ATTRIBUTES
89  
90  
91 =head2 B<REQUIRED> BouncedRecipientInfoList => ArrayRef[L<Paws::SES::BouncedRecipientInfo>]
92  
93 A list of recipients of the bounced message, including the information
94 required to create the Delivery Status Notifications (DSNs) for the
95 recipients. You must specify at least one C<BouncedRecipientInfo> in
96 the list.
97  
98  
99  
100 =head2 B<REQUIRED> BounceSender => Str
101  
102 The address to use in the "From" header of the bounce message. This
103 must be an identity that you have verified with Amazon SES.
104  
105  
106  
107 =head2 BounceSenderArn => Str
108  
109 This parameter is used only for sending authorization. It is the ARN of
110 the identity that is associated with the sending authorization policy
111 that permits you to use the address in the "From" header of the bounce.
112 For more information about sending authorization, see the Amazon SES
113 Developer Guide
114 (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html).
115  
116  
117  
118 =head2 Explanation => Str
119  
120 Human-readable text for the bounce message to explain the failure. If
121 not specified, the text will be auto-generated based on the bounced
122 recipient information.
123  
124  
125  
126 =head2 MessageDsn => L<Paws::SES::MessageDsn>
127  
128 Message-related DSN fields. If not specified, Amazon SES will choose
129 the values.
130  
131  
132  
133 =head2 B<REQUIRED> OriginalMessageId => Str
134  
135 The message ID of the message to be bounced.
136  
137  
138  
139  
140 =head1 SEE ALSO
141  
142 This class forms part of L<Paws>, documenting arguments for method SendBounce in L<Paws::SES>
143  
144 =head1 BUGS and CONTRIBUTIONS
145  
146 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
147  
148 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
149  
150 =cut
151