AWS SDK for C++  1.8.153
AWS SDK for C++
Public Member Functions | List of all members
Aws::SES::Model::RecipientDsnFields Class Reference

#include <RecipientDsnFields.h>

Public Member Functions

 RecipientDsnFields ()
 
 RecipientDsnFields (const Aws::Utils::Xml::XmlNode &xmlNode)
 
RecipientDsnFieldsoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetFinalRecipient () const
 
bool FinalRecipientHasBeenSet () const
 
void SetFinalRecipient (const Aws::String &value)
 
void SetFinalRecipient (Aws::String &&value)
 
void SetFinalRecipient (const char *value)
 
RecipientDsnFieldsWithFinalRecipient (const Aws::String &value)
 
RecipientDsnFieldsWithFinalRecipient (Aws::String &&value)
 
RecipientDsnFieldsWithFinalRecipient (const char *value)
 
const DsnActionGetAction () const
 
bool ActionHasBeenSet () const
 
void SetAction (const DsnAction &value)
 
void SetAction (DsnAction &&value)
 
RecipientDsnFieldsWithAction (const DsnAction &value)
 
RecipientDsnFieldsWithAction (DsnAction &&value)
 
const Aws::StringGetRemoteMta () const
 
bool RemoteMtaHasBeenSet () const
 
void SetRemoteMta (const Aws::String &value)
 
void SetRemoteMta (Aws::String &&value)
 
void SetRemoteMta (const char *value)
 
RecipientDsnFieldsWithRemoteMta (const Aws::String &value)
 
RecipientDsnFieldsWithRemoteMta (Aws::String &&value)
 
RecipientDsnFieldsWithRemoteMta (const char *value)
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
RecipientDsnFieldsWithStatus (const Aws::String &value)
 
RecipientDsnFieldsWithStatus (Aws::String &&value)
 
RecipientDsnFieldsWithStatus (const char *value)
 
const Aws::StringGetDiagnosticCode () const
 
bool DiagnosticCodeHasBeenSet () const
 
void SetDiagnosticCode (const Aws::String &value)
 
void SetDiagnosticCode (Aws::String &&value)
 
void SetDiagnosticCode (const char *value)
 
RecipientDsnFieldsWithDiagnosticCode (const Aws::String &value)
 
RecipientDsnFieldsWithDiagnosticCode (Aws::String &&value)
 
RecipientDsnFieldsWithDiagnosticCode (const char *value)
 
const Aws::Utils::DateTimeGetLastAttemptDate () const
 
bool LastAttemptDateHasBeenSet () const
 
void SetLastAttemptDate (const Aws::Utils::DateTime &value)
 
void SetLastAttemptDate (Aws::Utils::DateTime &&value)
 
RecipientDsnFieldsWithLastAttemptDate (const Aws::Utils::DateTime &value)
 
RecipientDsnFieldsWithLastAttemptDate (Aws::Utils::DateTime &&value)
 
const Aws::Vector< ExtensionField > & GetExtensionFields () const
 
bool ExtensionFieldsHasBeenSet () const
 
void SetExtensionFields (const Aws::Vector< ExtensionField > &value)
 
void SetExtensionFields (Aws::Vector< ExtensionField > &&value)
 
RecipientDsnFieldsWithExtensionFields (const Aws::Vector< ExtensionField > &value)
 
RecipientDsnFieldsWithExtensionFields (Aws::Vector< ExtensionField > &&value)
 
RecipientDsnFieldsAddExtensionFields (const ExtensionField &value)
 
RecipientDsnFieldsAddExtensionFields (ExtensionField &&value)
 

Detailed Description

Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

See Also:

AWS API Reference

Definition at line 39 of file RecipientDsnFields.h.

Constructor & Destructor Documentation

◆ RecipientDsnFields() [1/2]

Aws::SES::Model::RecipientDsnFields::RecipientDsnFields ( )

◆ RecipientDsnFields() [2/2]

