| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SES::ReceiptRule; | ||
| 3 | use Moose; | ||
| 4 | has Actions => (is => 'ro', isa => 'ArrayRef[Paws::SES::ReceiptAction]'); | ||
| 5 | has Enabled => (is => 'ro', isa => 'Bool'); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Recipients => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has ScanEnabled => (is => 'ro', isa => 'Bool'); | ||
| 9 | has TlsPolicy => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::SES::ReceiptRule | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::SES::ReceiptRule object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { Actions => $value, ..., TlsPolicy => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::SES::ReceiptRule object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->Actions | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Receipt rules enable you to specify which actions Amazon SES should | ||
| 42 | take when it receives mail on behalf of one or more email addresses or | ||
| 43 | domains that you own. | ||
| 44 | |||
| 45 | Each receipt rule defines a set of email addresses or domains that it | ||
| 46 | applies to. If the email addresses or domains match at least one | ||
| 47 | recipient address of the message, Amazon SES executes all of the | ||
| 48 | receipt rule's actions on the message. | ||
| 49 | |||
| 50 | For information about setting up receipt rules, see the Amazon SES | ||
| 51 | Developer Guide | ||
| 52 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html). | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 Actions => ArrayRef[L<Paws::SES::ReceiptAction>] | ||
| 58 | |||
| 59 | An ordered list of actions to perform on messages that match at least | ||
| 60 | one of the recipient email addresses or domains specified in the | ||
| 61 | receipt rule. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 Enabled => Bool | ||
| 65 | |||
| 66 | If C<true>, the receipt rule is active. The default value is C<false>. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> Name => Str | ||
| 70 | |||
| 71 | The name of the receipt rule. The name must: | ||
| 72 | |||
| 73 | =over | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), | ||
| 78 | underscores (_), or dashes (-). | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | Start and end with a letter or number. | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | Contain less than 64 characters. | ||
| 87 | |||
| 88 | =back | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 Recipients => ArrayRef[Str|Undef] | ||
| 93 | |||
| 94 | The recipient domains and email addresses that the receipt rule applies | ||
| 95 | to. If this field is not specified, this rule will match all recipients | ||
| 96 | under all verified domains. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 ScanEnabled => Bool | ||
| 100 | |||
| 101 | If C<true>, then messages that this receipt rule applies to are scanned | ||
| 102 | for spam and viruses. The default value is C<false>. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 TlsPolicy => Str | ||
| 106 | |||
| 107 | Specifies whether Amazon SES should require that incoming email is | ||
| 108 | delivered over a connection encrypted with Transport Layer Security | ||
| 109 | (TLS). If this parameter is set to C<Require>, Amazon SES will bounce | ||
| 110 | emails that are not received over TLS. The default is C<Optional>. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head1 SEE ALSO | ||
| 115 | |||
| 116 | This class forms part of L<Paws>, describing an object used in L<Paws::SES> | ||
| 117 | |||
| 118 | =head1 BUGS and CONTRIBUTIONS | ||
| 119 | |||
| 120 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 121 | |||
| 122 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 123 | |||
| 124 | =cut | ||
| 125 |