WaitForController

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.

get/waitForEmailCount

Request

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

Query parameters

inboxIdstring uuid required

Id of the inbox we are fetching emails from

countinteger required

Number of emails to wait for. Must be greater that 1

timeoutinteger

Max milliseconds to wait

unreadOnlyboolean

Optional filter for unread only

beforestring date-time

Filter for emails that were received before the given timestamp

sincestring date-time

Filter for emails that were received after 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.