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

#include <ReceiptRule.h>

Public Member Functions

 ReceiptRule ()
 
 ReceiptRule (const Aws::Utils::Xml::XmlNode &xmlNode)
 
ReceiptRuleoperator= (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::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
ReceiptRuleWithName (const Aws::String &value)
 
ReceiptRuleWithName (Aws::String &&value)
 
ReceiptRuleWithName (const char *value)
 
bool GetEnabled () const
 
bool EnabledHasBeenSet () const
 
void SetEnabled (bool value)
 
ReceiptRuleWithEnabled (bool value)
 
const TlsPolicyGetTlsPolicy () const
 
bool TlsPolicyHasBeenSet () const
 
void SetTlsPolicy (const TlsPolicy &value)
 
void SetTlsPolicy (TlsPolicy &&value)
 
ReceiptRuleWithTlsPolicy (const TlsPolicy &value)
 
ReceiptRuleWithTlsPolicy (TlsPolicy &&value)
 
const Aws::Vector< Aws::String > & GetRecipients () const
 
bool RecipientsHasBeenSet () const
 
void SetRecipients (const Aws::Vector< Aws::String > &value)
 
void SetRecipients (Aws::Vector< Aws::String > &&value)
 
ReceiptRuleWithRecipients (const Aws::Vector< Aws::String > &value)
 
ReceiptRuleWithRecipients (Aws::Vector< Aws::String > &&value)
 
ReceiptRuleAddRecipients (const Aws::String &value)
 
ReceiptRuleAddRecipients (Aws::String &&value)
 
ReceiptRuleAddRecipients (const char *value)
 
const Aws::Vector< ReceiptAction > & GetActions () const
 
bool ActionsHasBeenSet () const
 
void SetActions (const Aws::Vector< ReceiptAction > &value)
 
void SetActions (Aws::Vector< ReceiptAction > &&value)
 
ReceiptRuleWithActions (const Aws::Vector< ReceiptAction > &value)
 
ReceiptRuleWithActions (Aws::Vector< ReceiptAction > &&value)
 
ReceiptRuleAddActions (const ReceiptAction &value)
 
ReceiptRuleAddActions (ReceiptAction &&value)
 
bool GetScanEnabled () const
 
bool ScanEnabledHasBeenSet () const
 
void SetScanEnabled (bool value)
 
ReceiptRuleWithScanEnabled (bool value)
 

Detailed Description

Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.

Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

See Also:

AWS API Reference

Definition at line 41 of file ReceiptRule.h.

Constructor & Destructor Documentation

◆ ReceiptRule() [1/2]

Aws::SES::Model::ReceiptRule::ReceiptRule ( )

◆ ReceiptRule() [2/2]

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

Member Function Documentation

◆ ActionsHasBeenSet()

bool Aws::SES::Model::ReceiptRule::ActionsHasBeenSet ( ) const
inline

An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

Definition at line 265 of file ReceiptRule.h.

◆ AddActions() [1/2]

ReceiptRule& Aws::SES::Model::ReceiptRule::AddActions ( const ReceiptAction value)
inline

An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

Definition at line 295 of file ReceiptRule.h.

◆ AddActions() [2/2]

ReceiptRule& Aws::SES::Model::ReceiptRule::AddActions ( ReceiptAction &&  value)
inline

An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

Definition at line 301 of file ReceiptRule.h.

◆ AddRecipients() [1/3]

ReceiptRule& Aws::SES::Model::ReceiptRule::AddRecipients ( Aws::String &&  value)
inline

The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

Definition at line 245 of file ReceiptRule.h.

◆ AddRecipients() [2/3]

ReceiptRule& Aws::SES::Model::ReceiptRule::AddRecipients ( const Aws::String value)
inline

The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

Definition at line 238 of file ReceiptRule.h.

◆ AddRecipients() [3/3]

ReceiptRule& Aws::SES::Model::ReceiptRule::AddRecipients ( const char *  value)
inline

The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

Definition at line 252 of file ReceiptRule.h.

◆ EnabledHasBeenSet()

bool Aws::SES::Model::ReceiptRule::EnabledHasBeenSet ( ) const
inline

If true, the receipt rule is active. The default value is false.

Definition at line 127 of file ReceiptRule.h.

◆ GetActions()

const Aws::Vector<ReceiptAction>& Aws::SES::Model::ReceiptRule::GetActions ( ) const
inline

An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

Definition at line 259 of file ReceiptRule.h.

◆ GetEnabled()

bool Aws::SES::Model::ReceiptRule::GetEnabled ( ) const
inline

If true, the receipt rule is active. The default value is false.

Definition at line 121 of file ReceiptRule.h.

◆ GetName()

const Aws::String& Aws::SES::Model::ReceiptRule::GetName ( ) const
inline

The name of the receipt rule. The name must:

  • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Start and end with a letter or number.

  • Contain less than 64 characters.

Definition at line 58 of file ReceiptRule.h.

◆ GetRecipients()

const Aws::Vector<Aws::String>& Aws::SES::Model::ReceiptRule::GetRecipients ( ) const
inline

The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

Definition at line 196 of file ReceiptRule.h.

◆ GetScanEnabled()

bool Aws::SES::Model::ReceiptRule::GetScanEnabled ( ) const
inline

If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

Definition at line 308 of file ReceiptRule.h.

◆ GetTlsPolicy()

const TlsPolicy& Aws::SES::Model::ReceiptRule::GetTlsPolicy ( ) const
inline

Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

Definition at line 148 of file ReceiptRule.h.

◆ NameHasBeenSet()

bool Aws::SES::Model::ReceiptRule::NameHasBeenSet ( ) const
inline

The name of the receipt rule. The name must:

  • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Start and end with a letter or number.

  • Contain less than 64 characters.

Definition at line 66 of file ReceiptRule.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ RecipientsHasBeenSet()

bool Aws::SES::Model::ReceiptRule::RecipientsHasBeenSet ( ) const
inline

The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

Definition at line 203 of file ReceiptRule.h.

◆ ScanEnabledHasBeenSet()

bool Aws::SES::Model::ReceiptRule::ScanEnabledHasBeenSet ( ) const
inline

If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

Definition at line 314 of file ReceiptRule.h.

◆ SetActions() [1/2]

void Aws::SES::Model::ReceiptRule::SetActions ( Aws::Vector< ReceiptAction > &&  value)
inline

An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

Definition at line 277 of file ReceiptRule.h.

◆ SetActions() [2/2]

void Aws::SES::Model::ReceiptRule::SetActions ( const Aws::Vector< ReceiptAction > &  value)
inline

An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

Definition at line 271 of file ReceiptRule.h.

◆ SetEnabled()

void Aws::SES::Model::ReceiptRule::SetEnabled ( bool  value)
inline

If true, the receipt rule is active. The default value is false.

Definition at line 133 of file ReceiptRule.h.

◆ SetName() [1/3]

void Aws::SES::Model::ReceiptRule::SetName ( Aws::String &&  value)
inline

The name of the receipt rule. The name must:

  • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Start and end with a letter or number.

  • Contain less than 64 characters.

Definition at line 82 of file ReceiptRule.h.

◆ SetName() [2/3]

void Aws::SES::Model::ReceiptRule::SetName ( const Aws::String value)
inline

The name of the receipt rule. The name must:

  • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Start and end with a letter or number.

  • Contain less than 64 characters.

Definition at line 74 of file ReceiptRule.h.

◆ SetName() [3/3]

void Aws::SES::Model::ReceiptRule::SetName ( const char *  value)
inline

The name of the receipt rule. The name must:

  • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Start and end with a letter or number.

  • Contain less than 64 characters.

Definition at line 90 of file ReceiptRule.h.

◆ SetRecipients() [1/2]

void Aws::SES::Model::ReceiptRule::SetRecipients ( Aws::Vector< Aws::String > &&  value)
inline

The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

Definition at line 217 of file ReceiptRule.h.

◆ SetRecipients() [2/2]

void Aws::SES::Model::ReceiptRule::SetRecipients ( const Aws::Vector< Aws::String > &  value)
inline

The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

Definition at line 210 of file ReceiptRule.h.

◆ SetScanEnabled()

void Aws::SES::Model::ReceiptRule::SetScanEnabled ( bool  value)
inline

If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

Definition at line 320 of file ReceiptRule.h.

◆ SetTlsPolicy() [1/2]

void Aws::SES::Model::ReceiptRule::SetTlsPolicy ( const TlsPolicy value)
inline

Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

Definition at line 164 of file ReceiptRule.h.

◆ SetTlsPolicy() [2/2]

void Aws::SES::Model::ReceiptRule::SetTlsPolicy ( TlsPolicy &&  value)
inline

Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

Definition at line 172 of file ReceiptRule.h.

◆ TlsPolicyHasBeenSet()

bool Aws::SES::Model::ReceiptRule::TlsPolicyHasBeenSet ( ) const
inline

Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

Definition at line 156 of file ReceiptRule.h.

◆ WithActions() [1/2]

ReceiptRule& Aws::SES::Model::ReceiptRule::WithActions ( Aws::Vector< ReceiptAction > &&  value)
inline

An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

Definition at line 289 of file ReceiptRule.h.

◆ WithActions() [2/2]

ReceiptRule& Aws::SES::Model::ReceiptRule::WithActions ( const Aws::Vector< ReceiptAction > &  value)
inline

An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

Definition at line 283 of file ReceiptRule.h.

◆ WithEnabled()

ReceiptRule& Aws::SES::Model::ReceiptRule::WithEnabled ( bool  value)
inline

If true, the receipt rule is active. The default value is false.

Definition at line 139 of file ReceiptRule.h.

◆ WithName() [1/3]

ReceiptRule& Aws::SES::Model::ReceiptRule::WithName ( Aws::String &&  value)
inline

The name of the receipt rule. The name must:

  • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Start and end with a letter or number.

  • Contain less than 64 characters.

Definition at line 106 of file ReceiptRule.h.

◆ WithName() [2/3]

ReceiptRule& Aws::SES::Model::ReceiptRule::WithName ( const Aws::String value)
inline

The name of the receipt rule. The name must:

  • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Start and end with a letter or number.

  • Contain less than 64 characters.

Definition at line 98 of file ReceiptRule.h.

◆ WithName() [3/3]

ReceiptRule& Aws::SES::Model::ReceiptRule::WithName ( const char *  value)
inline

The name of the receipt rule. The name must:

  • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Start and end with a letter or number.

  • Contain less than 64 characters.

Definition at line 114 of file ReceiptRule.h.

◆ WithRecipients() [1/2]

ReceiptRule& Aws::SES::Model::ReceiptRule::WithRecipients ( Aws::Vector< Aws::String > &&  value)
inline

The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

Definition at line 231 of file ReceiptRule.h.

◆ WithRecipients() [2/2]

ReceiptRule& Aws::SES::Model::ReceiptRule::WithRecipients ( const Aws::Vector< Aws::String > &  value)
inline

The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

Definition at line 224 of file ReceiptRule.h.

◆ WithScanEnabled()

ReceiptRule& Aws::SES::Model::ReceiptRule::WithScanEnabled ( bool  value)
inline

If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

Definition at line 326 of file ReceiptRule.h.

◆ WithTlsPolicy() [1/2]

ReceiptRule& Aws::SES::Model::ReceiptRule::WithTlsPolicy ( const TlsPolicy value)
inline

Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

Definition at line 180 of file ReceiptRule.h.

◆ WithTlsPolicy() [2/2]

ReceiptRule& Aws::SES::Model::ReceiptRule::WithTlsPolicy ( TlsPolicy &&  value)
inline

Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

Definition at line 188 of file ReceiptRule.h.


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