Synopsis
Calls the Amazon Simple Email Service SendRawEmail API operation.
Syntax
Send-SESRawEmail-Source <String>-Destination <String[]>-ConfigurationSetName <String>-RawMessage_Data <MemoryStream>-FromArn <String>-ReturnPathArn <String>-SourceArn <String>-Tag <MessageTag[]>-Force <SwitchParameter>
Description
Composes an email message and immediately queues it for sending.
This operation is more flexible than the
SendEmail API operation. When you use the SendRawEmail operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you want to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments.
The SendRawEmail operation has the following requirements: - You can only send email from verified email addresses or domains. If you try to send email from an address that isn't verified, the operation results in an "Email address not verified" error.
- If your account is still in the Amazon SES sandbox, you can only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox simulator.
- The maximum message size, including attachments, is 10 MB.
- Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines.
- If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a valid format (that is, it's not in the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even if the other addresses are valid.
- Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group.
- Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn't preserved. For this reason, we highly recommend that you encode all content that isn't 7-bit ASCII. For more information, see MIME Encoding in the Amazon SES Developer Guide.
SendRawEmail operation: - Although you can customize the message headers when using the
SendRawEmailoperation, Amazon SES will automatically apply its ownMessage-IDandDateheaders; if you passed these headers when creating the message, they will be overwritten by the values that Amazon SES provides. - If you are using sending authorization to send on behalf of another user,
SendRawEmailenables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parametersSourceArn,FromArn, and/orReturnPathArnto the API, or you can include the following X-headers in the header of your raw email:X-SES-SOURCE-ARNX-SES-FROM-ARNX-SES-RETURN-PATH-ARN
Do not include these X-headers in the DKIM signature; Amazon SES will remove them before sending the email. SourceIdentityArnparameter and not theFromIdentityArnorReturnPathIdentityArnparameters. If you only specify theSourceIdentityArnparameter, Amazon SES will set the From and Return Path addresses to the identity specified inSourceIdentityArn. For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide. - For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
Parameters
-ConfigurationSetName <String>
The name of the configuration set to use when you send an email using
SendRawEmail. | Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-Destination <String[]>
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
| Required? | False |
| Position? | 2 |
| Accept pipeline input? | False |
| Aliases | Destinations |
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-FromArn <String>
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. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-RawMessage_Data <MemoryStream>
The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding.The To:, CC:, and BCC: headers in the raw message can contain a group list.If you are using Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.
SendRawEmail with sending authorization, you can include X-headers in the raw message to specify the "Source," "From," and "Return-Path" addresses. For more information, see the documentation for SendRawEmail. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ReturnPathArn <String>
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. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Source <String>
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. 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. 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. 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. 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. | Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ) |
-SourceArn <String>
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. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Tag <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. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Tags |
Common Credential and Region Parameters
-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information,
and optionally a token for session-based credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)
If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.
As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing
credential information. The profile is expected to be found in the secure credential
file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also
specify the name of a profile stored in the .ini-format credential file used with
the AWS CLI and other AWS SDKs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile.
Contains the network credentials to be supplied during authentication with the
configured identity provider's endpoint. This parameter is not required if the
user's default network identity can or should be used during authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EndpointUrl <String>
The endpoint to make the call against.
Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Inputs
You can pipe a String object to this cmdlet for the Source parameter.
Outputs
This cmdlet returns a System.String object.
The service call response (type Amazon.SimpleEmail.Model.SendRawEmailResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
