File Coverage

blib/lib/Paws/SES/BounceAction.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::BounceAction;
2 1     1   851 use Moose;
  1         4  
  1         13  
3             has Message => (is => 'ro', isa => 'Str', required => 1);
4             has Sender => (is => 'ro', isa => 'Str', required => 1);
5             has SmtpReplyCode => (is => 'ro', isa => 'Str', required => 1);
6             has StatusCode => (is => 'ro', isa => 'Str');
7             has TopicArn => (is => 'ro', isa => 'Str');
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::SES::BounceAction
15              
16             =head1 USAGE
17              
18             This class represents one of two things:
19              
20             =head3 Arguments in a call to a service
21              
22             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23             Each attribute should be used as a named argument in the calls that expect this type of object.
24              
25             As an example, if Att1 is expected to be a Paws::SES::BounceAction object:
26              
27             $service_obj->Method(Att1 => { Message => $value, ..., TopicArn => $value });
28              
29             =head3 Results returned from an API call
30              
31             Use accessors for each attribute. If Att1 is expected to be an Paws::SES::BounceAction object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->Message
35              
36             =head1 DESCRIPTION
37              
38             When included in a receipt rule, this action rejects the received email
39             by returning a bounce response to the sender and, optionally, publishes
40             a notification to Amazon Simple Notification Service (Amazon SNS).
41              
42             For information about sending a bounce message in response to a
43             received email, see the Amazon SES Developer Guide.
44              
45             =head1 ATTRIBUTES
46              
47              
48             =head2 B<REQUIRED> Message => Str
49              
50             Human-readable text to include in the bounce message.
51              
52              
53             =head2 B<REQUIRED> Sender => Str
54              
55             The email address of the sender of the bounced email. This is the
56             address from which the bounce message will be sent.
57              
58              
59             =head2 B<REQUIRED> SmtpReplyCode => Str
60              
61             The SMTP reply code, as defined by RFC 5321.
62              
63              
64             =head2 StatusCode => Str
65              
66             The SMTP enhanced status code, as defined by RFC 3463.
67              
68              
69             =head2 TopicArn => Str
70              
71             The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when
72             the bounce action is taken. An example of an Amazon SNS topic ARN is
73             C<arn:aws:sns:us-west-2:123456789012:MyTopic>. For more information
74             about Amazon SNS topics, see the Amazon SNS Developer Guide.
75              
76              
77              
78             =head1 SEE ALSO
79              
80             This class forms part of L<Paws>, describing an object used in L<Paws::SES>
81              
82             =head1 BUGS and CONTRIBUTIONS
83              
84             The source code is located here: https://github.com/pplu/aws-sdk-perl
85              
86             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
87              
88             =cut
89