Aws::SES::Model::RecipientDsnFields::RecipientDsnFields ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ ActionHasBeenSet()

bool Aws::SES::Model::RecipientDsnFields::ActionHasBeenSet ( ) const
inline

The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.

Definition at line 167 of file RecipientDsnFields.h.

◆ AddExtensionFields() [1/2]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::AddExtensionFields ( const ExtensionField value)
inline

Additional X-headers to include in the DSN.

Definition at line 439 of file RecipientDsnFields.h.

◆ AddExtensionFields() [2/2]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::AddExtensionFields ( ExtensionField &&  value)
inline

Additional X-headers to include in the DSN.

Definition at line 444 of file RecipientDsnFields.h.

◆ DiagnosticCodeHasBeenSet()

bool Aws::SES::Model::RecipientDsnFields::DiagnosticCodeHasBeenSet ( ) const
inline

An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

Definition at line 324 of file RecipientDsnFields.h.

◆ ExtensionFieldsHasBeenSet()

bool Aws::SES::Model::RecipientDsnFields::ExtensionFieldsHasBeenSet ( ) const
inline

Additional X-headers to include in the DSN.

Definition at line 414 of file RecipientDsnFields.h.

◆ FinalRecipientHasBeenSet()

bool Aws::SES::Model::RecipientDsnFields::FinalRecipientHasBeenSet ( ) const
inline

The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.

Definition at line 74 of file RecipientDsnFields.h.

◆ GetAction()

const DsnAction& Aws::SES::Model::RecipientDsnFields::GetAction ( ) const
inline

The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.

Definition at line 160 of file RecipientDsnFields.h.

◆ GetDiagnosticCode()

const Aws::String& Aws::SES::Model::RecipientDsnFields::GetDiagnosticCode ( ) const
inline

An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

Definition at line 317 of file RecipientDsnFields.h.

◆ GetExtensionFields()

const Aws::Vector<ExtensionField>& Aws::SES::Model::RecipientDsnFields::GetExtensionFields ( ) const
inline

Additional X-headers to include in the DSN.

Definition at line 409 of file RecipientDsnFields.h.

◆ GetFinalRecipient()

const Aws::String& Aws::SES::Model::RecipientDsnFields::GetFinalRecipient ( ) const
inline

The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.

Definition at line 61 of file RecipientDsnFields.h.

◆ GetLastAttemptDate()

const Aws::Utils::DateTime& Aws::SES::Model::RecipientDsnFields::GetLastAttemptDate ( ) const
inline

The time the final delivery attempt was made, in RFC 822 date-time format.

Definition at line 373 of file RecipientDsnFields.h.

◆ GetRemoteMta()

const Aws::String& Aws::SES::Model::RecipientDsnFields::GetRemoteMta ( ) const
inline

The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.

Definition at line 204 of file RecipientDsnFields.h.

◆ GetStatus()

const Aws::String& Aws::SES::Model::RecipientDsnFields::GetStatus ( ) const
inline

The status code that indicates what went wrong. This is required by RFC 3464.

Definition at line 267 of file RecipientDsnFields.h.

◆ LastAttemptDateHasBeenSet()

bool Aws::SES::Model::RecipientDsnFields::LastAttemptDateHasBeenSet ( ) const
inline

The time the final delivery attempt was made, in RFC 822 date-time format.

Definition at line 379 of file RecipientDsnFields.h.

◆ operator=()

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::SES::Model::RecipientDsnFields::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::SES::Model::RecipientDsnFields::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ RemoteMtaHasBeenSet()

bool Aws::SES::Model::RecipientDsnFields::RemoteMtaHasBeenSet ( ) const
inline

The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.

Definition at line 212 of file RecipientDsnFields.h.

◆ SetAction() [1/2]

void Aws::SES::Model::RecipientDsnFields::SetAction ( const DsnAction value)
inline

The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.

Definition at line 174 of file RecipientDsnFields.h.

◆ SetAction() [2/2]

void Aws::SES::Model::RecipientDsnFields::SetAction ( DsnAction &&  value)
inline

The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.

Definition at line 181 of file RecipientDsnFields.h.

◆ SetDiagnosticCode() [1/3]

void Aws::SES::Model::RecipientDsnFields::SetDiagnosticCode ( Aws::String &&  value)
inline

An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

Definition at line 338 of file RecipientDsnFields.h.

◆ SetDiagnosticCode() [2/3]

void Aws::SES::Model::RecipientDsnFields::SetDiagnosticCode ( const Aws::String value)
inline

An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

Definition at line 331 of file RecipientDsnFields.h.

◆ SetDiagnosticCode() [3/3]

void Aws::SES::Model::RecipientDsnFields::SetDiagnosticCode ( const char *  value)
inline

An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

Definition at line 345 of file RecipientDsnFields.h.

◆ SetExtensionFields() [1/2]

void Aws::SES::Model::RecipientDsnFields::SetExtensionFields ( Aws::Vector< ExtensionField > &&  value)
inline

Additional X-headers to include in the DSN.

Definition at line 424 of file RecipientDsnFields.h.

◆ SetExtensionFields() [2/2]

void Aws::SES::Model::RecipientDsnFields::SetExtensionFields ( const Aws::Vector< ExtensionField > &  value)
inline

Additional X-headers to include in the DSN.

Definition at line 419 of file RecipientDsnFields.h.

◆ SetFinalRecipient() [1/3]

void Aws::SES::Model::RecipientDsnFields::SetFinalRecipient ( Aws::String &&  value)
inline

The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.

Definition at line 100 of file RecipientDsnFields.h.

◆ SetFinalRecipient() [2/3]

void Aws::SES::Model::RecipientDsnFields::SetFinalRecipient ( const Aws::String value)
inline

The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.

Definition at line 87 of file RecipientDsnFields.h.

◆ SetFinalRecipient() [3/3]

void Aws::SES::Model::RecipientDsnFields::SetFinalRecipient ( const char *  value)
inline

The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.

Definition at line 113 of file RecipientDsnFields.h.

◆ SetLastAttemptDate() [1/2]

void Aws::SES::Model::RecipientDsnFields::SetLastAttemptDate ( Aws::Utils::DateTime &&  value)
inline

The time the final delivery attempt was made, in RFC 822 date-time format.

Definition at line 391 of file RecipientDsnFields.h.

◆ SetLastAttemptDate() [2/2]

void Aws::SES::Model::RecipientDsnFields::SetLastAttemptDate ( const Aws::Utils::DateTime value)
inline

The time the final delivery attempt was made, in RFC 822 date-time format.

Definition at line 385 of file RecipientDsnFields.h.

◆ SetRemoteMta() [1/3]

void Aws::SES::Model::RecipientDsnFields::SetRemoteMta ( Aws::String &&  value)
inline

The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.

Definition at line 228 of file RecipientDsnFields.h.

◆ SetRemoteMta() [2/3]

void Aws::SES::Model::RecipientDsnFields::SetRemoteMta ( const Aws::String value)
inline

The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.

Definition at line 220 of file RecipientDsnFields.h.

◆ SetRemoteMta() [3/3]

void Aws::SES::Model::RecipientDsnFields::SetRemoteMta ( const char *  value)
inline

The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.

Definition at line 236 of file RecipientDsnFields.h.

◆ SetStatus() [1/3]

void Aws::SES::Model::RecipientDsnFields::SetStatus ( Aws::String &&  value)
inline

The status code that indicates what went wrong. This is required by RFC 3464.

Definition at line 285 of file RecipientDsnFields.h.

◆ SetStatus() [2/3]

void Aws::SES::Model::RecipientDsnFields::SetStatus ( const Aws::String value)
inline

The status code that indicates what went wrong. This is required by RFC 3464.

Definition at line 279 of file RecipientDsnFields.h.

◆ SetStatus() [3/3]

void Aws::SES::Model::RecipientDsnFields::SetStatus ( const char *  value)
inline

