File Coverage

blib/lib/Paws/SES/RecipientDsnFields.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::SES::RecipientDsnFields;
2 1     1   445 use Moose;
  1         4  
  1         8  
3             has Action => (is => 'ro', isa => 'Str', required => 1);
4             has DiagnosticCode => (is => 'ro', isa => 'Str');
5             has ExtensionFields => (is => 'ro', isa => 'ArrayRef[Paws::SES::ExtensionField]');
6             has FinalRecipient => (is => 'ro', isa => 'Str');
7             has LastAttemptDate => (is => 'ro', isa => 'Str');
8             has RemoteMta => (is => 'ro', isa => 'Str');
9             has Status => (is => 'ro', isa => 'Str', required => 1);
10             1;
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::SES::RecipientDsnFields
17              
18             =head1 USAGE
19              
20             This class represents one of two things:
21              
22             =head3 Arguments in a call to a service
23              
24             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25             Each attribute should be used as a named argument in the calls that expect this type of object.
26              
27             As an example, if Att1 is expected to be a Paws::SES::RecipientDsnFields object:
28              
29             $service_obj->Method(Att1 => { Action => $value, ..., Status => $value });
30              
31             =head3 Results returned from an API call
32              
33             Use accessors for each attribute. If Att1 is expected to be an Paws::SES::RecipientDsnFields object:
34              
35             $result = $service_obj->Method(...);
36             $result->Att1->Action
37              
38             =head1 DESCRIPTION
39              
40             Recipient-related information to include in the Delivery Status
41             Notification (DSN) when an email that Amazon SES receives on your
42             behalf bounces.
43              
44             For information about receiving email through Amazon SES, see the
45             Amazon SES Developer Guide.
46              
47             =head1 ATTRIBUTES
48              
49              
50             =head2 B<REQUIRED> Action => Str
51              
52             The action performed by the reporting mail transfer agent (MTA) as a
53             result of its attempt to deliver the message to the recipient address.
54             This is required by RFC 3464.
55              
56              
57             =head2 DiagnosticCode => Str
58              
59             An extended explanation of what went wrong; this is usually an SMTP
60             response. See RFC 3463 for the correct formatting of this parameter.
61              
62              
63             =head2 ExtensionFields => ArrayRef[L<Paws::SES::ExtensionField>]
64              
65             Additional X-headers to include in the DSN.
66              
67              
68             =head2 FinalRecipient => Str
69              
70             The email address that the message was ultimately delivered to. This
71             corresponds to the C<Final-Recipient> in the DSN. If not specified,
72             C<FinalRecipient> will be set to the C<Recipient> specified in the
73             C<BouncedRecipientInfo> structure. Either C<FinalRecipient> or the
74             recipient in C<BouncedRecipientInfo> must be a recipient of the
75             original bounced message.
76              
77             Do not prepend the C<FinalRecipient> email address with C<rfc 822;>, as
78             described in RFC 3798.
79              
80              
81             =head2 LastAttemptDate => Str
82              
83             The time the final delivery attempt was made, in RFC 822 date-time
84             format.
85              
86              
87             =head2 RemoteMta => Str
88              
89             The MTA to which the remote MTA attempted to deliver the message,
90             formatted as specified in RFC 3464 (C<mta-name-type; mta-name>). This
91             parameter typically applies only to propagating synchronous bounces.
92              
93              
94             =head2 B<REQUIRED> Status => Str
95              
96             The status code that indicates what went wrong. This is required by RFC
97             3464.
98              
99              
100              
101             =head1 SEE ALSO
102              
103             This class forms part of L<Paws>, describing an object used in L<Paws::SES>
104              
105             =head1 BUGS and CONTRIBUTIONS
106              
107             The source code is located here: https://github.com/pplu/aws-sdk-perl
108              
109             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
110              
111             =cut
112