mailslurp_client.BulkActionsControllerApi

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

MethodHTTP requestDescription
bulk_create_inboxesPOST /bulk/inboxesBulk create Inboxes (email addresses)
bulk_delete_inboxesDELETE /bulk/inboxesBulk Delete Inboxes
bulk_send_emailsPOST /bulk/sendBulk Send Emails

bulk_create_inboxes

list[Inbox] bulk_create_inboxes(count)

Bulk create Inboxes (email addresses)

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://api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
    host = "https://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://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.BulkActionsControllerApi(api_client)
    count = 56 # int | Number of inboxes to be created in bulk

    try:
        # Bulk create Inboxes (email addresses)
        api_response = api_instance.bulk_create_inboxes(count)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BulkActionsControllerApi->bulk_create_inboxes: %sn" % e)

Parameters

NameTypeDescriptionNotes
countintNumber of inboxes to be created in bulk

Return type

**list[Inbox]**

Authorization

API_KEY

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
201Created-
401Unauthorized-
403Forbidden-
404Not Found-

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

bulk_delete_inboxes

bulk_delete_inboxes(ids)

Bulk Delete Inboxes

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://api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
    host = "https://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://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.BulkActionsControllerApi(api_client)
    ids = ['ids_example'] # list[str] | ids

    try:
        # Bulk Delete Inboxes
        api_instance.bulk_delete_inboxes(ids)
    except ApiException as e:
        print("Exception when calling BulkActionsControllerApi->bulk_delete_inboxes: %sn" % e)

Parameters

NameTypeDescriptionNotes
ids**list[str]**ids

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
204No Content-
401Unauthorized-
403Forbidden-

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

bulk_send_emails

bulk_send_emails(bulk_send_email_options)

Bulk Send Emails

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://api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
    host = "https://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://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.BulkActionsControllerApi(api_client)
    bulk_send_email_options = mailslurp_client.BulkSendEmailOptions() # BulkSendEmailOptions | bulkSendEmailOptions

    try:
        # Bulk Send Emails
        api_instance.bulk_send_emails(bulk_send_email_options)
    except ApiException as e:
        print("Exception when calling BulkActionsControllerApi->bulk_send_emails: %sn" % e)

Parameters

NameTypeDescriptionNotes
bulk_send_email_optionsBulkSendEmailOptionsbulkSendEmailOptions

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
201Created-
401Unauthorized-
403Forbidden-
404Not Found-

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