List blocked senders

GET/api/v1/mailbox/blocked-senders
Requires amailbox token— it acts as one mailbox holder, not as the organization.

Mail from a blocked address is filed to the Junk folder at delivery, before any rule, forward or vacation reply runs. Nothing is discarded.

Errors

Status When
401 No token, or the session expired or was signed out. Sign in again with POST /mailbox-auth/login.
403 The account has a temporary password: until POST /security/password succeeds, every other call answers this with error_code: password_change_required.

Request

GET/api/v1/mailbox/blocked-senders
curl -X GET 'https://courier.mailyte.com/api/v1/mailbox/blocked-senders' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'

Response

Successful Response

  • dataobject
    • addressesarray<string>
    • managedboolean
    • folderstring

      Where their mail goes instead.

    • limitinteger
200application/json
{
  "type": "success",
  "msg": "Blocked senders retrieved successfully",
  "data": {
    "addresses": [
      "spam@example.net"
    ],
    "managed": true,
    "folder": "Junk",
    "limit": 500
  }
}

Returned inside the standard envelope.

Errors

StatusWhen
401No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`.
403The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`.

Every status, with what causes it and what to do, is on the error reference.