| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SES::BounceAction; | ||
| 3 | use Moose; | ||
| 4 | has Message => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Sender => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has SmtpReplyCode => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has StatusCode => (is => 'ro', isa => 'Str'); | ||
| 8 | has TopicArn => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::SES::BounceAction | ||
| 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::BounceAction object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { Message => $value, ..., TopicArn => $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::BounceAction object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->Message | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | When included in a receipt rule, this action rejects the received email | ||
| 41 | by returning a bounce response to the sender and, optionally, publishes | ||
| 42 | a notification to Amazon Simple Notification Service (Amazon SNS). | ||
| 43 | |||
| 44 | For information about sending a bounce message in response to a | ||
| 45 | received email, see the Amazon SES Developer Guide | ||
| 46 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-bounce.html). | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> Message => Str | ||
| 52 | |||
| 53 | Human-readable text to include in the bounce message. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> Sender => Str | ||
| 57 | |||
| 58 | The email address of the sender of the bounced email. This is the | ||
| 59 | address from which the bounce message will be sent. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> SmtpReplyCode => Str | ||
| 63 | |||
| 64 | The SMTP reply code, as defined by RFC 5321 | ||
| 65 | (https://tools.ietf.org/html/rfc5321). | ||
| 66 | |||
| 67 | |||
| 68 | =head2 StatusCode => Str | ||
| 69 | |||
| 70 | The SMTP enhanced status code, as defined by RFC 3463 | ||
| 71 | (https://tools.ietf.org/html/rfc3463). | ||
| 72 | |||
| 73 | |||
| 74 | =head2 TopicArn => Str | ||
| 75 | |||
| 76 | The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when | ||
| 77 | the bounce action is taken. An example of an Amazon SNS topic ARN is | ||
| 78 | C<arn:aws:sns:us-west-2:123456789012:MyTopic>. For more information | ||
| 79 | about Amazon SNS topics, see the Amazon SNS Developer Guide | ||
| 80 | (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, describing an object used in L<Paws::SES> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |