WaitForController

Wait for or fetch the email with a given index in the inbox specified. If index 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.

get/waitForNthEmail

Request

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

Query parameters

inboxIdstring uuid

Id of the inbox you are fetching emails from

indexinteger

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

timeoutinteger

Max milliseconds to wait for the nth email if not already present

unreadOnlyboolean

Optional filter for unread only

sincestring date-time

Filter for emails that were received after the given timestamp

beforestring date-time

Filter for emails that were received before the given timestamp

sort'ASC' | 'DESC'

Sort direction

delayinteger

Max milliseconds delay between calls

Response

OK

Changes

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