NAME
Paws::SES::SendRawEmail - Arguments for method SendRawEmail on Paws::SES
DESCRIPTION
This class represents the parameters used for calling the method SendRawEmail on the Amazon Simple Email Service service. Use the attributes of this class as arguments to method SendRawEmail.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendRawEmail.
SYNOPSIS
my $email = Paws->service('SES');
# SendRawEmail
# The following example sends an email with an attachment:
my $SendRawEmailResponse = $email->SendRawEmail(
'Destinations' => [
],
'FromArn' => '',
'RawMessage' => {
'Data' =>
'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--'
},
'ReturnPathArn' => '',
'Source' => '',
'SourceArn' => ''
);
# Results:
my $MessageId = $SendRawEmailResponse->MessageId;
# Returns a L<Paws::SES::SendRawEmailResponse> object.
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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/email/SendRawEmail
ATTRIBUTES
ConfigurationSetName => Str
The name of the configuration set to use when you send an email using SendRawEmail
.
Destinations => ArrayRef[Str|Undef]
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
FromArn => Str
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular "From" address in the header of the raw email.
Instead of using this parameter, you can use the X-header X-SES-FROM-ARN
in the raw message of the email. If you use both the FromArn
parameter and the corresponding X-header, Amazon SES uses the value of the FromArn
parameter.
For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html).
REQUIRED RawMessage => Paws::SES::RawMessage
The raw email message itself. The message has to meet the following criteria:
The message has to contain a header and a body, separated by a blank line.
All of the required header fields must be present in the message.
Each part of a multipart MIME message must be formatted properly.
Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mime-types.html) in the Amazon SES Developer Guide.
The entire message must be base64-encoded.
If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html) in the Amazon SES Developer Guide.
Per RFC 5321 (https://tools.ietf.org/html/rfc5321#section-4.5.3.1.6), the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.
ReturnPathArn => Str
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath
parameter.
For example, if the owner of example.com
(which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to use feedback@example.com
, then you would specify the ReturnPathArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the ReturnPath
to be feedback@example.com
.
Instead of using this parameter, you can use the X-header X-SES-RETURN-PATH-ARN
in the raw message of the email. If you use both the ReturnPathArn
parameter and the corresponding X-header, Amazon SES uses the value of the ReturnPathArn
parameter.
For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html).
Source => Str
The identity's email address. If you do not provide a value for this parameter, you must specify a "From" address in the raw text of the message. (You can also specify both.)
Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531 (https://tools.ietf.org/html/rfc6531). For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters (https://en.wikipedia.org/wiki/Email_address#Local-part). If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492 (https://tools.ietf.org/html/rfc3492.html). The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047 (https://tools.ietf.org/html/rfc2047). MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=
.
If you specify the Source
parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.
SourceArn => Str
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source
parameter.
For example, if the owner of example.com
(which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to send from user@example.com
, then you would specify the SourceArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the Source
to be user@example.com
.
Instead of using this parameter, you can use the X-header X-SES-SOURCE-ARN
in the raw message of the email. If you use both the SourceArn
parameter and the corresponding X-header, Amazon SES uses the value of the SourceArn
parameter.
For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html).
Tags => ArrayRef[Paws::SES::MessageTag]
A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail
. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
SEE ALSO
This class forms part of Paws, documenting arguments for method SendRawEmail in Paws::SES
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues