AWSSES Class Reference

Inherits from AWSService : NSObject
Declared in AWSSESService.h
AWSSESService.m

Overview

Amazon Simple Email Service

This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be used in conjunction with the Amazon SES Developer Guide.

For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.

  configuration

The service configuration used to instantiate this service client.

@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration

Discussion

Warning: Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

Declared In

AWSSESService.h

+ defaultSES

Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

+ (instancetype)defaultSES

Return Value

The default service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
    AWSServiceManager.default().defaultServiceConfiguration = configuration

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
      AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                      identityPoolId:@"YourIdentityPoolId"];
      AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                           credentialsProvider:credentialsProvider];
      [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;

      return YES;
  }

Then call the following to get the default service client:

Swift

 let SES = AWSSES.default()

Objective-C

 AWSSES *SES = [AWSSES defaultSES];

Declared In

AWSSESService.h

+ registerSESWithConfiguration:forKey:

Creates a service client with the given service configuration and registers it for the key.

+ (void)registerSESWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key

Parameters

configuration

A service configuration object.

key

A string to identify the service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
    AWSSES.register(with: configuration!, forKey: "USWest2SES")

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                          credentialsProvider:credentialsProvider];

     [AWSSES registerSESWithConfiguration:configuration forKey:@"USWest2SES"];

     return YES;
 }

Then call the following to get the service client:

Swift

 let SES = AWSSES(forKey: "USWest2SES")

Objective-C

 AWSSES *SES = [AWSSES SESForKey:@"USWest2SES"];

Warning: After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

Declared In

AWSSESService.h

+ SESForKey:

Retrieves the service client associated with the key. You need to call + registerSESWithConfiguration:forKey: before invoking this method.

+ (instancetype)SESForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Return Value

An instance of the service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
    AWSSES.register(with: configuration!, forKey: "USWest2SES")

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                          credentialsProvider:credentialsProvider];

     [AWSSES registerSESWithConfiguration:configuration forKey:@"USWest2SES"];

     return YES;
 }

Then call the following to get the service client:

Swift

 let SES = AWSSES(forKey: "USWest2SES")

Objective-C

 AWSSES *SES = [AWSSES SESForKey:@"USWest2SES"];

Declared In

AWSSESService.h

+ removeSESForKey:

Removes the service client associated with the key and release it.

+ (void)removeSESForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Discussion

Warning: Before calling this method, make sure no method is running on this client.

Declared In

AWSSESService.h

– cloneReceiptRuleSet:

Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.

For information about setting up rule sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (AWSTask<AWSSESCloneReceiptRuleSetResponse*> *)cloneReceiptRuleSet:(AWSSESCloneReceiptRuleSetRequest *)request

Parameters

request

A container for the necessary parameters to execute the CloneReceiptRuleSet service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESCloneReceiptRuleSetResponse. On failed execution, task.error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorRuleSetDoesNotExist, AWSSESErrorAlreadyExists, AWSSESErrorLimitExceeded.

Declared In

AWSSESService.h

– cloneReceiptRuleSet:completionHandler:

Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.

