mailslurp_client.WaitForControllerApi

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

MethodHTTP requestDescription
wait_forPOST /waitForWait for conditions to be met
wait_for_email_countGET /waitForEmailCountWait for and return count number of emails
wait_for_latest_emailGET /waitForLatestEmailFetch inbox's latest email or if empty wait for an email to arrive
wait_for_matching_emailPOST /waitForMatchingEmailsWait or return list of emails that match simple matching patterns
wait_for_matching_first_emailPOST /waitForMatchingFirstEmailWait for or return the first email that matches proved MatchOptions array
wait_for_nth_emailGET /waitForNthEmailWait for or fetch the email with a given index in the inbox specified

wait_for

list[EmailPreview] wait_for(wait_for_conditions=wait_for_conditions)

Wait for conditions to be met

Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met

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.WaitForControllerApi(api_client)
    wait_for_conditions = mailslurp_client.WaitForConditions() # WaitForConditions | Conditions to wait for (optional)

    try:
        # Wait for conditions to be met
        api_response = api_instance.wait_for(wait_for_conditions=wait_for_conditions)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WaitForControllerApi->wait_for: %s\n" % e)

Parameters

NameTypeDescriptionNotes
wait_for_conditionsWaitForConditionsConditions to wait for[optional]

Return type

**list[EmailPreview]**

Authorization

API_KEY

HTTP request headers

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

HTTP response details

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

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

wait_for_email_count

list[EmailPreview] wait_for_email_count(count=count, inbox_id=inbox_id, timeout=timeout, unread_only=unread_only)

Wait for and return count number of emails

If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.

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.WaitForControllerApi(api_client)
    count = 56 # int | Number of emails to wait for. Must be greater that 1 (optional)
inbox_id = 'inbox_id_example' # str | Id of the inbox we are fetching emails from (optional)
timeout = 56 # int | Max milliseconds to wait (optional)
unread_only = False # bool | Optional filter for unread only (optional) (default to False)

    try:
        # Wait for and return count number of emails 
        api_response = api_instance.wait_for_email_count(count=count, inbox_id=inbox_id, timeout=timeout, unread_only=unread_only)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WaitForControllerApi->wait_for_email_count: %s\n" % e)

Parameters

NameTypeDescriptionNotes
countintNumber of emails to wait for. Must be greater that 1[optional]
inbox_idstrId of the inbox we are fetching emails from[optional]
timeoutintMax milliseconds to wait[optional]
unread_onlyboolOptional filter for unread only[optional] [default to False]

Return type

**list[EmailPreview]**

Authorization

API_KEY

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
401Unauthorized-
403Forbidden-
404Not Found-

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

wait_for_latest_email

Email wait_for_latest_email(inbox_id=inbox_id, timeout=timeout, unread_only=unread_only)

Fetch inbox’s latest email or if empty wait for an email to arrive

Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox set unreadOnly=true or see the other receive methods such as waitForNthEmail or waitForEmailCount.

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.WaitForControllerApi(api_client)
    inbox_id = 'inbox_id_example' # str | Id of the inbox we are fetching emails from (optional)
timeout = 56 # int | Max milliseconds to wait (optional)
unread_only = False # bool | Optional filter for unread only. (optional) (default to False)

    try:
        # Fetch inbox's latest email or if empty wait for an email to arrive
        api_response = api_instance.wait_for_latest_email(inbox_id=inbox_id, timeout=timeout, unread_only=unread_only)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WaitForControllerApi->wait_for_latest_email: %s\n" % e)

Parameters

NameTypeDescriptionNotes
inbox_idstrId of the inbox we are fetching emails from[optional]
timeoutintMax milliseconds to wait[optional]
unread_onlyboolOptional filter for unread only.[optional] [default to False]

Return type

Email

Authorization

API_KEY

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
401Unauthorized-
403Forbidden-
404Not Found-

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

wait_for_matching_email

list[EmailPreview] wait_for_matching_email(match_options, count=count, inbox_id=inbox_id, timeout=timeout, unread_only=unread_only)

