List IMAP unread messages

List unread IMAP messages (headers only) from a mailbox.

get/api/v1/imap/messages/unread

Request

  • Base URL: https://localhost:3000
  • URL: https://localhost:3000/api/v1/imap/messages/unread
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token)

Query parameters

mailboxstring

Mailbox name

max_resultsinteger

Maximum results (default: 25)

Response

Unread message header list

userstring
providerstring
mailboxstring
unread_onlyboolean
countinteger

Example response

{
  "provider": "IMAP"
}

Changes

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