SendEmailRequest
extends Input
in package
Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide [^1].
Table of Contents
Properties
- $region : string|null
- $configurationSetName : string|null
- The name of the configuration set to use when sending the email.
- $content : EmailContent|null
- An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.
- $destination : Destination|null
- An object that contains the recipients of the email message.
- $emailTags : array<string|int, MessageTag>|null
- A list of tags, in the form of name/value pairs, to apply to an email that you send using the `SendEmail` operation.
- $feedbackForwardingEmailAddress : string|null
- The address that you want bounce and complaint notifications to be sent to.
- $feedbackForwardingEmailAddressIdentityArn : string|null
- 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 `FeedbackForwardingEmailAddress` parameter.
- $fromEmailAddress : string|null
- The email address to use as the "From" address for the email. The address that you specify has to be verified.
- $fromEmailAddressIdentityArn : string|null
- 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 `FromEmailAddress` parameter.
- $listManagementOptions : ListManagementOptions|null
- An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
- $replyToAddresses : array<string|int, string>|null
- The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
Methods
- __construct() : mixed
- create() : self
- getConfigurationSetName() : string|null
- getContent() : EmailContent|null
- getDestination() : Destination|null
- getEmailTags() : array<string|int, MessageTag>
- getFeedbackForwardingEmailAddress() : string|null
- getFeedbackForwardingEmailAddressIdentityArn() : string|null
- getFromEmailAddress() : string|null
- getFromEmailAddressIdentityArn() : string|null
- getListManagementOptions() : ListManagementOptions|null
- getRegion() : string|null
- getReplyToAddresses() : array<string|int, string>
- request() : Request
- setConfigurationSetName() : self
- setContent() : self
- setDestination() : self
- setEmailTags() : self
- setFeedbackForwardingEmailAddress() : self
- setFeedbackForwardingEmailAddressIdentityArn() : self
- setFromEmailAddress() : self
- setFromEmailAddressIdentityArn() : self
- setListManagementOptions() : self
- setRegion() : void
- setReplyToAddresses() : self
- requestBody() : array<string|int, mixed>
Properties
$region
public
string|null
$region
$configurationSetName
The name of the configuration set to use when sending the email.
private
string|null
$configurationSetName
$content
An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.
private
EmailContent|null
$content
Tags
$destination
An object that contains the recipients of the email message.
private
Destination|null
$destination
$emailTags
A list of tags, in the form of name/value pairs, to apply to an email that you send using the `SendEmail` operation.
private
array<string|int, MessageTag>|null
$emailTags
Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
$feedbackForwardingEmailAddress
The address that you want bounce and complaint notifications to be sent to.
private
string|null
$feedbackForwardingEmailAddress
$feedbackForwardingEmailAddressIdentityArn
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 `FeedbackForwardingEmailAddress` parameter.
private
string|null
$feedbackForwardingEmailAddressIdentityArn
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
FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
FeedbackForwardingEmailAddress to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide ^1.
$fromEmailAddress
The email address to use as the "From" address for the email. The address that you specify has to be verified.
private
string|null
$fromEmailAddress
$fromEmailAddressIdentityArn
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 `FromEmailAddress` parameter.
private
string|null
$fromEmailAddressIdentityArn
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 sender@example.com, then you would specify the
FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
FromEmailAddress to be sender@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide ^1.
For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers
specified in raw email message content.
$listManagementOptions
An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
private
ListManagementOptions|null
$listManagementOptions
$replyToAddresses
The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
private
array<string|int, string>|null
$replyToAddresses
Methods
__construct()
public
__construct([ListManagementOptions|array, '@region'?: string|null} $input = [] ]) : mixed
Parameters
- $input : ListManagementOptions|array, '@region'?: string|null} = []
create()
public
static create(ListManagementOptions|array, '@region'?: string|null}|SendEmailRequest $input) : self
Parameters
- $input : ListManagementOptions|array, '@region'?: string|null}|SendEmailRequest
Return values
selfgetConfigurationSetName()
public
getConfigurationSetName() : string|null
Return values
string|nullgetContent()
public
getContent() : EmailContent|null
Return values
EmailContent|nullgetDestination()
public
getDestination() : Destination|null
Return values
Destination|nullgetEmailTags()
public
getEmailTags() : array<string|int, MessageTag>
Return values
array<string|int, MessageTag>getFeedbackForwardingEmailAddress()
public
getFeedbackForwardingEmailAddress() : string|null
Return values
string|nullgetFeedbackForwardingEmailAddressIdentityArn()
public
getFeedbackForwardingEmailAddressIdentityArn() : string|null
Return values
string|nullgetFromEmailAddress()
public
getFromEmailAddress() : string|null
Return values
string|nullgetFromEmailAddressIdentityArn()
public
getFromEmailAddressIdentityArn() : string|null
Return values
string|nullgetListManagementOptions()
public
getListManagementOptions() : ListManagementOptions|null
Return values
ListManagementOptions|nullgetRegion()
public
getRegion() : string|null
Return values
string|nullgetReplyToAddresses()
public
getReplyToAddresses() : array<string|int, string>
Return values
array<string|int, string>request()
public
abstract request() : Request
Return values
RequestsetConfigurationSetName()
public
setConfigurationSetName(string|null $value) : self
Parameters
- $value : string|null
Return values
selfsetContent()
public
setContent(EmailContent|null $value) : self
Parameters
- $value : EmailContent|null
Return values
selfsetDestination()
public
setDestination(Destination|null $value) : self
Parameters
- $value : Destination|null
Return values
selfsetEmailTags()
public
setEmailTags(array<string|int, MessageTag> $value) : self
Parameters
- $value : array<string|int, MessageTag>
Return values
selfsetFeedbackForwardingEmailAddress()
public
setFeedbackForwardingEmailAddress(string|null $value) : self
Parameters
- $value : string|null
Return values
selfsetFeedbackForwardingEmailAddressIdentityArn()
public
setFeedbackForwardingEmailAddressIdentityArn(string|null $value) : self
Parameters
- $value : string|null
Return values
selfsetFromEmailAddress()
public
setFromEmailAddress(string|null $value) : self
Parameters
- $value : string|null
Return values
selfsetFromEmailAddressIdentityArn()
public
setFromEmailAddressIdentityArn(string|null $value) : self
Parameters
- $value : string|null
Return values
selfsetListManagementOptions()
public
setListManagementOptions(ListManagementOptions|null $value) : self
Parameters
- $value : ListManagementOptions|null
Return values
selfsetRegion()
public
setRegion(string|null $region) : void
Parameters
- $region : string|null
setReplyToAddresses()
public
setReplyToAddresses(array<string|int, string> $value) : self
Parameters
- $value : array<string|int, string>
Return values
selfrequestBody()
private
requestBody() : array<string|int, mixed>