OAIBounceControllerApi

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

MethodHTTP requestDescription
getBouncedEmailGET /bounce/emails/{id}Get a bounced email.
getBouncedEmailsGET /bounce/emailsGet paginated list of bounced emails.
getBouncedRecipientGET /bounce/recipients/{id}Get a bounced email.
getBouncedRecipientsGET /bounce/recipientsGet paginated list of bounced recipients.

getBouncedEmail

-(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

NameTypeDescriptionNotes
_idNSString*ID of the bounced email to fetch

Return type

OAIBouncedEmailDto*

Authorization

API_KEY

HTTP request headers

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

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

getBouncedEmails

-(NSURLSessionTask*) getBouncedEmailsWithBefore: (NSDate*) before
    page: (NSNumber*) page
    since: (NSDate*) since
    size: (NSNumber*) size
    sort: (NSString*) sort
        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"];


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

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

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

Parameters

NameTypeDescriptionNotes
beforeNSDate*Filter by created at before the given timestamp[optional]
pageNSNumber*Optional page[optional] [default to @0]
sinceNSDate*Filter by created at after the given timestamp[optional]
sizeNSNumber*Optional page size[optional] [default to @20]
sortNSString*Optional createdAt sort direction ASC or DESC[optional] [default to @“ASC”]

Return type

OAIPageBouncedEmail*

Authorization

API_KEY

HTTP request headers

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

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

getBouncedRecipient

-(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

NameTypeDescriptionNotes
_idNSString*ID of the bounced recipient

Return type

OAIBouncedRecipientDto*

Authorization

API_KEY

HTTP request headers

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

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

getBouncedRecipients

-(NSURLSessionTask*) getBouncedRecipientsWithBefore: (NSDate*) before
    page: (NSNumber*) page
    since: (NSDate*) since
    size: (NSNumber*) size
    sort: (NSString*) sort
        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"];


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

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

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

Parameters

NameTypeDescriptionNotes
beforeNSDate*Filter by created at before the given timestamp[optional]
pageNSNumber*Optional page[optional] [default to @0]
sinceNSDate*Filter by created at after the given timestamp[optional]
sizeNSNumber*Optional page size[optional] [default to @20]
sortNSString*Optional createdAt sort direction ASC or DESC[optional] [default to @“ASC”]

Return type

OAIPageBouncedRecipients*

Authorization

API_KEY

HTTP request headers

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

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