Wait or return list of emails that match simple matching patterns

Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the MatchOptions object for options. An example payload is { matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController getEmailContentMatch method.

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.WaitForControllerApi(api_client)
    match_options = mailslurp_client.MatchOptions() # MatchOptions | matchOptions
count = 56 # int | Number of emails to wait for. Must be greater that 1 (optional)
inbox_id = 'inbox_id_example' # str | Id of the inbox we are fetching emails from (optional)
timeout = 56 # int | Max milliseconds to wait (optional)
unread_only = False # bool | Optional filter for unread only (optional) (default to False)

    try:
        # Wait or return list of emails that match simple matching patterns
        api_response = api_instance.wait_for_matching_email(match_options, count=count, inbox_id=inbox_id, timeout=timeout, unread_only=unread_only)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WaitForControllerApi->wait_for_matching_email: %s\n" % e)

Parameters

NameTypeDescriptionNotes
match_optionsMatchOptionsmatchOptions
countintNumber of emails to wait for. Must be greater that 1[optional]
inbox_idstrId of the inbox we are fetching emails from[optional]
timeoutintMax milliseconds to wait[optional]
unread_onlyboolOptional filter for unread only[optional] [default to False]

Return type

**list[EmailPreview]**

Authorization

API_KEY

HTTP request headers

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

HTTP response details

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

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

wait_for_matching_first_email

Email wait_for_matching_first_email(match_options, inbox_id=inbox_id, timeout=timeout, unread_only=unread_only)

Wait for or return the first email that matches proved MatchOptions array

Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the MatchOptions object for options. An example payload is { matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController getEmailContentMatch method.

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.WaitForControllerApi(api_client)
    match_options = mailslurp_client.MatchOptions() # MatchOptions | matchOptions
inbox_id = 'inbox_id_example' # str | Id of the inbox we are matching an email for (optional)
timeout = 56 # int | Max milliseconds to wait (optional)
unread_only = False # bool | Optional filter for unread only (optional) (default to False)

    try:
        # Wait for or return the first email that matches proved MatchOptions array
        api_response = api_instance.wait_for_matching_first_email(match_options, inbox_id=inbox_id, timeout=timeout, unread_only=unread_only)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WaitForControllerApi->wait_for_matching_first_email: %s\n" % e)

Parameters

NameTypeDescriptionNotes
match_optionsMatchOptionsmatchOptions
inbox_idstrId of the inbox we are matching an email for[optional]
timeoutintMax milliseconds to wait[optional]
unread_onlyboolOptional filter for unread only[optional] [default to False]

Return type

Email

Authorization

API_KEY

HTTP request headers

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

HTTP response details

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

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

wait_for_nth_email

Email wait_for_nth_email(inbox_id=inbox_id, index=index, timeout=timeout, unread_only=unread_only)

Wait for or fetch the email with a given index in the inbox specified

If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.

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.WaitForControllerApi(api_client)
    inbox_id = 'inbox_id_example' # str | Id of the inbox you are fetching emails from (optional)
index = 0 # int | Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1 (optional) (default to 0)
timeout = 56 # int | Max milliseconds to wait for the nth email if not already present (optional)
unread_only = False # bool | Optional filter for unread only (optional) (default to False)

    try:
        # Wait for or fetch the email with a given index in the inbox specified
        api_response = api_instance.wait_for_nth_email(inbox_id=inbox_id, index=index, timeout=timeout, unread_only=unread_only)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WaitForControllerApi->wait_for_nth_email: %s\n" % e)

Parameters

NameTypeDescriptionNotes
inbox_idstrId of the inbox you are fetching emails from[optional]
indexintZero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1[optional] [default to 0]
timeoutintMax milliseconds to wait for the nth email if not already present[optional]
unread_onlyboolOptional filter for unread only[optional] [default to False]

Return type

Email

Authorization

API_KEY

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
401Unauthorized-
403Forbidden-
404Not Found-

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