File Coverage

blib/lib/Paws/SES/IdentityNotificationAttributes.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1             package Paws::SES::IdentityNotificationAttributes;
2 1     1   334 use Moose;
  1     1   4  
  1         7  
  1         479  
  1         2  
  1         6  
3             has BounceTopic => (is => 'ro', isa => 'Str');
4             has ComplaintTopic => (is => 'ro', isa => 'Str');
5             has DeliveryTopic => (is => 'ro', isa => 'Str');
6             has ForwardingEnabled => (is => 'ro', isa => 'Bool', required => 1);
7             has HeadersInBounceNotificationsEnabled => (is => 'ro', isa => 'Bool');
8             has HeadersInComplaintNotificationsEnabled => (is => 'ro', isa => 'Bool');
9             has HeadersInDeliveryNotificationsEnabled => (is => 'ro', isa => 'Bool');
10             1;
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::SES::IdentityNotificationAttributes
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::IdentityNotificationAttributes object:
28              
29             $service_obj->Method(Att1 => { BounceTopic => $value, ..., HeadersInDeliveryNotificationsEnabled => $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::IdentityNotificationAttributes object:
34              
35             $result = $service_obj->Method(...);
36             $result->Att1->BounceTopic
37              
38             =head1 DESCRIPTION
39              
40             Represents the notification attributes of an identity, including
41             whether an identity has Amazon Simple Notification Service (Amazon SNS)
42             topics set for bounce, complaint, and/or delivery notifications, and
43             whether feedback forwarding is enabled for bounce and complaint
44             notifications.
45              
46             =head1 ATTRIBUTES
47              
48              
49             =head2 BounceTopic => Str
50              
51             The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES
52             will publish bounce notifications.
53              
54              
55             =head2 ComplaintTopic => Str
56              
57             The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES
58             will publish complaint notifications.
59              
60              
61             =head2 DeliveryTopic => Str
62              
63             The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES
64             will publish delivery notifications.
65              
66              
67             =head2 B<REQUIRED> ForwardingEnabled => Bool
68              
69             Describes whether Amazon SES will forward bounce and complaint
70             notifications as email. C<true> indicates that Amazon SES will forward
71             bounce and complaint notifications as email, while C<false> indicates
72             that bounce and complaint notifications will be published only to the
73             specified bounce and complaint Amazon SNS topics.
74              
75              
76             =head2 HeadersInBounceNotificationsEnabled => Bool
77              
78             Describes whether Amazon SES includes the original email headers in
79             Amazon SNS notifications of type C<Bounce>. A value of C<true>
80             specifies that Amazon SES will include headers in bounce notifications,
81             and a value of C<false> specifies that Amazon SES will not include
82             headers in bounce notifications.
83              
84              
85             =head2 HeadersInComplaintNotificationsEnabled => Bool
86              
87             Describes whether Amazon SES includes the original email headers in
88             Amazon SNS notifications of type C<Complaint>. A value of C<true>
89             specifies that Amazon SES will include headers in complaint
90             notifications, and a value of C<false> specifies that Amazon SES will
91             not include headers in complaint notifications.
92              
93              
94             =head2 HeadersInDeliveryNotificationsEnabled => Bool
95              
96             Describes whether Amazon SES includes the original email headers in
97             Amazon SNS notifications of type C<Delivery>. A value of C<true>
98             specifies that Amazon SES will include headers in delivery
99             notifications, and a value of C<false> specifies that Amazon SES will
100             not include headers in delivery notifications.
101              
102              
103              
104             =head1 SEE ALSO
105              
106             This class forms part of L<Paws>, describing an object used in L<Paws::SES>
107              
108             =head1 BUGS and CONTRIBUTIONS
109              
110             The source code is located here: https://github.com/pplu/aws-sdk-perl
111              
112             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
113              
114             =cut
115