Skip to content

mailslurp_client.InboxForwarderControllerApi

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

Method HTTP request Description
create_new_inbox_forwarder POST /forwarders Create an inbox forwarder
delete_inbox_forwarder DELETE /forwarders/{id} Delete an inbox forwarder
delete_inbox_forwarders DELETE /forwarders Delete inbox forwarders
get_inbox_forwarder GET /forwarders/{id} Get an inbox forwarder
get_inbox_forwarders GET /forwarders List inbox forwarders
test_inbox_forwarder POST /forwarders/{id}/test Test an inbox forwarder
test_inbox_forwarders_for_inbox PUT /forwarders Test inbox forwarders for inbox
test_new_inbox_forwarder PATCH /forwarders Test new inbox forwarder

InboxForwarderDto create_new_inbox_forwarder(inbox_id, create_inbox_forwarder_options)

Create an inbox forwarder

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

Example

  • Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://python.api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
    host = "https://python.api.mailslurp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
    host = "https://python.api.mailslurp.com",
    api_key = {
        'x-api-key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mailslurp_client.InboxForwarderControllerApi(api_client)
    inbox_id = 'inbox_id_example' # str | Inbox id to attach forwarder to
create_inbox_forwarder_options = mailslurp_client.CreateInboxForwarderOptions() # CreateInboxForwarderOptions | 

    try:
        # Create an inbox forwarder
        api_response = api_instance.create_new_inbox_forwarder(inbox_id, create_inbox_forwarder_options)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InboxForwarderControllerApi->create_new_inbox_forwarder: %sn" % e)

Parameters

Name Type Description Notes
inbox_id str Inbox id to attach forwarder to
create_inbox_forwarder_options CreateInboxForwarderOptions

Return type

InboxForwarderDto

Authorization

API_KEY

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

delete_inbox_forwarder(id)

Delete an inbox forwarder

Delete inbox forwarder

Example

  • Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://python.api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
    host = "https://python.api.mailslurp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
    host = "https://python.api.mailslurp.com",
    api_key = {
        'x-api-key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mailslurp_client.InboxForwarderControllerApi(api_client)
    id = 'id_example' # str | ID of inbox forwarder

    try:
        # Delete an inbox forwarder
        api_instance.delete_inbox_forwarder(id)
    except ApiException as e:
        print("Exception when calling InboxForwarderControllerApi->delete_inbox_forwarder: %sn" % e)

Parameters

Name Type Description Notes
id str ID of inbox forwarder

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 No Content -

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

delete_inbox_forwarders(inbox_id=inbox_id)

Delete inbox forwarders

Delete inbox forwarders. Accepts optional inboxId filter.

Example

  • Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://python.api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
    host = "https://python.api.mailslurp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
    host = "https://python.api.mailslurp.com",
    api_key = {
        'x-api-key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mailslurp_client.InboxForwarderControllerApi(api_client)
    inbox_id = 'inbox_id_example' # str | Optional inbox id to attach forwarder to (optional)

    try:
        # Delete inbox forwarders
        api_instance.delete_inbox_forwarders(inbox_id=inbox_id)
    except ApiException as e:
        print("Exception when calling InboxForwarderControllerApi->delete_inbox_forwarders: %sn" % e)

Parameters

Name Type Description Notes
inbox_id str 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

HTTP response details

Status code Description Response headers
204 No Content -

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

InboxForwarderDto get_inbox_forwarder(id)

Get an inbox forwarder

Get inbox ruleset

Example

  • Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://python.api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
    host = "https://python.api.mailslurp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
    host = "https://python.api.mailslurp.com",
    api_key = {
        'x-api-key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mailslurp_client.InboxForwarderControllerApi(api_client)
    id = 'id_example' # str | ID of inbox forwarder

    try:
        # Get an inbox forwarder
        api_response = api_instance.get_inbox_forwarder(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InboxForwarderControllerApi->get_inbox_forwarder: %sn" % e)

Parameters

Name Type Description Notes
id str ID of inbox forwarder

Return type

InboxForwarderDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -

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

PageInboxForwarderDto get_inbox_forwarders(inbox_id=inbox_id, page=page, size=size, sort=sort, search_filter=search_filter, since=since, before=before)

List inbox forwarders

List all forwarders attached to an inbox

Example

  • Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://python.api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
    host = "https://python.api.mailslurp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
    host = "https://python.api.mailslurp.com",
    api_key = {
        'x-api-key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mailslurp_client.InboxForwarderControllerApi(api_client)
    inbox_id = 'inbox_id_example' # str | Optional inbox id to get forwarders from (optional)
page = 0 # int | Optional page  in inbox forwarder list pagination (optional) (default to 0)
size = 20 # int | Optional page size in inbox forwarder list pagination (optional) (default to 20)
sort = 'ASC' # str | Optional createdAt sort direction ASC or DESC (optional) (default to 'ASC')
search_filter = 'search_filter_example' # str | Optional search filter (optional)
since = '2013-10-20T19:20:30+01:00' # datetime | Filter by created at after the given timestamp (optional)
before = '2013-10-20T19:20:30+01:00' # datetime | Filter by created at before the given timestamp (optional)

    try:
        # List inbox forwarders
        api_response = api_instance.get_inbox_forwarders(inbox_id=inbox_id, page=page, size=size, sort=sort, search_filter=search_filter, since=since, before=before)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InboxForwarderControllerApi->get_inbox_forwarders: %sn" % e)

Parameters

Name Type Description Notes
inbox_id str 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 str Optional createdAt sort direction ASC or DESC [optional] [default to 'ASC']
search_filter str 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: /

HTTP response details

Status code Description Response headers
200 OK -

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

InboxForwarderTestResult test_inbox_forwarder(id, inbox_forwarder_test_options)

Test an inbox forwarder

Test an inbox forwarder

Example

  • Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://python.api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
    host = "https://python.api.mailslurp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
    host = "https://python.api.mailslurp.com",
    api_key = {
        'x-api-key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mailslurp_client.InboxForwarderControllerApi(api_client)
    id = 'id_example' # str | ID of inbox forwarder
inbox_forwarder_test_options = mailslurp_client.InboxForwarderTestOptions() # InboxForwarderTestOptions | 

    try:
        # Test an inbox forwarder
        api_response = api_instance.test_inbox_forwarder(id, inbox_forwarder_test_options)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InboxForwarderControllerApi->test_inbox_forwarder: %sn" % e)

Parameters

Name Type Description Notes
id str ID of inbox forwarder
inbox_forwarder_test_options InboxForwarderTestOptions

Return type

InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

InboxForwarderTestResult test_inbox_forwarders_for_inbox(inbox_id, inbox_forwarder_test_options)

Test inbox forwarders for inbox

Test inbox forwarders for inbox

Example

  • Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://python.api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
    host = "https://python.api.mailslurp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
    host = "https://python.api.mailslurp.com",
    api_key = {
        'x-api-key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mailslurp_client.InboxForwarderControllerApi(api_client)
    inbox_id = 'inbox_id_example' # str | ID of inbox
inbox_forwarder_test_options = mailslurp_client.InboxForwarderTestOptions() # InboxForwarderTestOptions | 

    try:
        # Test inbox forwarders for inbox
        api_response = api_instance.test_inbox_forwarders_for_inbox(inbox_id, inbox_forwarder_test_options)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InboxForwarderControllerApi->test_inbox_forwarders_for_inbox: %sn" % e)

Parameters

Name Type Description Notes
inbox_id str ID of inbox
inbox_forwarder_test_options InboxForwarderTestOptions

Return type

InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

InboxForwarderTestResult test_new_inbox_forwarder(test_new_inbox_forwarder_options)

Test new inbox forwarder

Test new inbox forwarder

Example

  • Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://python.api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
    host = "https://python.api.mailslurp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
    host = "https://python.api.mailslurp.com",
    api_key = {
        'x-api-key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mailslurp_client.InboxForwarderControllerApi(api_client)
    test_new_inbox_forwarder_options = mailslurp_client.TestNewInboxForwarderOptions() # TestNewInboxForwarderOptions | 

    try:
        # Test new inbox forwarder
        api_response = api_instance.test_new_inbox_forwarder(test_new_inbox_forwarder_options)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InboxForwarderControllerApi->test_new_inbox_forwarder: %sn" % e)

Parameters

Name Type Description Notes
test_new_inbox_forwarder_options TestNewInboxForwarderOptions

Return type

InboxForwarderTestResult

Authorization

API_KEY

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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