WoyraDocs
Get an API key

What changed in the mailbox since a cursor

GET/v1/mail/sync/changes

Mailboxes · Requires an API key

The call an app makes in steady state. Entries come oldest first; a deleted entry has no message. cursor resumes after the last entry returned, and more says another page is waiting.

Parameters

NameInDescription
mailboxqueryThe token's own mailbox. Any other address is refused with 403.
sincequery
limitquery

Example

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

Response

200 The changes.

FieldTypeDescription
datarequiredarray of object
data.seqrequiredinteger
data.idrequiredstring
data.deletedrequiredboolean
data.messageMailAppMessageA message as Woyra Mail's apps hold it (@woyra/mail-core).
cursorrequiredstring
morerequiredboolean

Errors

StatusCodes
401authentication_required, invalid_api_key
410The cursor was not issued for this mailbox. Discard local state and sync from the beginning.

Also in Mailboxes