File Coverage

blib/lib/Paws/SES/SetIdentityHeadersInNotificationsEnabled.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              
2             package Paws::SES::SetIdentityHeadersInNotificationsEnabled;
3 1     1   328 use Moose;
  1         4  
  1         7  
4             has Enabled => (is => 'ro', isa => 'Bool', required => 1);
5             has Identity => (is => 'ro', isa => 'Str', required => 1);
6             has NotificationType => (is => 'ro', isa => 'Str', required => 1);
7              
8 1     1   5516 use MooseX::ClassAttribute;
  1         4  
  1         7  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'SetIdentityHeadersInNotificationsEnabled');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SES::SetIdentityHeadersInNotificationsEnabledResponse');
12             class_has _result_key => (isa => 'Str', is => 'ro', default => 'SetIdentityHeadersInNotificationsEnabledResult');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::SES::SetIdentityHeadersInNotificationsEnabled - Arguments for method SetIdentityHeadersInNotificationsEnabled on Paws::SES
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method SetIdentityHeadersInNotificationsEnabled on the
24             Amazon Simple Email Service service. Use the attributes of this class
25             as arguments to method SetIdentityHeadersInNotificationsEnabled.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SetIdentityHeadersInNotificationsEnabled.
28              
29             As an example:
30              
31             $service_obj->SetIdentityHeadersInNotificationsEnabled(Att1 => $value1, Att2 => $value2, ...);
32              
33             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.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 B<REQUIRED> Enabled => Bool
39              
40             Sets whether Amazon SES includes the original email headers in Amazon
41             SNS notifications of the specified notification type. A value of
42             C<true> specifies that Amazon SES will include headers in
43             notifications, and a value of C<false> specifies that Amazon SES will
44             not include headers in notifications.
45              
46             This value can only be set when C<NotificationType> is already set to
47             use a particular Amazon SNS topic.
48              
49              
50              
51             =head2 B<REQUIRED> Identity => Str
52              
53             The identity for which to enable or disable headers in notifications.
54             Examples: C<user@example.com>, C<example.com>.
55              
56              
57              
58             =head2 B<REQUIRED> NotificationType => Str
59              
60             The notification type for which to enable or disable headers in
61             notifications.
62              
63             Valid values are: C<"Bounce">, C<"Complaint">, C<"Delivery">
64              
65              
66             =head1 SEE ALSO
67              
68             This class forms part of L<Paws>, documenting arguments for method SetIdentityHeadersInNotificationsEnabled in L<Paws::SES>
69              
70             =head1 BUGS and CONTRIBUTIONS
71              
72             The source code is located here: https://github.com/pplu/aws-sdk-perl
73              
74             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
75              
76             =cut
77