EmailController

Get all emails by search criteria. Return in paginated form.

Searches emails by email ID, inbox ID, sender address, subject, receiving inbox address, or receiving plus-address.

post/emails/search

Request

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

Query parameters

syncConnectorsboolean

Sync connectors

favouritedboolean

Search only favourited emails

plusAddressIdstring uuid

Optional plus address ID filter

Request body

inboxIdsstring[] nullable

Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.

pageIndexinteger nullable

Optional page index in email list pagination

pageSizeinteger nullable

Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results

sortDirection'ASC' | 'DESC' nullable

Optional createdAt sort direction ASC or DESC

unreadOnlyboolean nullable

Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly

searchFilterstring nullable

Optional search filter. Matches email ID, inbox ID, sender address, subject, receiving inbox email address, receiving plus-address full address, or plus-address suffix. Pasted email address tokens are normalized before matching.

sincestring date-time nullable

Optional filter emails received after given date time

beforestring date-time nullable

Optional filter emails received before given date time

Response

OK

Changes

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