Skip to content

OAIBounceControllerApi

All URIs are relative to https://api.mailslurp.com

Method HTTP request Description
filterBouncedRecipient POST /bounce/filter-recipients Filter a list of email recipients and remove those who have bounced
getBouncedEmail GET /bounce/emails/{id} Get a bounced email.
getBouncedEmails GET /bounce/emails Get paginated list of bounced emails.
getBouncedRecipient GET /bounce/recipients/{id} Get a bounced email.
getBouncedRecipients GET /bounce/recipients Get paginated list of bounced recipients. 
-(NSURLSessionTask*) filterBouncedRecipientWithFilterBouncedRecipientsOptions: (OAIFilterBouncedRecipientsOptions*) filterBouncedRecipientsOptions
        completionHandler: (void (^)(OAIFilterBouncedRecipientsResult* output, NSError* error)) handler;

Filter a list of email recipients and remove those who have bounced

Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


OAIFilterBouncedRecipientsOptions* filterBouncedRecipientsOptions = [[OAIFilterBouncedRecipientsOptions alloc] init]; // 

OAIBounceControllerApi*apiInstance = [[OAIBounceControllerApi alloc] init];

// Filter a list of email recipients and remove those who have bounced
[apiInstance filterBouncedRecipientWithFilterBouncedRecipientsOptions:filterBouncedRecipientsOptions
          completionHandler: ^(OAIFilterBouncedRecipientsResult* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIBounceControllerApi->filterBouncedRecipient: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
filterBouncedRecipientsOptions OAIFilterBouncedRecipientsOptions*

Return type

OAIFilterBouncedRecipientsResult*

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

-(NSURLSessionTask*) getBouncedEmailWithId: (NSString*) _id
        completionHandler: (void (^)(OAIBouncedEmailDto* output, NSError* error)) handler;

Get a bounced email.

Bounced emails are email you have sent that were rejected by a recipient

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


NSString* _id = @"_id_example"; // ID of the bounced email to fetch

OAIBounceControllerApi*apiInstance = [[OAIBounceControllerApi alloc] init];

// Get a bounced email.
[apiInstance getBouncedEmailWithId:_id
          completionHandler: ^(OAIBouncedEmailDto* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIBounceControllerApi->getBouncedEmail: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
_id NSString* ID of the bounced email to fetch

Return type

OAIBouncedEmailDto*

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

-(NSURLSessionTask*) getBouncedEmailsWithPage: (NSNumber*) page
    size: (NSNumber*) size
    sort: (NSString*) sort
    since: (NSDate*) since
    before: (NSDate*) before
        completionHandler: (void (^)(OAIPageBouncedEmail* output, NSError* error)) handler;

Get paginated list of bounced emails.

Bounced emails are email you have sent that were rejected by a recipient

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


NSNumber* page = @0; // Optional page  (optional) (default to @0)
NSNumber* size = @20; // Optional page size  (optional) (default to @20)
NSString* sort = @"ASC"; // Optional createdAt sort direction ASC or DESC (optional) (default to @"ASC")
NSDate* since = @"2013-10-20T19:20:30+01:00"; // Filter by created at after the given timestamp (optional)
NSDate* before = @"2013-10-20T19:20:30+01:00"; // Filter by created at before the given timestamp (optional)

OAIBounceControllerApi*apiInstance = [[OAIBounceControllerApi alloc] init];

// Get paginated list of bounced emails.
[apiInstance getBouncedEmailsWithPage:page
              size:size
              sort:sort
              since:since
              before:before
          completionHandler: ^(OAIPageBouncedEmail* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIBounceControllerApi->getBouncedEmails: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
page NSNumber* Optional page [optional] [default to @0]
size NSNumber* Optional page size [optional] [default to @20]
sort NSString* Optional createdAt sort direction ASC or DESC [optional] [default to @"ASC"]
since NSDate* Filter by created at after the given timestamp [optional]
before NSDate* Filter by created at before the given timestamp [optional]

Return type

OAIPageBouncedEmail*

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

-(NSURLSessionTask*) getBouncedRecipientWithId: (NSString*) _id
        completionHandler: (void (^)(OAIBouncedRecipientDto* output, NSError* error)) handler;

Get a bounced email.

Bounced emails are email you have sent that were rejected by a recipient

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


NSString* _id = @"_id_example"; // ID of the bounced recipient

OAIBounceControllerApi*apiInstance = [[OAIBounceControllerApi alloc] init];

// Get a bounced email.
[apiInstance getBouncedRecipientWithId:_id
          completionHandler: ^(OAIBouncedRecipientDto* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIBounceControllerApi->getBouncedRecipient: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
_id NSString* ID of the bounced recipient

Return type

OAIBouncedRecipientDto*

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

-(NSURLSessionTask*) getBouncedRecipientsWithPage: (NSNumber*) page
    size: (NSNumber*) size
    sort: (NSString*) sort
    since: (NSDate*) since
    before: (NSDate*) before
        completionHandler: (void (^)(OAIPageBouncedRecipients* output, NSError* error)) handler;

Get paginated list of bounced recipients.

Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address.

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


NSNumber* page = @0; // Optional page   (optional) (default to @0)
NSNumber* size = @20; // Optional page size  (optional) (default to @20)
NSString* sort = @"ASC"; // Optional createdAt sort direction ASC or DESC (optional) (default to @"ASC")
NSDate* since = @"2013-10-20T19:20:30+01:00"; // Filter by created at after the given timestamp (optional)
NSDate* before = @"2013-10-20T19:20:30+01:00"; // Filter by created at before the given timestamp (optional)

OAIBounceControllerApi*apiInstance = [[OAIBounceControllerApi alloc] init];

// Get paginated list of bounced recipients.
[apiInstance getBouncedRecipientsWithPage:page
              size:size
              sort:sort
              since:since
              before:before
          completionHandler: ^(OAIPageBouncedRecipients* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIBounceControllerApi->getBouncedRecipients: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
page NSNumber* Optional page [optional] [default to @0]
size NSNumber* Optional page size [optional] [default to @20]
sort NSString* Optional createdAt sort direction ASC or DESC [optional] [default to @"ASC"]
since NSDate* Filter by created at after the given timestamp [optional]
before NSDate* Filter by created at before the given timestamp [optional]

Return type

OAIPageBouncedRecipients*

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]