Concepts

Set up Delivery before sending

Prepare Delivery domains, accounts, DNS, and Send API tokens before using the Send API.

Before an application can send through the Send API, it needs a configured Delivery account and at least one valid sending domain. Set this up with the Management API and the Qboxmail panel; then use the Send API to send email.

Setup flow

Create or choose a Delivery domain

Create a Delivery domain with the Management API or from the panel. This is the domain you want to use as a sender domain.

Publish and verify DNS records

The Delivery domain shows the DNS records required for verification and authentication. Publish them in the domain DNS zone, then run the verification endpoint or verify from the panel.

Do not start production sending before DNS verification is complete.

Create a Delivery account

Create a Delivery account for the sending use case.

Production API setup requires billing first

When using an API token in production, the customer must already have a billing profile. If this is the first paid setup, log into the Qboxmail panel and complete the first order before creating Delivery accounts via API. Hosting trial exceptions do not apply to Delivery. Sandbox Delivery setup does not require a production billing profile.

Delivery accounts are usually one of these types:

  • transactional: application emails such as password resets, receipts, notifications, and product events.
  • newsletter: bulk or campaign-style messages.

Assign one or more verified Delivery domains to the account.

Create a Send API token in the panel

Open the Qboxmail panel and go to the selected Delivery account.

From the API tokens section, create a token and copy the full token immediately. Use a clear label so you can recognize the token later.

Optional: restrict the token to one or more trusted IP addresses or CIDR ranges.

Send a test message

Call /v1/send with the Send API bearer token.

Monitor delivery

Use Management API Delivery TraceMail endpoints, dashboard counters, and suppression-list tools to monitor what happened after the message was queued.

Send API token creation from the panel

For now, create Send API tokens from the panel:

  1. Open Qboxmail panel.
  2. Go to Delivery or Email Delivery.
  3. Open Accounts.
  4. Select the Delivery account.
  5. Open API tokens.
  6. Click Create token or New token.
  7. Set a label.
  8. Copy the token immediately.
  9. Save it in your secret manager.
Copy the token immediately

After creation, the panel only shows a masked token preview. If you lose the token, revoke it and create a new one.

First send request

curl -X POST "https://api.qboxmail.com/v1/send" \
  -H "Authorization: Bearer <SEND_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "from": "sender@example.com",
        "to": ["recipient@example.net"],
        "subject": "Delivery test",
        "text_body": "This message was sent through the Qboxmail Send API."
      }
    ]
  }'

A successful request returns 202 Accepted. That means the message was accepted for delivery. It does not mean the message reached the recipient inbox yet.

Before production

  • The Delivery domain is verified.
  • The sender address uses an assigned Delivery domain.
  • The Delivery account is enabled.
  • The account type matches the use case: transactional or newsletter.
  • The Send API token is stored securely.
  • IP allow-lists include the application servers.
  • Bounce notifications and suppression-list policy are configured.
  • Monitoring uses request_id, message_id, and TraceMail.

On this page