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

MethodHTTP requestDescription
WaitForPOST /waitForWait for an email to match the provided filter conditions such as subject contains keyword.
WaitForEmailCountGET /waitForEmailCountWait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
WaitForLatestEmailGET /waitForLatestEmailFetch inbox’s latest email or if empty wait for an email to arrive
WaitForMatchingEmailsPOST /waitForMatchingEmailsWait or return list of emails that match simple matching patterns
WaitForMatchingFirstEmailPOST /waitForMatchingFirstEmailWait for or return the first email that matches provided MatchOptions array
WaitForNthEmailGET /waitForNthEmailWait for or fetch the email with a given in the inbox specified. If doesn’t exist waits for it to exist or timeout to occur.

List WaitFor (WaitForConditions waitForConditions)

Wait for an email to match the provided filter conditions such as subject contains keyword.

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;

namespace Example
{
    public class WaitForExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mailslurp.com";
            // Configure API key authorization: API_KEY
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new WaitForControllerApi(config);
            var waitForConditions = new WaitForConditions(); // WaitForConditions | 

            try
            {
                // Wait for an email to match the provided filter conditions such as subject contains keyword.
                List<EmailPreview> result = apiInstance.WaitFor(waitForConditions);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WaitForControllerApi.WaitFor: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
waitForConditionsWaitForConditions

Return type

List

Authorization

API_KEY

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-

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

List WaitForEmailCount (Guid inboxId, int count, long? timeout = null, bool? unreadOnly = null, DateTime? before = null, DateTime? since = null, string sort = null, long? delay = null)

Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs

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

using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;

namespace Example
{
    public class WaitForEmailCountExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mailslurp.com";
            // Configure API key authorization: API_KEY
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new WaitForControllerApi(config);
            var inboxId = new Guid(); // Guid | Id of the inbox we are fetching emails from
            var count = 56;  // int | Number of emails to wait for. Must be greater that 1
            var timeout = 789;  // long? | Max milliseconds to wait (optional) 
            var unreadOnly = true;  // bool? | Optional filter for unread only (optional)  (default to false)
            var before = 2013-10-20T19:20:30+01:00;  // DateTime? | Filter for emails that were received before the given timestamp (optional) 
            var since = 2013-10-20T19:20:30+01:00;  // DateTime? | Filter for emails that were received after the given timestamp (optional) 
            var sort = sort_example;  // string | Sort direction (optional) 
            var delay = 789;  // long? | Max milliseconds delay between calls (optional) 

            try
            {
                // Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
                List<EmailPreview> result = apiInstance.WaitForEmailCount(inboxId, count, timeout, unreadOnly, before, since, sort, delay);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WaitForControllerApi.WaitForEmailCount: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
inboxIdGuidId of the inbox we are fetching emails from
countintNumber of emails to wait for. Must be greater that 1
timeoutlong?Max milliseconds to wait[optional]
unreadOnlybool?Optional filter for unread only[optional] [default to false]
beforeDateTime?Filter for emails that were received before the given timestamp[optional]
sinceDateTime?Filter for emails that were received after the given timestamp[optional]
sortstringSort direction[optional]
delaylong?Max milliseconds delay between calls[optional]

Return type

List

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-

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

Email WaitForLatestEmail (Guid? inboxId = null, long? timeout = null, bool? unreadOnly = null, DateTime? before = null, DateTime? since = null, string sort = null, long? delay = null)

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

using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;

namespace Example
{
    public class WaitForLatestEmailExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mailslurp.com";
            // Configure API key authorization: API_KEY
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new WaitForControllerApi(config);
            var inboxId = new Guid?(); // Guid? | Id of the inbox we are fetching emails from (optional) 
            var timeout = 789;  // long? | Max milliseconds to wait (optional) 
            var unreadOnly = true;  // bool? | Optional filter for unread only. (optional)  (default to false)
            var before = 2013-10-20T19:20:30+01:00;  // DateTime? | Filter for emails that were before after the given timestamp (optional) 
            var since = 2013-10-20T19:20:30+01:00;  // DateTime? | Filter for emails that were received after the given timestamp (optional) 
            var sort = sort_example;  // string | Sort direction (optional) 
            var delay = 789;  // long? | Max milliseconds delay between calls (optional) 

            try
            {
                // Fetch inbox's latest email or if empty wait for an email to arrive
                Email result = apiInstance.WaitForLatestEmail(inboxId, timeout, unreadOnly, before, since, sort, delay);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WaitForControllerApi.WaitForLatestEmail: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
inboxIdGuid?Id of the inbox we are fetching emails from[optional]
timeoutlong?Max milliseconds to wait[optional]
unreadOnlybool?Optional filter for unread only.[optional] [default to false]
beforeDateTime?Filter for emails that were before after the given timestamp[optional]
sinceDateTime?Filter for emails that were received after the given timestamp[optional]
sortstringSort direction[optional]
delaylong?Max milliseconds delay between calls[optional]

Return type

Email

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-

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

List WaitForMatchingEmails (Guid inboxId, int count, MatchOptions matchOptions, DateTime? before = null, DateTime? since = null, string sort = null, long? delay = null, long? timeout = null, bool? unreadOnly = null)

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

using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;

namespace Example
{
    public class WaitForMatchingEmailsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mailslurp.com";
            // Configure API key authorization: API_KEY
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new WaitForControllerApi(config);
            var inboxId = new Guid(); // Guid | Id of the inbox we are fetching emails from
            var count = 56;  // int | Number of emails to wait for. Must be greater or equal to 1
            var matchOptions = new MatchOptions(); // MatchOptions | 
            var before = 2013-10-20T19:20:30+01:00;  // DateTime? | Filter for emails that were received before the given timestamp (optional) 
            var since = 2013-10-20T19:20:30+01:00;  // DateTime? | Filter for emails that were received after the given timestamp (optional) 
            var sort = sort_example;  // string | Sort direction (optional) 
            var delay = 789;  // long? | Max milliseconds delay between calls (optional) 
            var timeout = 789;  // long? | Max milliseconds to wait (optional) 
            var unreadOnly = true;  // bool? | Optional filter for unread only (optional)  (default to false)

            try
            {
                // Wait or return list of emails that match simple matching patterns
                List<EmailPreview> result = apiInstance.WaitForMatchingEmails(inboxId, count, matchOptions, before, since, sort, delay, timeout, unreadOnly);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WaitForControllerApi.WaitForMatchingEmails: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
inboxIdGuidId of the inbox we are fetching emails from
countintNumber of emails to wait for. Must be greater or equal to 1
matchOptionsMatchOptions
beforeDateTime?Filter for emails that were received before the given timestamp[optional]
sinceDateTime?Filter for emails that were received after the given timestamp[optional]
sortstringSort direction[optional]
delaylong?Max milliseconds delay between calls[optional]
timeoutlong?Max milliseconds to wait[optional]
unreadOnlybool?Optional filter for unread only[optional] [default to false]

Return type

List

Authorization

API_KEY

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-

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

Email WaitForMatchingFirstEmail (Guid inboxId, MatchOptions matchOptions, long? timeout = null, bool? unreadOnly = null, DateTime? since = null, DateTime? before = null, string sort = null, long? delay = null)

Wait for or return the first email that matches provided 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

using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;

namespace Example
{
    public class WaitForMatchingFirstEmailExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mailslurp.com";
            // Configure API key authorization: API_KEY
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new WaitForControllerApi(config);
            var inboxId = new Guid(); // Guid | Id of the inbox we are matching an email for
            var matchOptions = new MatchOptions(); // MatchOptions | 
            var timeout = 789;  // long? | Max milliseconds to wait (optional) 
            var unreadOnly = true;  // bool? | Optional filter for unread only (optional)  (default to false)
            var since = 2013-10-20T19:20:30+01:00;  // DateTime? | Filter for emails that were received after the given timestamp (optional) 
            var before = 2013-10-20T19:20:30+01:00;  // DateTime? | Filter for emails that were received before the given timestamp (optional) 
            var sort = sort_example;  // string | Sort direction (optional) 
            var delay = 789;  // long? | Max milliseconds delay between calls (optional) 

            try
            {
                // Wait for or return the first email that matches provided MatchOptions array
                Email result = apiInstance.WaitForMatchingFirstEmail(inboxId, matchOptions, timeout, unreadOnly, since, before, sort, delay);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WaitForControllerApi.WaitForMatchingFirstEmail: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
inboxIdGuidId of the inbox we are matching an email for
matchOptionsMatchOptions
timeoutlong?Max milliseconds to wait[optional]
unreadOnlybool?Optional filter for unread only[optional] [default to false]
sinceDateTime?Filter for emails that were received after the given timestamp[optional]
beforeDateTime?Filter for emails that were received before the given timestamp[optional]
sortstringSort direction[optional]
delaylong?Max milliseconds delay between calls[optional]

Return type

Email

Authorization

API_KEY

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-

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

Email WaitForNthEmail (Guid? inboxId = null, int? = null, long? timeout = null, bool? unreadOnly = null, DateTime? since = null, DateTime? before = null, string sort = null, long? delay = null)

Wait for or fetch the email with a given in the inbox specified. If doesn’t exist waits for it to exist or timeout to occur.

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

using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;

namespace Example
{
    public class WaitForNthEmailExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mailslurp.com";
            // Configure API key authorization: API_KEY
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new WaitForControllerApi(config);
            var inboxId = new Guid?(); // Guid? | Id of the inbox you are fetching emails from (optional) 
            var  = 56;  // int? | Zero based  of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass =1 (optional)  (default to 0)
            var timeout = 789;  // long? | Max milliseconds to wait for the nth email if not already present (optional) 
            var unreadOnly = true;  // bool? | Optional filter for unread only (optional)  (default to false)
            var since = 2013-10-20T19:20:30+01:00;  // DateTime? | Filter for emails that were received after the given timestamp (optional) 
            var before = 2013-10-20T19:20:30+01:00;  // DateTime? | Filter for emails that were received before the given timestamp (optional) 
            var sort = sort_example;  // string | Sort direction (optional) 
            var delay = 789;  // long? | Max milliseconds delay between calls (optional) 

            try
            {
                // Wait for or fetch the email with a given  in the inbox specified. If  doesn't exist waits for it to exist or timeout to occur.
                Email result = apiInstance.WaitForNthEmail(inboxId, , timeout, unreadOnly, since, before, sort, delay);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling WaitForControllerApi.WaitForNthEmail: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
inboxIdGuid?Id of the inbox you are fetching emails from[optional]
****int?Zero based of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass =1[optional] [default to 0]
timeoutlong?Max milliseconds to wait for the nth email if not already present[optional]
unreadOnlybool?Optional filter for unread only[optional] [default to false]
sinceDateTime?Filter for emails that were received after the given timestamp[optional]
beforeDateTime?Filter for emails that were received before the given timestamp[optional]
sortstringSort direction[optional]
delaylong?Max milliseconds delay between calls[optional]

Return type

Email

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-

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