InboxController

Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.

List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the minCount parameter. The server will retry the inbox database until the minCount is satisfied or the retryTimeout is reached

get/inboxes/{inboxId}/emails

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/inboxes/{inboxId}/emails
  • Auth: API key in header x-api-key

Path parameters

inboxIdstring uuid required

Id of inbox that emails belongs to

Query parameters

sizeinteger

Alias for limit. Assessed first before assessing any passed limit.

limitinteger

Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller

sort'ASC' | 'DESC'

Sort the results by received date and direction ASC or DESC

retryTimeoutinteger

Maximum milliseconds to spend retrying inbox database until minCount emails are returned

delayTimeoutinteger
minCountinteger

Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.

unreadOnlyboolean
beforestring date-time

Exclude emails received after this ISO 8601 date time

sincestring date-time

Exclude emails received before this ISO 8601 date time

Response

OK

Changes

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