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.

Sets the specified receipt rule set as the active receipt rule set.

To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Note:

For PCL and Unity this operation is only available in asynchronous form. Please refer to SetActiveReceiptRuleSetAsync.

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

Syntax

C#
public abstract SetActiveReceiptRuleSetResponse SetActiveReceiptRuleSet(
         SetActiveReceiptRuleSetRequest request
)
Parameters
request
Type: Amazon.SimpleEmail.Model.SetActiveReceiptRuleSetRequest

Container for the necessary parameters to execute the SetActiveReceiptRuleSet service method.

Return Value
The response from the SetActiveReceiptRuleSet service method, as returned by SimpleEmailService.

Exceptions

ExceptionCondition
RuleSetDoesNotExistException Indicates that the provided receipt rule set does not exist.

Examples

The following example sets the active receipt rule set:

SetActiveReceiptRuleSet


var response = client.SetActiveReceiptRuleSet(new SetActiveReceiptRuleSetRequest 
{
    RuleSetName = "RuleSetToActivate"
});


            

Version Information

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone

See Also