AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the SendEmail operation. Composes an email message and immediately queues it for sending. To send email using this operation, your message must meet the following requirements:

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleEmail.AmazonSimpleEmailServiceRequest
      Amazon.SimpleEmail.Model.SendEmailRequest

Namespace: Amazon.SimpleEmail.Model
Assembly: AWSSDK.SimpleEmail.dll
Version: 3.x.y.z

Syntax

C# 
public class SendEmailRequest : AmazonSimpleEmailServiceRequest
         IAmazonWebServiceRequest

The SendEmailRequest type exposes the following members

Constructors

NameDescription
Public Method SendEmailRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method SendEmailRequest(string, Destination, Message)

Instantiates SendEmailRequest with the parameterized properties

Properties

NameTypeDescription
Public Property ConfigurationSetName System.String

Gets and sets the property ConfigurationSetName.

The name of the configuration set to use when you send an email using SendEmail.

Public Property Destination Amazon.SimpleEmail.Model.Destination

Gets and sets the property Destination.

The destination for this email, composed of To:, CC:, and BCC: fields.

Public Property Message Amazon.SimpleEmail.Model.Message

Gets and sets the property Message.

The message to be sent.

Public Property ReplyToAddresses System.Collections.Generic.List<System.String>

Gets and sets the property ReplyToAddresses.

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.

Public Property ReturnPath System.String

Gets and sets the property ReturnPath.

The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

Public Property ReturnPathArn System.String

Gets and sets the property ReturnPathArn.

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.

For more information about sending authorization, see the Amazon SES Developer Guide.

Public Property Source System.String

Gets and sets the property Source.

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

Public Property SourceArn System.String

Gets and sets the property SourceArn.

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.

For more information about sending authorization, see the Amazon SES Developer Guide.

Public Property Tags System.Collections.Generic.List<Amazon.SimpleEmail.Model.MessageTag>

Gets and sets the property Tags.

A list of tags, in the form of name/value pairs, to apply to an email that you send using SendEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Examples

The following example sends a formatted email:

SendEmail


var client = new AmazonSimpleEmailServiceClient();
var response = client.SendEmail(new SendEmailRequest 
{
    Destination = new Destination {
        BccAddresses = new List<string> {
                        
        },
        CcAddresses = new List<string> {
            "recipient3@example.com"
        },
        ToAddresses = new List<string> {
            "recipient1@example.com",
            "recipient2@example.com"
        }
    },
    Message = new Message {
        Body = new Body {
            Html = new Content {
                Charset = "UTF-8",
                Data = "This message body contains HTML formatting. It can, for example, contain links like this one: <a class=\"ulink\" href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide\" target=\"_blank\">Amazon SES Developer Guide</a>."
            },
            Text = new Content {
                Charset = "UTF-8",
                Data = "This is the message body in text format."
            }
        },
        Subject = new Content {
            Charset = "UTF-8",
            Data = "Test email"
        }
    },
    ReplyToAddresses = new List<string> {
                    
    },
    ReturnPath = "",
    ReturnPathArn = "",
    Source = "sender@example.com",
    SourceArn = ""
});

string messageId = response.MessageId;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5