Skip to content

mailslurp.api.InboxForwarderControllerApi

Load the API package

import 'package:mailslurp/api.dart';

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

Method HTTP request Description
createNewInboxForwarder POST /forwarders Create an inbox forwarder
deleteInboxForwarder DELETE /forwarders/{id} Delete an inbox forwarder
deleteInboxForwarders DELETE /forwarders Delete inbox forwarders
getInboxForwarder GET /forwarders/{id} Get an inbox forwarder
getInboxForwarders GET /forwarders List inbox forwarders
testInboxForwarder POST /forwarders/{id}/test Test an inbox forwarder
testInboxForwardersForInbox PUT /forwarders Test inbox forwarders for inbox
testNewInboxForwarder PATCH /forwarders Test new inbox forwarder

InboxForwarderDto createNewInboxForwarder(inboxId, createInboxForwarderOptions)

Create an inbox forwarder

Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Example

import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';

final api_instance = InboxForwarderControllerApi();
final inboxId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Inbox id to attach forwarder to
final createInboxForwarderOptions = CreateInboxForwarderOptions(); // CreateInboxForwarderOptions | 

try { 
    final result = api_instance.createNewInboxForwarder(inboxId, createInboxForwarderOptions);
    print(result);
} catch (e) {
    print('Exception when calling InboxForwarderControllerApi->createNewInboxForwarder: $en');
}

Parameters

Name Type Description Notes
inboxId String Inbox id to attach forwarder to
createInboxForwarderOptions CreateInboxForwarderOptions

Return type

InboxForwarderDto

Authorization

API_KEY

HTTP request headers

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

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

deleteInboxForwarder(id)

Delete an inbox forwarder

Delete inbox forwarder

Example

import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';

final api_instance = InboxForwarderControllerApi();
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | ID of inbox forwarder

try { 
    api_instance.deleteInboxForwarder(id);
} catch (e) {
    print('Exception when calling InboxForwarderControllerApi->deleteInboxForwarder: $en');
}

Parameters

Name Type Description Notes
id String ID of inbox forwarder

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

deleteInboxForwarders(inboxId)

Delete inbox forwarders

Delete inbox forwarders. Accepts optional inboxId filter.

Example

import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';

final api_instance = InboxForwarderControllerApi();
final inboxId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Optional inbox id to attach forwarder to

try { 
    api_instance.deleteInboxForwarders(inboxId);
} catch (e) {
    print('Exception when calling InboxForwarderControllerApi->deleteInboxForwarders: $en');
}

Parameters

Name Type Description Notes
inboxId String Optional inbox id to attach forwarder to [optional]

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

InboxForwarderDto getInboxForwarder(id)

Get an inbox forwarder

Get inbox ruleset

Example

import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';

final api_instance = InboxForwarderControllerApi();
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | ID of inbox forwarder

try { 
    final result = api_instance.getInboxForwarder(id);
    print(result);
} catch (e) {
    print('Exception when calling InboxForwarderControllerApi->getInboxForwarder: $en');
}

Parameters

Name Type Description Notes
id String ID of inbox forwarder

Return type

InboxForwarderDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

PageInboxForwarderDto getInboxForwarders(inboxId, page, size, sort, searchFilter, since, before)

List inbox forwarders

List all forwarders attached to an inbox

Example

import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';

final api_instance = InboxForwarderControllerApi();
final inboxId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Optional inbox id to get forwarders from
final page = 56; // int | Optional page  in inbox forwarder list pagination
final size = 56; // int | Optional page size in inbox forwarder list pagination
final sort = sort_example; // String | Optional createdAt sort direction ASC or DESC
final searchFilter = searchFilter_example; // String | Optional search filter
final since = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at after the given timestamp
final before = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at before the given timestamp

try { 
    final result = api_instance.getInboxForwarders(inboxId, page, size, sort, searchFilter, since, before);
    print(result);
} catch (e) {
    print('Exception when calling InboxForwarderControllerApi->getInboxForwarders: $en');
}

Parameters

Name Type Description Notes
inboxId String Optional inbox id to get forwarders from [optional]
page int Optional page in inbox forwarder list pagination [optional] [default to 0]
size int Optional page size in inbox forwarder list pagination [optional] [default to 20]
sort String Optional createdAt sort direction ASC or DESC [optional] [default to 'ASC']
searchFilter String Optional search filter [optional]
since DateTime Filter by created at after the given timestamp [optional]
before DateTime Filter by created at before the given timestamp [optional]

Return type

PageInboxForwarderDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

InboxForwarderTestResult testInboxForwarder(id, inboxForwarderTestOptions)

Test an inbox forwarder

Test an inbox forwarder

Example

import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';

final api_instance = InboxForwarderControllerApi();
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | ID of inbox forwarder
final inboxForwarderTestOptions = InboxForwarderTestOptions(); // InboxForwarderTestOptions | 

try { 
    final result = api_instance.testInboxForwarder(id, inboxForwarderTestOptions);
    print(result);
} catch (e) {
    print('Exception when calling InboxForwarderControllerApi->testInboxForwarder: $en');
}

Parameters

Name Type Description Notes
id String ID of inbox forwarder
inboxForwarderTestOptions InboxForwarderTestOptions

Return type

InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

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

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

InboxForwarderTestResult testInboxForwardersForInbox(inboxId, inboxForwarderTestOptions)

Test inbox forwarders for inbox

Test inbox forwarders for inbox

Example

import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';

final api_instance = InboxForwarderControllerApi();
final inboxId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | ID of inbox
final inboxForwarderTestOptions = InboxForwarderTestOptions(); // InboxForwarderTestOptions | 

try { 
    final result = api_instance.testInboxForwardersForInbox(inboxId, inboxForwarderTestOptions);
    print(result);
} catch (e) {
    print('Exception when calling InboxForwarderControllerApi->testInboxForwardersForInbox: $en');
}

Parameters

Name Type Description Notes
inboxId String ID of inbox
inboxForwarderTestOptions InboxForwarderTestOptions

Return type

InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

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

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

InboxForwarderTestResult testNewInboxForwarder(testNewInboxForwarderOptions)

Test new inbox forwarder

Test new inbox forwarder

Example

import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';

final api_instance = InboxForwarderControllerApi();
final testNewInboxForwarderOptions = TestNewInboxForwarderOptions(); // TestNewInboxForwarderOptions | 

try { 
    final result = api_instance.testNewInboxForwarder(testNewInboxForwarderOptions);
    print(result);
} catch (e) {
    print('Exception when calling InboxForwarderControllerApi->testNewInboxForwarder: $en');
}

Parameters

Name Type Description Notes
testNewInboxForwarderOptions TestNewInboxForwarderOptions

Return type

InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

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

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