WoyraDocs
Get an API key

Search the whole mailbox, newest first

GET/v1/mail/search

Mailboxes · Requires an API key

Searches subject, sender, recipients and body of every message in the mailbox, including mail older than what an app keeps on the device. Every word must match, each as the start of a word, so inv mar finds "Invoice for March". Without folder, Trash and Spam are left out. With none of q, from and starred, the answer is an empty list.

Parameters

NameInDescription
mailboxqueryThe token's own mailbox. Any other address is refused with 403.
qqueryThe words to find. Anything that is not a letter or a digit separates words; at most 8 are used.
folderquery
unreadqueryOnly messages not yet read.
attachmentqueryOnly messages with attachments.
starredqueryOnly starred messages. On its own, with no q, it lists every starred message.
fromqueryOnly messages whose sender's address or name contains this.
limitquery
cursorquery

Example

curl https://api.woyra.io/v1/mail/search \
  -H "Authorization: Bearer $WOYRA_KEY"

Response

200 A page of matches; cursor is present when another follows.

FieldTypeDescription
datarequiredarray of MailAppMessage
cursorstring

Errors

StatusCodes
400invalid_request, unsupported_version
401authentication_required, invalid_api_key

Also in Mailboxes