WoyraDocs
Get an API key

The mailbox's rules and blocked senders

GET/v1/mail/rules

Mailboxes · Requires an API key

Parameters

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

Example

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

Response

200 Oldest first; every matching rule applies in this order.

FieldTypeDescription
dataarray of object
data.idrequiredstring
data.fromContainsrequiredstringMatched in the sender's address or name
data.subjectContainsrequiredstring
data.toContainsrequiredstringMatched in any To or Cc address.
data.moveTostring
One of INBOX, ARCHIVE, TRASH, SPAM.
data.markReadrequiredboolean
data.starrequiredboolean
data.blocksrequiredbooleanA blocked sender
data.createdAtrequiredtimestamp

Errors

StatusCodes
401authentication_required, invalid_api_key

Also in Mailboxes