WaitForController

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

post/waitFor

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/waitFor
  • Auth: API key in header x-api-key

Request body

inboxIdstring uuid required

ID of inbox to search within and apply conditions to. Essentially filtering the emails found to give a count.

countinteger nullable

Number of results that should match conditions. Either exactly or at least this amount based on the countType. If count condition is not met and the timeout has not been reached the waitFor method will retry the operation.

delayTimeoutinteger nullable

Max time in milliseconds to wait between retries if a timeout is specified.

timeoutinteger required

Max time in milliseconds to retry the waitFor operation until conditions are met.

unreadOnlyboolean nullable

Apply conditions only to unread emails. All emails begin with read=false. An email is marked read=true when an EmailDto representation of it has been returned to the user at least once. For example you have called getEmail or waitForLatestEmail etc., or you have viewed the email in the dashboard.

countType'EXACTLY' | 'ATLEAST' nullable

How result size should be compared with the expected size. Exactly or at-least matching result?

sortDirection'ASC' | 'DESC' nullable

Direction to sort matching emails by created time

sincestring date-time nullable

ISO Date Time earliest time of email to consider. Filter for matching emails that were received after this date

beforestring date-time nullable

ISO Date Time latest time of email to consider. Filter for matching emails that were received before this date

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.