Lists

Get allow and block lists

The mailbox's four lists. An entry is an email address or a domain (which also covers its subdomains). In both directions a block entry always wins, and once an allow list has any entry, only what it names gets through.

Send lists are checked on every send through the API and MCP, scheduled sends included: a recipient they turn away is a 403 and nothing is sent. They do not restrict a person sending from webmail or a mail app.

Receive lists are enforced by the mail server at delivery: mail they turn away is filed in Junk instead of the inbox, and causes no message.received webhook.

Requires scope mailboxes:read.

get/mailboxes/{address}/lists

Request

Base URL: https://faivelo.com/api/v1
URL: https://faivelo.com/api/v1/mailboxes/{address}/lists
Auth: HTTP bearer

Path parameters

addressstring required

Full mailbox address, e.g. user@yourdomain.com

Response

The lists

successboolean

Example response

{
  "success": true,
  "data": {
    "send": {
      "allow": [
        "acme.com",
        "ceo@partner.io"
      ],
      "block": [
        "spammer.com"
      ]
    },
    "receive": {
      "allow": [
        "acme.com",
        "ceo@partner.io"
      ],
      "block": [
        "spammer.com"
      ]
    }
  }
}

Changes

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