For information about setting up rule sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (void)cloneReceiptRuleSet:(AWSSESCloneReceiptRuleSetRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESCloneReceiptRuleSetResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CloneReceiptRuleSet service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorRuleSetDoesNotExist, AWSSESErrorAlreadyExists, AWSSESErrorLimitExceeded.

Declared In

AWSSESService.h

– createReceiptFilter:

Creates a new IP address filter.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (AWSTask<AWSSESCreateReceiptFilterResponse*> *)createReceiptFilter:(AWSSESCreateReceiptFilterRequest *)request

Parameters

request

A container for the necessary parameters to execute the CreateReceiptFilter service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESCreateReceiptFilterResponse. On failed execution, task.error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorLimitExceeded, AWSSESErrorAlreadyExists.

Declared In

AWSSESService.h

– createReceiptFilter:completionHandler:

Creates a new IP address filter.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (void)createReceiptFilter:(AWSSESCreateReceiptFilterRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESCreateReceiptFilterResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateReceiptFilter service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorLimitExceeded, AWSSESErrorAlreadyExists.

Declared In

AWSSESService.h

– createReceiptRule:

Creates a receipt rule.

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

This action is throttled at one request per second.

- (AWSTask<AWSSESCreateReceiptRuleResponse*> *)createReceiptRule:(AWSSESCreateReceiptRuleRequest *)request

Parameters

request

A container for the necessary parameters to execute the CreateReceiptRule service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESCreateReceiptRuleResponse. On failed execution, task.error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorInvalidSnsTopic, AWSSESErrorInvalidS3Configuration, AWSSESErrorInvalidLambdaFunction, AWSSESErrorAlreadyExists, AWSSESErrorRuleDoesNotExist, AWSSESErrorRuleSetDoesNotExist, AWSSESErrorLimitExceeded.

Declared In

AWSSESService.h

– createReceiptRule:completionHandler:

Creates a receipt rule.

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

This action is throttled at one request per second.

- (void)createReceiptRule:(AWSSESCreateReceiptRuleRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESCreateReceiptRuleResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateReceiptRule service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorInvalidSnsTopic, AWSSESErrorInvalidS3Configuration, AWSSESErrorInvalidLambdaFunction, AWSSESErrorAlreadyExists, AWSSESErrorRuleDoesNotExist, AWSSESErrorRuleSetDoesNotExist, AWSSESErrorLimitExceeded.

Declared In

AWSSESService.h

– createReceiptRuleSet:

Creates an empty receipt rule set.

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

This action is throttled at one request per second.

- (AWSTask<AWSSESCreateReceiptRuleSetResponse*> *)createReceiptRuleSet:(AWSSESCreateReceiptRuleSetRequest *)request

Parameters

request

A container for the necessary parameters to execute the CreateReceiptRuleSet service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESCreateReceiptRuleSetResponse. On failed execution, task.error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorAlreadyExists, AWSSESErrorLimitExceeded.

Declared In

AWSSESService.h

– createReceiptRuleSet:completionHandler:

Creates an empty receipt rule set.

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

This action is throttled at one request per second.

- (void)createReceiptRuleSet:(AWSSESCreateReceiptRuleSetRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESCreateReceiptRuleSetResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateReceiptRuleSet service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorAlreadyExists, AWSSESErrorLimitExceeded.

Declared In

AWSSESService.h

– deleteIdentity:

Deletes the specified identity (an email address or a domain) from the list of verified identities.

This action is throttled at one request per second.

- (AWSTask<AWSSESDeleteIdentityResponse*> *)deleteIdentity:(AWSSESDeleteIdentityRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeleteIdentity service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESDeleteIdentityResponse.

Declared In

AWSSESService.h

– deleteIdentity:completionHandler:

Deletes the specified identity (an email address or a domain) from the list of verified identities.

This action is throttled at one request per second.

- (void)deleteIdentity:(AWSSESDeleteIdentityRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESDeleteIdentityResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteIdentity service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– deleteIdentityPolicy:

Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (AWSTask<AWSSESDeleteIdentityPolicyResponse*> *)deleteIdentityPolicy:(AWSSESDeleteIdentityPolicyRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeleteIdentityPolicy service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESDeleteIdentityPolicyResponse.

Declared In

AWSSESService.h

– deleteIdentityPolicy:completionHandler:

Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (void)deleteIdentityPolicy:(AWSSESDeleteIdentityPolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESDeleteIdentityPolicyResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteIdentityPolicy service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– deleteReceiptFilter:

Deletes the specified IP address filter.

For information about managing IP address filters, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (AWSTask<AWSSESDeleteReceiptFilterResponse*> *)deleteReceiptFilter:(AWSSESDeleteReceiptFilterRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeleteReceiptFilter service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESDeleteReceiptFilterResponse.

Declared In

AWSSESService.h

– deleteReceiptFilter:completionHandler:

Deletes the specified IP address filter.

For information about managing IP address filters, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (void)deleteReceiptFilter:(AWSSESDeleteReceiptFilterRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESDeleteReceiptFilterResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteReceiptFilter service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– deleteReceiptRule:

Deletes the specified receipt rule.

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

This action is throttled at one request per second.

- (AWSTask<AWSSESDeleteReceiptRuleResponse*> *)deleteReceiptRule:(AWSSESDeleteReceiptRuleRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeleteReceiptRule service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESDeleteReceiptRuleResponse. On failed execution, task.error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorRuleSetDoesNotExist.

Declared In

AWSSESService.h

– deleteReceiptRule:completionHandler:

Deletes the specified receipt rule.

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

This action is throttled at one request per second.

- (void)deleteReceiptRule:(AWSSESDeleteReceiptRuleRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESDeleteReceiptRuleResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteReceiptRule service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorRuleSetDoesNotExist.

Declared In

AWSSESService.h

– deleteReceiptRuleSet:

Deletes the specified receipt rule set and all of the receipt rules it contains.

The currently active rule set cannot be deleted.

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

This action is throttled at one request per second.

- (AWSTask<AWSSESDeleteReceiptRuleSetResponse*> *)deleteReceiptRuleSet:(AWSSESDeleteReceiptRuleSetRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeleteReceiptRuleSet service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESDeleteReceiptRuleSetResponse. On failed execution, task.error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorCannotDelete.

Declared In

AWSSESService.h

– deleteReceiptRuleSet:completionHandler:

Deletes the specified receipt rule set and all of the receipt rules it contains.

The currently active rule set cannot be deleted.

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

This action is throttled at one request per second.

- (void)deleteReceiptRuleSet:(AWSSESDeleteReceiptRuleSetRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESDeleteReceiptRuleSetResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteReceiptRuleSet service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorCannotDelete.

Declared In

AWSSESService.h

– deleteVerifiedEmailAddress:

Deletes the specified email address from the list of verified addresses.

The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The DeleteIdentity action is now preferred.

This action is throttled at one request per second.

- (AWSTask *)deleteVerifiedEmailAddress:(AWSSESDeleteVerifiedEmailAddressRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeleteVerifiedEmailAddress service method.

Return Value

An instance of AWSTask. On successful execution, task.result will be nil.

Declared In

AWSSESService.h

– deleteVerifiedEmailAddress:completionHandler:

Deletes the specified email address from the list of verified addresses.

The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The DeleteIdentity action is now preferred.

This action is throttled at one request per second.

- (void)deleteVerifiedEmailAddress:(AWSSESDeleteVerifiedEmailAddressRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteVerifiedEmailAddress service method.

completionHandler

The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– describeActiveReceiptRuleSet:

Returns the metadata and receipt rules for the receipt rule set that is currently active.

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

This action is throttled at one request per second.

- (AWSTask<AWSSESDescribeActiveReceiptRuleSetResponse*> *)describeActiveReceiptRuleSet:(AWSSESDescribeActiveReceiptRuleSetRequest *)request

Parameters

request

A container for the necessary parameters to execute the DescribeActiveReceiptRuleSet service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESDescribeActiveReceiptRuleSetResponse.

Declared In

AWSSESService.h

– describeActiveReceiptRuleSet:completionHandler:

Returns the metadata and receipt rules for the receipt rule set that is currently active.

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

This action is throttled at one request per second.

- (void)describeActiveReceiptRuleSet:(AWSSESDescribeActiveReceiptRuleSetRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESDescribeActiveReceiptRuleSetResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeActiveReceiptRuleSet service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– describeReceiptRule:

Returns the details of the specified receipt rule.

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

This action is throttled at one request per second.

- (AWSTask<AWSSESDescribeReceiptRuleResponse*> *)describeReceiptRule:(AWSSESDescribeReceiptRuleRequest *)request

Parameters

request

A container for the necessary parameters to execute the DescribeReceiptRule service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESDescribeReceiptRuleResponse. On failed execution, task.error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorRuleDoesNotExist, AWSSESErrorRuleSetDoesNotExist.

Declared In

AWSSESService.h

– describeReceiptRule:completionHandler:

Returns the details of the specified receipt rule.

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

This action is throttled at one request per second.

- (void)describeReceiptRule:(AWSSESDescribeReceiptRuleRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESDescribeReceiptRuleResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeReceiptRule service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorRuleDoesNotExist, AWSSESErrorRuleSetDoesNotExist.

Declared In

AWSSESService.h

– describeReceiptRuleSet:

Returns the details of the specified receipt rule set.

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

This action is throttled at one request per second.

- (AWSTask<AWSSESDescribeReceiptRuleSetResponse*> *)describeReceiptRuleSet:(AWSSESDescribeReceiptRuleSetRequest *)request

Parameters

request

A container for the necessary parameters to execute the DescribeReceiptRuleSet service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESDescribeReceiptRuleSetResponse. On failed execution, task.error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorRuleSetDoesNotExist.

Declared In

AWSSESService.h

– describeReceiptRuleSet:completionHandler:

Returns the details of the specified receipt rule set.

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

This action is throttled at one request per second.

- (void)describeReceiptRuleSet:(AWSSESDescribeReceiptRuleSetRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESDescribeReceiptRuleSetResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeReceiptRuleSet service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorRuleSetDoesNotExist.

Declared In

AWSSESService.h

– getIdentityDkimAttributes:

Returns the current status of Easy DKIM signing for an entity. For domain name identities, this action also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.

This action takes a list of identities as input and returns the following information for each:

  • Whether Easy DKIM signing is enabled or disabled.

  • A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.

  • Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.

This action is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.

For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.

- (AWSTask<AWSSESGetIdentityDkimAttributesResponse*> *)getIdentityDkimAttributes:(AWSSESGetIdentityDkimAttributesRequest *)request

Parameters

request

A container for the necessary parameters to execute the GetIdentityDkimAttributes service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESGetIdentityDkimAttributesResponse.

Declared In

AWSSESService.h

– getIdentityDkimAttributes:completionHandler:

Returns the current status of Easy DKIM signing for an entity. For domain name identities, this action also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.

This action takes a list of identities as input and returns the following information for each:

  • Whether Easy DKIM signing is enabled or disabled.

  • A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.

  • Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.

This action is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.

For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.

- (void)getIdentityDkimAttributes:(AWSSESGetIdentityDkimAttributesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESGetIdentityDkimAttributesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetIdentityDkimAttributes service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– getIdentityMailFromDomainAttributes:

Returns the custom MAIL FROM attributes for a list of identities (email addresses and/or domains).

This action is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.

- (AWSTask<AWSSESGetIdentityMailFromDomainAttributesResponse*> *)getIdentityMailFromDomainAttributes:(AWSSESGetIdentityMailFromDomainAttributesRequest *)request

Parameters

request

A container for the necessary parameters to execute the GetIdentityMailFromDomainAttributes service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESGetIdentityMailFromDomainAttributesResponse.

Declared In

AWSSESService.h

– getIdentityMailFromDomainAttributes:completionHandler:

Returns the custom MAIL FROM attributes for a list of identities (email addresses and/or domains).

This action is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.

- (void)getIdentityMailFromDomainAttributes:(AWSSESGetIdentityMailFromDomainAttributesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESGetIdentityMailFromDomainAttributesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetIdentityMailFromDomainAttributes service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– getIdentityNotificationAttributes:

Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.

This action is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

- (AWSTask<AWSSESGetIdentityNotificationAttributesResponse*> *)getIdentityNotificationAttributes:(AWSSESGetIdentityNotificationAttributesRequest *)request

Parameters

request

A container for the necessary parameters to execute the GetIdentityNotificationAttributes service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESGetIdentityNotificationAttributesResponse.

Declared In

AWSSESService.h

– getIdentityNotificationAttributes:completionHandler:

Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.

This action is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

- (void)getIdentityNotificationAttributes:(AWSSESGetIdentityNotificationAttributesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESGetIdentityNotificationAttributesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetIdentityNotificationAttributes service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– getIdentityPolicies:

Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (AWSTask<AWSSESGetIdentityPoliciesResponse*> *)getIdentityPolicies:(AWSSESGetIdentityPoliciesRequest *)request

Parameters

request

A container for the necessary parameters to execute the GetIdentityPolicies service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESGetIdentityPoliciesResponse.

Declared In

AWSSESService.h

– getIdentityPolicies:completionHandler:

Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (void)getIdentityPolicies:(AWSSESGetIdentityPoliciesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESGetIdentityPoliciesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetIdentityPolicies service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– getIdentityVerificationAttributes:

Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.

This action is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.

- (AWSTask<AWSSESGetIdentityVerificationAttributesResponse*> *)getIdentityVerificationAttributes:(AWSSESGetIdentityVerificationAttributesRequest *)request

Parameters

request

A container for the necessary parameters to execute the GetIdentityVerificationAttributes service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESGetIdentityVerificationAttributesResponse.

Declared In

AWSSESService.h

– getIdentityVerificationAttributes:completionHandler:

Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.

This action is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.

- (void)getIdentityVerificationAttributes:(AWSSESGetIdentityVerificationAttributesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESGetIdentityVerificationAttributesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetIdentityVerificationAttributes service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– getSendQuota:

Returns the user's current sending limits.

This action is throttled at one request per second.

- (AWSTask<AWSSESGetSendQuotaResponse*> *)getSendQuota:(AWSRequest *)request

Parameters

request

A container for the necessary parameters to execute the GetSendQuota service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESGetSendQuotaResponse.

Declared In

AWSSESService.h

– getSendQuota:completionHandler:

Returns the user's current sending limits.

This action is throttled at one request per second.

- (void)getSendQuota:(AWSRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESGetSendQuotaResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetSendQuota service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– getSendStatistics:

Returns the user's sending statistics. The result is a list of data points, representing the last two weeks of sending activity.

Each data point in the list contains statistics for a 15-minute interval.

This action is throttled at one request per second.

- (AWSTask<AWSSESGetSendStatisticsResponse*> *)getSendStatistics:(AWSRequest *)request

Parameters

request

A container for the necessary parameters to execute the GetSendStatistics service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESGetSendStatisticsResponse.

Declared In

AWSSESService.h

– getSendStatistics:completionHandler:

Returns the user's sending statistics. The result is a list of data points, representing the last two weeks of sending activity.

Each data point in the list contains statistics for a 15-minute interval.

This action is throttled at one request per second.

- (void)getSendStatistics:(AWSRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESGetSendStatisticsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetSendStatistics service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– listIdentities:

Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.

This action is throttled at one request per second.

- (AWSTask<AWSSESListIdentitiesResponse*> *)listIdentities:(AWSSESListIdentitiesRequest *)request

Parameters

request

A container for the necessary parameters to execute the ListIdentities service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESListIdentitiesResponse.

Declared In

AWSSESService.h

– listIdentities:completionHandler:

Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.

This action is throttled at one request per second.

- (void)listIdentities:(AWSSESListIdentitiesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESListIdentitiesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListIdentities service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– listIdentityPolicies:

Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (AWSTask<AWSSESListIdentityPoliciesResponse*> *)listIdentityPolicies:(AWSSESListIdentityPoliciesRequest *)request

Parameters

request

A container for the necessary parameters to execute the ListIdentityPolicies service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESListIdentityPoliciesResponse.

Declared In

AWSSESService.h

– listIdentityPolicies:completionHandler:

Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (void)listIdentityPolicies:(AWSSESListIdentityPoliciesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESListIdentityPoliciesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListIdentityPolicies service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– listReceiptFilters:

Lists the IP address filters associated with your AWS account.

For information about managing IP address filters, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (AWSTask<AWSSESListReceiptFiltersResponse*> *)listReceiptFilters:(AWSSESListReceiptFiltersRequest *)request

Parameters

request

A container for the necessary parameters to execute the ListReceiptFilters service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESListReceiptFiltersResponse.

Declared In

AWSSESService.h

– listReceiptFilters:completionHandler:

Lists the IP address filters associated with your AWS account.

For information about managing IP address filters, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (void)listReceiptFilters:(AWSSESListReceiptFiltersRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESListReceiptFiltersResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListReceiptFilters service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– listReceiptRuleSets:

Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries.

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

This action is throttled at one request per second.

- (AWSTask<AWSSESListReceiptRuleSetsResponse*> *)listReceiptRuleSets:(AWSSESListReceiptRuleSetsRequest *)request

Parameters

request

A container for the necessary parameters to execute the ListReceiptRuleSets service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESListReceiptRuleSetsResponse.

Declared In

AWSSESService.h

– listReceiptRuleSets:completionHandler:

Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries.

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

This action is throttled at one request per second.

- (void)listReceiptRuleSets:(AWSSESListReceiptRuleSetsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESListReceiptRuleSetsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListReceiptRuleSets service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– listVerifiedEmailAddresses:

Returns a list containing all of the email addresses that have been verified.

The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of Domain Verification. The ListIdentities action is now preferred.

This action is throttled at one request per second.

- (AWSTask<AWSSESListVerifiedEmailAddressesResponse*> *)listVerifiedEmailAddresses:(AWSRequest *)request

Parameters

request

A container for the necessary parameters to execute the ListVerifiedEmailAddresses service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESListVerifiedEmailAddressesResponse.

Declared In

AWSSESService.h

– listVerifiedEmailAddresses:completionHandler:

Returns a list containing all of the email addresses that have been verified.

The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of Domain Verification. The ListIdentities action is now preferred.

This action is throttled at one request per second.

- (void)listVerifiedEmailAddresses:(AWSRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESListVerifiedEmailAddressesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListVerifiedEmailAddresses service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– putIdentityPolicy:

Adds or updates a sending authorization policy for the specified identity (an email address or a domain).

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (AWSTask<AWSSESPutIdentityPolicyResponse*> *)putIdentityPolicy:(AWSSESPutIdentityPolicyRequest *)request

Parameters

request

A container for the necessary parameters to execute the PutIdentityPolicy service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESPutIdentityPolicyResponse. On failed execution, task.error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorInvalidPolicy.

Declared In

AWSSESService.h

– putIdentityPolicy:completionHandler:

Adds or updates a sending authorization policy for the specified identity (an email address or a domain).

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (void)putIdentityPolicy:(AWSSESPutIdentityPolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESPutIdentityPolicyResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the PutIdentityPolicy service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorInvalidPolicy.

Declared In

AWSSESService.h

– reorderReceiptRuleSet:

Reorders the receipt rules within a receipt rule set.

All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn’t explicitly position all of the rules.

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

This action is throttled at one request per second.

- (AWSTask<AWSSESReorderReceiptRuleSetResponse*> *)reorderReceiptRuleSet:(AWSSESReorderReceiptRuleSetRequest *)request

Parameters

request

A container for the necessary parameters to execute the ReorderReceiptRuleSet service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESReorderReceiptRuleSetResponse. On failed execution, task.error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorRuleSetDoesNotExist, AWSSESErrorRuleDoesNotExist.

Declared In

AWSSESService.h

– reorderReceiptRuleSet:completionHandler:

Reorders the receipt rules within a receipt rule set.

All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn’t explicitly position all of the rules.

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

This action is throttled at one request per second.

- (void)reorderReceiptRuleSet:(AWSSESReorderReceiptRuleSetRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESReorderReceiptRuleSetResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ReorderReceiptRuleSet service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorRuleSetDoesNotExist, AWSSESErrorRuleDoesNotExist.

Declared In

AWSSESService.h

– sendBounce:

Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.

You cannot use this API to send generic bounces for mail that was not received by Amazon SES.

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

This action is throttled at one request per second.

- (AWSTask<AWSSESSendBounceResponse*> *)sendBounce:(AWSSESSendBounceRequest *)request

Parameters

request

A container for the necessary parameters to execute the SendBounce service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESSendBounceResponse. On failed execution, task.error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorMessageRejected.

Declared In

AWSSESService.h

– sendBounce:completionHandler:

Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.

You cannot use this API to send generic bounces for mail that was not received by Amazon SES.

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

This action is throttled at one request per second.

- (void)sendBounce:(AWSSESSendBounceRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESSendBounceResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SendBounce service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorMessageRejected.

Declared In

AWSSESService.h

– sendEmail:

Composes an email message based on input data, and then immediately queues the message for sending.

There are several important points to know about SendEmail:

  • You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide.

  • The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.

  • Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.

  • For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide.

- (AWSTask<AWSSESSendEmailResponse*> *)sendEmail:(AWSSESSendEmailRequest *)request

Parameters

request

A container for the necessary parameters to execute the SendEmail service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESSendEmailResponse. On failed execution, task.error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorMessageRejected, AWSSESErrorMailFromDomainNotVerified.

Declared In

AWSSESService.h

– sendEmail:completionHandler:

Composes an email message based on input data, and then immediately queues the message for sending.

There are several important points to know about SendEmail:

  • You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide.

  • The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.

  • Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.

  • For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide.

- (void)sendEmail:(AWSSESSendEmailRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESSendEmailResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SendEmail service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorMessageRejected, AWSSESErrorMailFromDomainNotVerified.

Declared In

AWSSESService.h

– sendRawEmail:

Sends an email message, with header and content specified by the client. The SendRawEmail action is useful for sending multipart MIME emails. The raw text of the message must comply with Internet email standards; otherwise, the message cannot be sent.

There are several important points to know about SendRawEmail:

  • You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide.

  • The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.

  • Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.

  • The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list counts towards the 50-recipient limit.

  • Amazon SES overrides any Message-ID and Date headers you provide.

  • For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide.

  • If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's "Source," "From," and "Return-Path" parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn to the API, or you can include the following X-headers in the header of your raw email:

    • X-SES-SOURCE-ARN

    • X-SES-FROM-ARN

    • X-SES-RETURN-PATH-ARN

    Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.

    For the most common sending authorization use case, we recommend that you specify the SourceIdentityArn and do not specify either the FromIdentityArn or ReturnPathIdentityArn. (The same note applies to the corresponding X-headers.) If you only specify the SourceIdentityArn, Amazon SES will simply set the "From" address and the "Return Path" address to the identity specified in SourceIdentityArn. For more information about sending authorization, see the Amazon SES Developer Guide.

- (AWSTask<AWSSESSendRawEmailResponse*> *)sendRawEmail:(AWSSESSendRawEmailRequest *)request

Parameters

request

A container for the necessary parameters to execute the SendRawEmail service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESSendRawEmailResponse. On failed execution, task.error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorMessageRejected, AWSSESErrorMailFromDomainNotVerified.

Declared In

AWSSESService.h

– sendRawEmail:completionHandler:

Sends an email message, with header and content specified by the client. The SendRawEmail action is useful for sending multipart MIME emails. The raw text of the message must comply with Internet email standards; otherwise, the message cannot be sent.

There are several important points to know about SendRawEmail:

  • You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide.

  • The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.

  • Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.

  • The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list counts towards the 50-recipient limit.

  • Amazon SES overrides any Message-ID and Date headers you provide.

  • For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide.

  • If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's "Source," "From," and "Return-Path" parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn to the API, or you can include the following X-headers in the header of your raw email:

    • X-SES-SOURCE-ARN

    • X-SES-FROM-ARN

    • X-SES-RETURN-PATH-ARN

    Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.

    For the most common sending authorization use case, we recommend that you specify the SourceIdentityArn and do not specify either the FromIdentityArn or ReturnPathIdentityArn. (The same note applies to the corresponding X-headers.) If you only specify the SourceIdentityArn, Amazon SES will simply set the "From" address and the "Return Path" address to the identity specified in SourceIdentityArn. For more information about sending authorization, see the Amazon SES Developer Guide.

- (void)sendRawEmail:(AWSSESSendRawEmailRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESSendRawEmailResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SendRawEmail service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorMessageRejected, AWSSESErrorMailFromDomainNotVerified.

Declared In

AWSSESService.h

– setActiveReceiptRuleSet:

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.

This action is throttled at one request per second.

- (AWSTask<AWSSESSetActiveReceiptRuleSetResponse*> *)setActiveReceiptRuleSet:(AWSSESSetActiveReceiptRuleSetRequest *)request

Parameters

request

A container for the necessary parameters to execute the SetActiveReceiptRuleSet service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESSetActiveReceiptRuleSetResponse. On failed execution, task.error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorRuleSetDoesNotExist.

Declared In

AWSSESService.h

– setActiveReceiptRuleSet:completionHandler:

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.

This action is throttled at one request per second.

- (void)setActiveReceiptRuleSet:(AWSSESSetActiveReceiptRuleSetRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESSetActiveReceiptRuleSetResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SetActiveReceiptRuleSet service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorRuleSetDoesNotExist.

Declared In

AWSSESService.h

– setIdentityDkimEnabled:

Enables or disables Easy DKIM signing of email sent from an identity:

  • If Easy DKIM signing is enabled for a domain name identity (e.g., example.com), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (e.g., user@example.com).

  • If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.

For email addresses (e.g., user@example.com), you can only enable Easy DKIM signing if the corresponding domain (e.g., example.com) has been set up for Easy DKIM using the AWS Console or the VerifyDomainDkim action.

This action is throttled at one request per second.

For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.

- (AWSTask<AWSSESSetIdentityDkimEnabledResponse*> *)setIdentityDkimEnabled:(AWSSESSetIdentityDkimEnabledRequest *)request

Parameters

request

A container for the necessary parameters to execute the SetIdentityDkimEnabled service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESSetIdentityDkimEnabledResponse.

Declared In

AWSSESService.h

– setIdentityDkimEnabled:completionHandler:

Enables or disables Easy DKIM signing of email sent from an identity:

  • If Easy DKIM signing is enabled for a domain name identity (e.g., example.com), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (e.g., user@example.com).

  • If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.

For email addresses (e.g., user@example.com), you can only enable Easy DKIM signing if the corresponding domain (e.g., example.com) has been set up for Easy DKIM using the AWS Console or the VerifyDomainDkim action.

This action is throttled at one request per second.

For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.

- (void)setIdentityDkimEnabled:(AWSSESSetIdentityDkimEnabledRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESSetIdentityDkimEnabledResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SetIdentityDkimEnabled service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– setIdentityFeedbackForwardingEnabled:

Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.

Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.

This action is throttled at one request per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

- (AWSTask<AWSSESSetIdentityFeedbackForwardingEnabledResponse*> *)setIdentityFeedbackForwardingEnabled:(AWSSESSetIdentityFeedbackForwardingEnabledRequest *)request

Parameters

request

A container for the necessary parameters to execute the SetIdentityFeedbackForwardingEnabled service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESSetIdentityFeedbackForwardingEnabledResponse.

Declared In

AWSSESService.h

– setIdentityFeedbackForwardingEnabled:completionHandler:

Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.

Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.

This action is throttled at one request per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

- (void)setIdentityFeedbackForwardingEnabled:(AWSSESSetIdentityFeedbackForwardingEnabledRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESSetIdentityFeedbackForwardingEnabledResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SetIdentityFeedbackForwardingEnabled service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– setIdentityHeadersInNotificationsEnabled:

Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.

This action is throttled at one request per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

- (AWSTask<AWSSESSetIdentityHeadersInNotificationsEnabledResponse*> *)setIdentityHeadersInNotificationsEnabled:(AWSSESSetIdentityHeadersInNotificationsEnabledRequest *)request

Parameters

request

A container for the necessary parameters to execute the SetIdentityHeadersInNotificationsEnabled service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESSetIdentityHeadersInNotificationsEnabledResponse.

Declared In

AWSSESService.h

– setIdentityHeadersInNotificationsEnabled:completionHandler:

Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.

This action is throttled at one request per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

- (void)setIdentityHeadersInNotificationsEnabled:(AWSSESSetIdentityHeadersInNotificationsEnabledRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESSetIdentityHeadersInNotificationsEnabledResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SetIdentityHeadersInNotificationsEnabled service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– setIdentityMailFromDomain:

Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).

To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain’s DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (AWSTask<AWSSESSetIdentityMailFromDomainResponse*> *)setIdentityMailFromDomain:(AWSSESSetIdentityMailFromDomainRequest *)request

Parameters

request

A container for the necessary parameters to execute the SetIdentityMailFromDomain service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESSetIdentityMailFromDomainResponse.

Declared In

AWSSESService.h

– setIdentityMailFromDomain:completionHandler:

Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).

To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain’s DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

- (void)setIdentityMailFromDomain:(AWSSESSetIdentityMailFromDomainRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESSetIdentityMailFromDomainResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SetIdentityMailFromDomain service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– setIdentityNotificationTopic:

Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that identity as the Source.

Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications. For more information, see SetIdentityFeedbackForwardingEnabled.

This action is throttled at one request per second.

For more information about feedback notification, see the Amazon SES Developer Guide.

- (AWSTask<AWSSESSetIdentityNotificationTopicResponse*> *)setIdentityNotificationTopic:(AWSSESSetIdentityNotificationTopicRequest *)request

Parameters

request

A container for the necessary parameters to execute the SetIdentityNotificationTopic service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESSetIdentityNotificationTopicResponse.

Declared In

AWSSESService.h

– setIdentityNotificationTopic:completionHandler:

Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that identity as the Source.

Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications. For more information, see SetIdentityFeedbackForwardingEnabled.

This action is throttled at one request per second.

For more information about feedback notification, see the Amazon SES Developer Guide.

- (void)setIdentityNotificationTopic:(AWSSESSetIdentityNotificationTopicRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESSetIdentityNotificationTopicResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SetIdentityNotificationTopic service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– setReceiptRulePosition:

Sets the position of the specified receipt rule in the receipt rule set.

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

This action is throttled at one request per second.

- (AWSTask<AWSSESSetReceiptRulePositionResponse*> *)setReceiptRulePosition:(AWSSESSetReceiptRulePositionRequest *)request

Parameters

request

A container for the necessary parameters to execute the SetReceiptRulePosition service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESSetReceiptRulePositionResponse. On failed execution, task.error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorRuleSetDoesNotExist, AWSSESErrorRuleDoesNotExist.

Declared In

AWSSESService.h

– setReceiptRulePosition:completionHandler:

Sets the position of the specified receipt rule in the receipt rule set.

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

This action is throttled at one request per second.

- (void)setReceiptRulePosition:(AWSSESSetReceiptRulePositionRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESSetReceiptRulePositionResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SetReceiptRulePosition service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorRuleSetDoesNotExist, AWSSESErrorRuleDoesNotExist.

Declared In

AWSSESService.h

– updateReceiptRule:

Updates a receipt rule.

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

This action is throttled at one request per second.

- (AWSTask<AWSSESUpdateReceiptRuleResponse*> *)updateReceiptRule:(AWSSESUpdateReceiptRuleRequest *)request

Parameters

request

A container for the necessary parameters to execute the UpdateReceiptRule service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESUpdateReceiptRuleResponse. On failed execution, task.error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorInvalidSnsTopic, AWSSESErrorInvalidS3Configuration, AWSSESErrorInvalidLambdaFunction, AWSSESErrorRuleSetDoesNotExist, AWSSESErrorRuleDoesNotExist, AWSSESErrorLimitExceeded.

Declared In

AWSSESService.h

– updateReceiptRule:completionHandler:

Updates a receipt rule.

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

This action is throttled at one request per second.

- (void)updateReceiptRule:(AWSSESUpdateReceiptRuleRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESUpdateReceiptRuleResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateReceiptRule service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSESErrorDomain domain and the following error code: AWSSESErrorInvalidSnsTopic, AWSSESErrorInvalidS3Configuration, AWSSESErrorInvalidLambdaFunction, AWSSESErrorRuleSetDoesNotExist, AWSSESErrorRuleDoesNotExist, AWSSESErrorLimitExceeded.

Declared In

AWSSESService.h

– verifyDomainDkim:

Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain.

This action is throttled at one request per second.

To enable or disable Easy DKIM signing for a domain, use the SetIdentityDkimEnabled action.

For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.

- (AWSTask<AWSSESVerifyDomainDkimResponse*> *)verifyDomainDkim:(AWSSESVerifyDomainDkimRequest *)request

Parameters

request

A container for the necessary parameters to execute the VerifyDomainDkim service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESVerifyDomainDkimResponse.

Declared In

AWSSESService.h

– verifyDomainDkim:completionHandler:

Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain.

This action is throttled at one request per second.

To enable or disable Easy DKIM signing for a domain, use the SetIdentityDkimEnabled action.

For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.

- (void)verifyDomainDkim:(AWSSESVerifyDomainDkimRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESVerifyDomainDkimResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the VerifyDomainDkim service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– verifyDomainIdentity:

Verifies a domain.

This action is throttled at one request per second.

- (AWSTask<AWSSESVerifyDomainIdentityResponse*> *)verifyDomainIdentity:(AWSSESVerifyDomainIdentityRequest *)request

Parameters

request

A container for the necessary parameters to execute the VerifyDomainIdentity service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESVerifyDomainIdentityResponse.

Declared In

AWSSESService.h

– verifyDomainIdentity:completionHandler:

Verifies a domain.

This action is throttled at one request per second.

- (void)verifyDomainIdentity:(AWSSESVerifyDomainIdentityRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESVerifyDomainIdentityResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the VerifyDomainIdentity service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– verifyEmailAddress:

Verifies an email address. This action causes a confirmation email message to be sent to the specified address.

The VerifyEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The VerifyEmailIdentity action is now preferred.

This action is throttled at one request per second.

- (AWSTask *)verifyEmailAddress:(AWSSESVerifyEmailAddressRequest *)request

Parameters

request

A container for the necessary parameters to execute the VerifyEmailAddress service method.

Return Value

An instance of AWSTask. On successful execution, task.result will be nil.

Declared In

AWSSESService.h

– verifyEmailAddress:completionHandler:

Verifies an email address. This action causes a confirmation email message to be sent to the specified address.

The VerifyEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The VerifyEmailIdentity action is now preferred.

This action is throttled at one request per second.

- (void)verifyEmailAddress:(AWSSESVerifyEmailAddressRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the VerifyEmailAddress service method.

completionHandler

The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h

– verifyEmailIdentity:

Verifies an email address. This action causes a confirmation email message to be sent to the specified address.

This action is throttled at one request per second.

- (AWSTask<AWSSESVerifyEmailIdentityResponse*> *)verifyEmailIdentity:(AWSSESVerifyEmailIdentityRequest *)request

Parameters

request

A container for the necessary parameters to execute the VerifyEmailIdentity service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSESVerifyEmailIdentityResponse.

Declared In

AWSSESService.h

– verifyEmailIdentity:completionHandler:

Verifies an email address. This action causes a confirmation email message to be sent to the specified address.

This action is throttled at one request per second.

- (void)verifyEmailIdentity:(AWSSESVerifyEmailIdentityRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSSESVerifyEmailIdentityResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the VerifyEmailIdentity service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

Declared In

AWSSESService.h