The status code that indicates what went wrong. This is required by RFC 3464.

Definition at line 291 of file RecipientDsnFields.h.

◆ StatusHasBeenSet()

bool Aws::SES::Model::RecipientDsnFields::StatusHasBeenSet ( ) const
inline

The status code that indicates what went wrong. This is required by RFC 3464.

Definition at line 273 of file RecipientDsnFields.h.

◆ WithAction() [1/2]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithAction ( const DsnAction value)
inline

The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.

Definition at line 188 of file RecipientDsnFields.h.

◆ WithAction() [2/2]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithAction ( DsnAction &&  value)
inline

The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.

Definition at line 195 of file RecipientDsnFields.h.

◆ WithDiagnosticCode() [1/3]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithDiagnosticCode ( Aws::String &&  value)
inline

An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

Definition at line 359 of file RecipientDsnFields.h.

◆ WithDiagnosticCode() [2/3]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithDiagnosticCode ( const Aws::String value)
inline

An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

Definition at line 352 of file RecipientDsnFields.h.

◆ WithDiagnosticCode() [3/3]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithDiagnosticCode ( const char *  value)
inline

An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

Definition at line 366 of file RecipientDsnFields.h.

◆ WithExtensionFields() [1/2]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithExtensionFields ( Aws::Vector< ExtensionField > &&  value)
inline

Additional X-headers to include in the DSN.

Definition at line 434 of file RecipientDsnFields.h.

◆ WithExtensionFields() [2/2]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithExtensionFields ( const Aws::Vector< ExtensionField > &  value)
inline

Additional X-headers to include in the DSN.

Definition at line 429 of file RecipientDsnFields.h.

◆ WithFinalRecipient() [1/3]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithFinalRecipient ( Aws::String &&  value)
inline

The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.

Definition at line 139 of file RecipientDsnFields.h.

◆ WithFinalRecipient() [2/3]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithFinalRecipient ( const Aws::String value)
inline

The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.

Definition at line 126 of file RecipientDsnFields.h.

◆ WithFinalRecipient() [3/3]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithFinalRecipient ( const char *  value)
inline

The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.

Definition at line 152 of file RecipientDsnFields.h.

◆ WithLastAttemptDate() [1/2]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithLastAttemptDate ( Aws::Utils::DateTime &&  value)
inline

The time the final delivery attempt was made, in RFC 822 date-time format.

Definition at line 403 of file RecipientDsnFields.h.

◆ WithLastAttemptDate() [2/2]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithLastAttemptDate ( const Aws::Utils::DateTime value)
inline

The time the final delivery attempt was made, in RFC 822 date-time format.

Definition at line 397 of file RecipientDsnFields.h.

◆ WithRemoteMta() [1/3]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithRemoteMta ( Aws::String &&  value)
inline

The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.

Definition at line 252 of file RecipientDsnFields.h.

◆ WithRemoteMta() [2/3]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithRemoteMta ( const Aws::String value)
inline

The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.

Definition at line 244 of file RecipientDsnFields.h.

◆ WithRemoteMta() [3/3]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithRemoteMta ( const char *  value)
inline

The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.

Definition at line 260 of file RecipientDsnFields.h.

◆ WithStatus() [1/3]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithStatus ( Aws::String &&  value)
inline

The status code that indicates what went wrong. This is required by RFC 3464.

Definition at line 303 of file RecipientDsnFields.h.

◆ WithStatus() [2/3]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithStatus ( const Aws::String value)
inline

The status code that indicates what went wrong. This is required by RFC 3464.

Definition at line 297 of file RecipientDsnFields.h.

◆ WithStatus() [3/3]

RecipientDsnFields& Aws::SES::Model::RecipientDsnFields::WithStatus ( const char *  value)
inline

The status code that indicates what went wrong. This is required by RFC 3464.

Definition at line 309 of file RecipientDsnFields.h.


The documentation for this class was generated from the following file: