MailSlurpWaitForControllerApi

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.

WaitFor

[]EmailPreview WaitFor(ctx, optional)

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

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
optional*WaitForOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a WaitForOpts struct

NameTypeDescriptionNotes
waitForConditionsoptional.Interface of WaitForConditionsConditions to apply to emails that you are waiting for

Return type

**[]EmailPreview**

Authorization

API_KEY

HTTP request headers

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

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

WaitForEmailCount

[]EmailPreview WaitForEmailCount(ctx, optional)

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.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
optional*WaitForEmailCountOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a WaitForEmailCountOpts struct

NameTypeDescriptionNotes
beforeoptional.TimeFilter for emails that were received before the given timestamp
countoptional.Int32Number of emails to wait for. Must be greater that 1
delayoptional.Int64Max milliseconds delay between calls
inboxIdoptional.Interface of stringId of the inbox we are fetching emails from
sinceoptional.TimeFilter for emails that were received after the given timestamp
sortoptional.StringSort direction
timeoutoptional.Int64Max milliseconds to wait
unreadOnlyoptional.BoolOptional filter for unread only[default to false]

Return type

**[]EmailPreview**

Authorization

API_KEY

HTTP request headers

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

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

WaitForLatestEmail

Email WaitForLatestEmail(ctx, optional)

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.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
optional*WaitForLatestEmailOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a WaitForLatestEmailOpts struct

NameTypeDescriptionNotes
beforeoptional.TimeFilter for emails that were before after the given timestamp
delayoptional.Int64Max milliseconds delay between calls
inboxIdoptional.Interface of stringId of the inbox we are fetching emails from
sinceoptional.TimeFilter for emails that were received after the given timestamp
sortoptional.StringSort direction
timeoutoptional.Int64Max milliseconds to wait
unreadOnlyoptional.BoolOptional filter for unread only.[default to false]

Return type

Email

Authorization

API_KEY

HTTP request headers

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

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

WaitForMatchingEmails

[]EmailPreview WaitForMatchingEmails(ctx, matchOptions, optional)

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.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
matchOptionsMatchOptionsmatchOptions
optional*WaitForMatchingEmailsOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a WaitForMatchingEmailsOpts struct

NameTypeDescriptionNotes

before | optional.Time| Filter for emails that were received before the given timestamp | count | optional.Int32| Number of emails to wait for. Must be greater or equal to 1 | delay | optional.Int64| Max milliseconds delay between calls | inboxId | optional.Interface of string| Id of the inbox we are fetching emails from | since | optional.Time| Filter for emails that were received after the given timestamp | sort | optional.String| Sort direction | timeout | optional.Int64| Max milliseconds to wait | unreadOnly | optional.Bool| Optional filter for unread only | [default to false]

Return type

**[]EmailPreview**

Authorization

API_KEY

HTTP request headers

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

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

WaitForMatchingFirstEmail

Email WaitForMatchingFirstEmail(ctx, matchOptions, optional)

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.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
matchOptionsMatchOptionsmatchOptions
optional*WaitForMatchingFirstEmailOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a WaitForMatchingFirstEmailOpts struct

NameTypeDescriptionNotes

before | optional.Time| Filter for emails that were received before the given timestamp | delay | optional.Int64| Max milliseconds delay between calls | inboxId | optional.Interface of string| Id of the inbox we are matching an email for | since | optional.Time| Filter for emails that were received after the given timestamp | sort | optional.String| Sort direction | timeout | optional.Int64| Max milliseconds to wait | unreadOnly | optional.Bool| Optional filter for unread only | [default to false]

Return type

Email

Authorization

API_KEY

HTTP request headers

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

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

WaitForNthEmail

Email WaitForNthEmail(ctx, optional)

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.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
optional*WaitForNthEmailOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a WaitForNthEmailOpts struct

NameTypeDescriptionNotes
beforeoptional.TimeFilter for emails that were received before the given timestamp
delayoptional.Int64Max milliseconds delay between calls
inboxIdoptional.Interface of stringId of the inbox you are fetching emails from
****optional.Int32Zero 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[default to 0]
sinceoptional.TimeFilter for emails that were received after the given timestamp
sortoptional.StringSort direction
timeoutoptional.Int64Max milliseconds to wait for the nth email if not already present
unreadOnlyoptional.BoolOptional filter for unread only[default to false]

Return type

Email

Authorization

API_KEY

HTTP request headers

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

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