« blib/lib/Paws/SES/SetIdentityFeedbackForwardingEnabledResponse.pm
↑ Summary
blib/lib/Paws/SES/SetIdentityHeadersInNotificationsEnabledResponse.pm »
| 1 | |||
| 2 | package Paws::SES::SetIdentityHeadersInNotificationsEnabled; | ||
| 3 | use Moose; | ||
| 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 | use MooseX::ClassAttribute; | ||
| 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 L<Paws::SES> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method SetIdentityHeadersInNotificationsEnabled on the | ||
| 24 | L<Amazon Simple Email Service|Paws::SES> 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 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $email = Paws->service('SES'); | ||
| 32 | # SetIdentityHeadersInNotificationsEnabled | ||
| 33 | # The following example configures Amazon SES to include the original email | ||
| 34 | # headers in the Amazon SNS bounce notifications for an identity: | ||
| 35 | my $SetIdentityHeadersInNotificationsEnabledResponse = | ||
| 36 | $email->SetIdentityHeadersInNotificationsEnabled( | ||
| 37 | 'Enabled' => 1, | ||
| 38 | 'Identity' => 'user@example.com', | ||
| 39 | 'NotificationType' => 'Bounce' | ||
| 40 | ); | ||
| 41 | |||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/SetIdentityHeadersInNotificationsEnabled> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> Enabled => Bool | ||
| 50 | |||
| 51 | Sets whether Amazon SES includes the original email headers in Amazon | ||
| 52 | SNS notifications of the specified notification type. A value of | ||
| 53 | C<true> specifies that Amazon SES will include headers in | ||
| 54 | notifications, and a value of C<false> specifies that Amazon SES will | ||
| 55 | not include headers in notifications. | ||
| 56 | |||
| 57 | This value can only be set when C<NotificationType> is already set to | ||
| 58 | use a particular Amazon SNS topic. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> Identity => Str | ||
| 63 | |||
| 64 | The identity for which to enable or disable headers in notifications. | ||
| 65 | Examples: C<user@example.com>, C<example.com>. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> NotificationType => Str | ||
| 70 | |||
| 71 | The notification type for which to enable or disable headers in | ||
| 72 | notifications. | ||
| 73 | |||
| 74 | Valid values are: C<"Bounce">, C<"Complaint">, C<"Delivery"> | ||
| 75 | |||
| 76 | |||
| 77 | =head1 SEE ALSO | ||
| 78 | |||
| 79 | This class forms part of L<Paws>, documenting arguments for method SetIdentityHeadersInNotificationsEnabled in L<Paws::SES> | ||
| 80 | |||
| 81 | =head1 BUGS and CONTRIBUTIONS | ||
| 82 | |||
| 83 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 84 | |||
| 85 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 86 | |||
| 87 | =cut | ||
| 88 |