File Coverage

blib/lib/Paws/SES/SendRawEmail.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::SES::SendRawEmail;
3 1     1   420 use Moose;
  1     1   3  
  1         7  
  1         330  
  1         2  
  1         6  
4             has ConfigurationSetName => (is => 'ro', isa => 'Str');
5             has Destinations => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
6             has FromArn => (is => 'ro', isa => 'Str');
7             has RawMessage => (is => 'ro', isa => 'Paws::SES::RawMessage', required => 1);
8             has ReturnPathArn => (is => 'ro', isa => 'Str');
9             has Source => (is => 'ro', isa => 'Str');
10             has SourceArn => (is => 'ro', isa => 'Str');
11             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SES::MessageTag]');
12              
13 1     1   6037 use MooseX::ClassAttribute;
  1     1   2  
  1         10  
  1         5530  
  1         9  
  1         6  
14              
15             class_has _api_call => (isa => 'Str', is => 'ro', default => 'SendRawEmail');
16             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SES::SendRawEmailResponse');
17             class_has _result_key => (isa => 'Str', is => 'ro', default => 'SendRawEmailResult');
18             1;
19              
20             ### main pod documentation begin ###
21              
22             =head1 NAME
23              
24             Paws::SES::SendRawEmail - Arguments for method SendRawEmail on Paws::SES
25              
26             =head1 DESCRIPTION
27              
28             This class represents the parameters used for calling the method SendRawEmail on the
29             Amazon Simple Email Service service. Use the attributes of this class
30             as arguments to method SendRawEmail.
31              
32             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendRawEmail.
33              
34             As an example:
35              
36             $service_obj->SendRawEmail(Att1 => $value1, Att2 => $value2, ...);
37              
38             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.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 ConfigurationSetName => Str
44              
45             The name of the configuration set to use when you send an email using
46             C<SendRawEmail>.
47              
48              
49              
50             =head2 Destinations => ArrayRef[Str|Undef]
51              
52             A list of destinations for the message, consisting of To:, CC:, and
53             BCC: addresses.
54              
55              
56              
57             =head2 FromArn => Str
58              
59             This parameter is used only for sending authorization. It is the ARN of
60             the identity that is associated with the sending authorization policy
61             that permits you to specify a particular "From" address in the header
62             of the raw email.
63              
64             Instead of using this parameter, you can use the X-header
65             C<X-SES-FROM-ARN> in the raw message of the email. If you use both the
66             C<FromArn> parameter and the corresponding X-header, Amazon SES uses
67             the value of the C<FromArn> parameter.
68              
69             For information about when to use this parameter, see the description
70             of C<SendRawEmail> in this guide, or see the Amazon SES Developer
71             Guide.
72              
73              
74              
75             =head2 B<REQUIRED> RawMessage => L<Paws::SES::RawMessage>
76              
77             The raw text of the message. The client is responsible for ensuring the
78             following:
79              
80             =over
81              
82             =item *
83              
84             Message must contain a header and a body, separated by a blank line.
85              
86             =item *
87              
88             All required header fields must be present.
89              
90             =item *
91              
92             Each part of a multipart MIME message must be formatted properly.
93              
94             =item *
95              
96             MIME content types must be among those supported by Amazon SES. For
97             more information, go to the Amazon SES Developer Guide.
98              
99             =item *
100              
101             Must be base64-encoded.
102              
103             =item *
104              
105             Per RFC 5321, the maximum length of each line of text, including the
106             E<lt>CRLFE<gt>, must not exceed 1,000 characters.
107              
108             =back
109              
110              
111              
112              
113             =head2 ReturnPathArn => Str
114              
115             This parameter is used only for sending authorization. It is the ARN of
116             the identity that is associated with the sending authorization policy
117             that permits you to use the email address specified in the
118             C<ReturnPath> parameter.
119              
120             For example, if the owner of C<example.com> (which has ARN
121             C<arn:aws:ses:us-east-1:123456789012:identity/example.com>) attaches a
122             policy to it that authorizes you to use C<feedback@example.com>, then
123             you would specify the C<ReturnPathArn> to be
124             C<arn:aws:ses:us-east-1:123456789012:identity/example.com>, and the
125             C<ReturnPath> to be C<feedback@example.com>.
126              
127             Instead of using this parameter, you can use the X-header
128             C<X-SES-RETURN-PATH-ARN> in the raw message of the email. If you use
129             both the C<ReturnPathArn> parameter and the corresponding X-header,
130             Amazon SES uses the value of the C<ReturnPathArn> parameter.
131              
132             For information about when to use this parameter, see the description
133             of C<SendRawEmail> in this guide, or see the Amazon SES Developer
134             Guide.
135              
136              
137              
138             =head2 Source => Str
139              
140             The identity's email address. If you do not provide a value for this
141             parameter, you must specify a "From" address in the raw text of the
142             message. (You can also specify both.)
143              
144             By default, the string must be 7-bit ASCII. If the text must contain
145             any other characters, then you must use MIME encoded-word syntax (RFC
146             2047) instead of a literal string. MIME encoded-word syntax uses the
147             following form: C<=?charset?encoding?encoded-text?=>. For more
148             information, see RFC 2047.
149              
150             If you specify the C<Source> parameter and have feedback forwarding
151             enabled, then bounces and complaints will be sent to this email
152             address. This takes precedence over any Return-Path header that you
153             might include in the raw text of the message.
154              
155              
156              
157             =head2 SourceArn => Str
158              
159             This parameter is used only for sending authorization. It is the ARN of
160             the identity that is associated with the sending authorization policy
161             that permits you to send for the email address specified in the
162             C<Source> parameter.
163              
164             For example, if the owner of C<example.com> (which has ARN
165             C<arn:aws:ses:us-east-1:123456789012:identity/example.com>) attaches a
166             policy to it that authorizes you to send from C<user@example.com>, then
167             you would specify the C<SourceArn> to be
168             C<arn:aws:ses:us-east-1:123456789012:identity/example.com>, and the
169             C<Source> to be C<user@example.com>.
170              
171             Instead of using this parameter, you can use the X-header
172             C<X-SES-SOURCE-ARN> in the raw message of the email. If you use both
173             the C<SourceArn> parameter and the corresponding X-header, Amazon SES
174             uses the value of the C<SourceArn> parameter.
175              
176             For information about when to use this parameter, see the description
177             of C<SendRawEmail> in this guide, or see the Amazon SES Developer
178             Guide.
179              
180              
181              
182             =head2 Tags => ArrayRef[L<Paws::SES::MessageTag>]
183              
184             A list of tags, in the form of name/value pairs, to apply to an email
185             that you send using C<SendRawEmail>. Tags correspond to characteristics
186             of the email that you define, so that you can publish email sending
187             events.
188              
189              
190              
191              
192             =head1 SEE ALSO
193              
194             This class forms part of L<Paws>, documenting arguments for method SendRawEmail in L<Paws::SES>
195              
196             =head1 BUGS and CONTRIBUTIONS
197              
198             The source code is located here: https://github.com/pplu/aws-sdk-perl
199              
200             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
201              
202             =cut
203