blib/lib/Paws/SES/SendRawEmail.pm

filter: Statementstmt 100% 18 / 18 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 20 / 20 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/SES/SendEmailResponse.pm ↑ Summary blib/lib/Paws/SES/SendRawEmailResponse.pm »
1  
2 package Paws::SES::SendRawEmail;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has ConfigurationSetName => (is => 'ro', isa => 'Str');
5 1 has Destinations => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
6 1 has FromArn => (is => 'ro', isa => 'Str');
7 1 has RawMessage => (is => 'ro', isa => 'Paws::SES::RawMessage', required => 1);
8 1 has ReturnPathArn => (is => 'ro', isa => 'Str');
9 1 has Source => (is => 'ro', isa => 'Str');
10 1 has SourceArn => (is => 'ro', isa => 'Str');
11 1 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SES::MessageTag]');
12  
13 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
14  
15 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'SendRawEmail');
16 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SES::SendRawEmailResponse');
17 1 class_has _result_key => (isa => 'Str', is => 'ro', default => 'SendRawEmailResult');
18 1 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::SES::SendRawEmail - Arguments for method SendRawEmail on L<Paws::SES>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method SendRawEmail on the
29 L<Amazon Simple Email Service|Paws::SES> 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 =head1 SYNOPSIS
35  
36 my $email = Paws->service('SES');
37 # SendRawEmail
38 # The following example sends an email with an attachment:
39 my $SendRawEmailResponse = $email->SendRawEmail(
40 'Destinations' => [
41  
42 ],
43 'FromArn' => '',
44 'RawMessage' => {
45 'Data' =>
46 'From: sender@example.com\nTo: recipient@example.com\nSubject: Test email (contains an attachment)\nMIME-Version: 1.0\nContent-type: Multipart/Mixed; boundary="NextPart"\n\n--NextPart\nContent-Type: text/plain\n\nThis is the message body.\n\n--NextPart\nContent-Type: text/plain;\nContent-Disposition: attachment; filename="attachment.txt"\n\nThis is the text in the attachment.\n\n--NextPart--'
47 },
48 'ReturnPathArn' => '',
49 'Source' => '',
50 'SourceArn' => ''
51 );
52  
53 # Results:
54 my $MessageId = $SendRawEmailResponse->MessageId;
55  
56 # Returns a L<Paws::SES::SendRawEmailResponse> object.
57  
58 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.
59 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/SendRawEmail>
60  
61 =head1 ATTRIBUTES
62  
63  
64 =head2 ConfigurationSetName => Str
65  
66 The name of the configuration set to use when you send an email using
67 C<SendRawEmail>.
68  
69  
70  
71 =head2 Destinations => ArrayRef[Str|Undef]
72  
73 A list of destinations for the message, consisting of To:, CC:, and
74 BCC: addresses.
75  
76  
77  
78 =head2 FromArn => Str
79  
80 This parameter is used only for sending authorization. It is the ARN of
81 the identity that is associated with the sending authorization policy
82 that permits you to specify a particular "From" address in the header
83 of the raw email.
84  
85 Instead of using this parameter, you can use the X-header
86 C<X-SES-FROM-ARN> in the raw message of the email. If you use both the
87 C<FromArn> parameter and the corresponding X-header, Amazon SES uses
88 the value of the C<FromArn> parameter.
89  
90 For information about when to use this parameter, see the description
91 of C<SendRawEmail> in this guide, or see the Amazon SES Developer Guide
92 (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html).
93  
94  
95  
96 =head2 B<REQUIRED> RawMessage => L<Paws::SES::RawMessage>
97  
98 The raw email message itself. The message has to meet the following
99 criteria:
100  
101 =over
102  
103 =item *
104  
105 The message has to contain a header and a body, separated by a blank
106 line.
107  
108 =item *
109  
110 All of the required header fields must be present in the message.
111  
112 =item *
113  
114 Each part of a multipart MIME message must be formatted properly.
115  
116 =item *
117  
118 Attachments must be of a content type that Amazon SES supports. For a
119 list on unsupported content types, see Unsupported Attachment Types
120 (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mime-types.html)
121 in the I<Amazon SES Developer Guide>.
122  
123 =item *
124  
125 The entire message must be base64-encoded.
126  
127 =item *
128  
129 If any of the MIME parts in your message contain content that is
130 outside of the 7-bit ASCII character range, we highly recommend that
131 you encode that content. For more information, see Sending Raw Email
132 (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html)
133 in the I<Amazon SES Developer Guide>.
134  
135 =item *
136  
137 Per RFC 5321 (https://tools.ietf.org/html/rfc5321#section-4.5.3.1.6),
138 the maximum length of each line of text, including the E<lt>CRLFE<gt>,
139 must not exceed 1,000 characters.
140  
141 =back
142  
143  
144  
145  
146 =head2 ReturnPathArn => Str
147  
148 This parameter is used only for sending authorization. It is the ARN of
149 the identity that is associated with the sending authorization policy
150 that permits you to use the email address specified in the
151 C<ReturnPath> parameter.
152  
153 For example, if the owner of C<example.com> (which has ARN
154 C<arn:aws:ses:us-east-1:123456789012:identity/example.com>) attaches a
155 policy to it that authorizes you to use C<feedback@example.com>, then
156 you would specify the C<ReturnPathArn> to be
157 C<arn:aws:ses:us-east-1:123456789012:identity/example.com>, and the
158 C<ReturnPath> to be C<feedback@example.com>.
159  
160 Instead of using this parameter, you can use the X-header
161 C<X-SES-RETURN-PATH-ARN> in the raw message of the email. If you use
162 both the C<ReturnPathArn> parameter and the corresponding X-header,
163 Amazon SES uses the value of the C<ReturnPathArn> parameter.
164  
165 For information about when to use this parameter, see the description
166 of C<SendRawEmail> in this guide, or see the Amazon SES Developer Guide
167 (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html).
168  
169  
170  
171 =head2 Source => Str
172  
173 The identity's email address. If you do not provide a value for this
174 parameter, you must specify a "From" address in the raw text of the
175 message. (You can also specify both.)
176  
177 Amazon SES does not support the SMTPUTF8 extension, as described
178 inRFC6531 (https://tools.ietf.org/html/rfc6531). For this reason, the
179 I<local part> of a source email address (the part of the email address
180 that precedes the @ sign) may only contain 7-bit ASCII characters
181 (https://en.wikipedia.org/wiki/Email_address#Local-part). If the
182 I<domain part> of an address (the part after the @ sign) contains
183 non-ASCII characters, they must be encoded using Punycode, as described
184 in RFC3492 (https://tools.ietf.org/html/rfc3492.html). The sender name
185 (also known as the I<friendly name>) may contain non-ASCII characters.
186 These characters must be encoded using MIME encoded-word syntax, as
187 described in RFC 2047 (https://tools.ietf.org/html/rfc2047). MIME
188 encoded-word syntax uses the following form:
189 C<=?charset?encoding?encoded-text?=>.
190  
191 If you specify the C<Source> parameter and have feedback forwarding
192 enabled, then bounces and complaints will be sent to this email
193 address. This takes precedence over any Return-Path header that you
194 might include in the raw text of the message.
195  
196  
197  
198 =head2 SourceArn => Str
199  
200 This parameter is used only for sending authorization. It is the ARN of
201 the identity that is associated with the sending authorization policy
202 that permits you to send for the email address specified in the
203 C<Source> parameter.
204  
205 For example, if the owner of C<example.com> (which has ARN
206 C<arn:aws:ses:us-east-1:123456789012:identity/example.com>) attaches a
207 policy to it that authorizes you to send from C<user@example.com>, then
208 you would specify the C<SourceArn> to be
209 C<arn:aws:ses:us-east-1:123456789012:identity/example.com>, and the
210 C<Source> to be C<user@example.com>.
211  
212 Instead of using this parameter, you can use the X-header
213 C<X-SES-SOURCE-ARN> in the raw message of the email. If you use both
214 the C<SourceArn> parameter and the corresponding X-header, Amazon SES
215 uses the value of the C<SourceArn> parameter.
216  
217 For information about when to use this parameter, see the description
218 of C<SendRawEmail> in this guide, or see the Amazon SES Developer Guide
219 (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html).
220  
221  
222  
223 =head2 Tags => ArrayRef[L<Paws::SES::MessageTag>]
224  
225 A list of tags, in the form of name/value pairs, to apply to an email
226 that you send using C<SendRawEmail>. Tags correspond to characteristics
227 of the email that you define, so that you can publish email sending
228 events.
229  
230  
231  
232  
233 =head1 SEE ALSO
234  
235 This class forms part of L<Paws>, documenting arguments for method SendRawEmail in L<Paws::SES>
236  
237 =head1 BUGS and CONTRIBUTIONS
238  
239 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
240  
241 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
242  
243 =cut
244  
« blib/lib/Paws/SES/SendEmailResponse.pm ↑ Summary blib/lib/Paws/SES/SendRawEmailResponse.pm »