File Coverage

blib/lib/Paws/SES/ReceiptRule.pm

Criterion	Covered	Total	%
statement	3	3	100.0
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	4	4	100.0

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