Sender management resource

Senders are email addresses that will appear in the From field of sent emails.

Get sender list

The resource results can be filtered using the optional querystring parameters:

  • status - one of active, pending, active+pending, all
  • type - one of email, domain, all
  • group - one of none, domain, flat
  • limit
  • offset

Request:

GET /sender/list?status=active&type=email

Response

{
  "senderlist": [
    {
      "sender_id": "1",
      "email": "email@example.org",
      "type": "email",
      "emailtype": "both",
      "status": "active",
      "label": ""
    },
    {
      "sender_id": "2",
      "email": "email2@example.com",
      "type": "email",
      "emailtype": "both",
      "status": "active",
      "label": ""
    }
  ],
  "filters": {
    "status": "active",
    "type": "email",
    "group": "none",
    "limit": "20",
    "offset": 0
  }
}

Get grouped sender list

The senders can be grouped by email domain:

Request:

GET /sender/list?group=domain

Response

{
  "senderlist": {
    "example.org": [
        {
          "sender_id": "1",
          "email": "email@example.org",
          "type": "email",
          "emailtype": "both",
          "status": "active",
          "label": ""
        },
    ],
    "example.com": [
        {
          "sender_id": "2",
          "email": "email2@example.com",
          "type": "email",
          "emailtype": "both",
          "status": "active",
          "label": ""
        }
    ]
  },
  "filters": {
    "status": "all",
    "type": "all",
    "group": "domain",
    "limit": 1000,
    "offset": 0
  }
}

Add a new sender

When adding a new sender two emails will be sent:

  • a notification email to your account address
  • a confirmation email to the added sender address

Request

POST /sender/list

{
    "type": "email",
    "address": "email2@example.org"
}

Response

{
  "sender": {
    "address": "email2@example.org",
    "type": "email"
  },
  "status": "added"
}

Table Of Contents