Skip to Content
SendlySendly
API ReferenceMailboxes

Get a mailbox

GET
/api/mailboxes/{id}

One mailbox, with the IMAP and SMTP host/port/username a mail client needs. The password is not included: mailbox credentials are app passwords, created separately and shown once.

Requires the mailboxes:read scope — View the mailboxes on your domains and their settings.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

id*string
Formatuuid

Response Body

Mailbox with connection settings

application/json
  1. response
success*true
Value intrue
data*

A mailbox plus its IMAP/SMTP connection settings.

Example Request
curl -X GET 'https://api.sendly.now/api/mailboxes/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "success": true,  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "address": "user@example.com",    "displayName": "string",    "status": "PROVISIONING",    "quotaBytes": 0,    "domainId": "8a0b02c3-fdd8-452e-bc6e-ef07a335ec7e",    "createdAt": "2019-08-24T14:15:22Z",    "signature": {      "text": "string",      "includeOnNewMessages": true,      "includeOnReplies": true    },    "settings": {      "imap": {        "host": "string",        "port": 0,        "security": "string",        "username": "string"      },      "smtp": {        "host": "string",        "port": 0,        "security": "string",        "username": "string"      }    }  }}