InboxController

Search all inboxes and return matching inboxes

Search inboxes and return in paginated form. The results are available on the content property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative getInboxes method returns a full list of inboxes but is limited to 100 results.

post/inboxes/search

Request

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

Request body

pageIndexinteger nullable

Optional page index in list pagination

pageSizeinteger nullable

Optional page size in list pagination

sortDirection'ASC' | 'DESC' nullable

Optional createdAt sort direction ASC or DESC

favouriteboolean nullable

Optionally filter results for favourites only

searchstring nullable

Optionally filter by search words partial matching name and email address

tagstring nullable

Optionally filter by tags. Will return inboxes that include given tags

sincestring date-time nullable

Optional filter by created after given date time

beforestring date-time nullable

Optional filter by created before given date time

inboxType'HTTP_INBOX' | 'SMTP_INBOX' nullable

Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).

inboxFunction'ALIAS' | 'THREAD' | 'CATCH_ALL' | 'CONNECTOR' | 'ACCOUNT' | 'GUIDED_TOUR' | 'GUEST' | 'OAUTH_CONNECTION_GMAIL' nullable

Optional filter by inbox function

domainIdstring uuid nullable

Optional domain ID filter

Response

OK

Changes

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