Common workflows

Set up hosted email

Use the Management API.

1. Create a Hosting domain.
2. Complete ownership and DNS checks.
3. Create mailboxes and aliases.
4. Configure signatures, address books, forwarding, limits, and related settings.
5. Use Email log analysis to troubleshoot access, incoming mail, or outgoing mail.

You do not need the Send API for normal hosted mailbox setup.

Set up transactional sending

Use the Management API, the panel, then the Send API.

Do not call /v1/send until you have a Delivery account, a configured sending domain, and a Send API token.

If this is the customer's first paid setup, complete the first order in the Qboxmail panel before creating the Delivery account via API. The active Hosting trial exception does not apply to Delivery accounts.

1. Create a Delivery domain.
2. Publish and verify DNS records.
3. Create a Delivery account with type transactional.
4. Assign the verified domain to the account.
5. Create a Send API token from the Delivery account settings in the panel.
6. Store the token securely.
7. Call /v1/send from your application.
8. Monitor events in Delivery TraceMail.

Set up newsletter sending

Use the same setup as transactional sending, but create or choose a Delivery account with type newsletter.

Then call /v1/send/bulk for templated recipient-based sends. Like /v1/send, it assumes the Delivery account and sending domain are already configured.

Best practices:

• Keep recipient data clean before sending.
• Use strict substitutions during testing.
• Add campaign IDs in metadata or headers when useful for your own tracking.
• Monitor bounces, complaints, and suppression-list behavior.

Manage a suppression list

Use the Management API.

1. List current suppression-list entries.
2. Add addresses that must not receive email.
3. Import or export suppression-list data when needed.
4. Use Send API suppression_summary to see the pre-check result for a send request.
5. Use TraceMail for the final delivery result.

Troubleshoot a sent message

1. Confirm the message was sent through an already configured Delivery account.
2. Confirm the Send API request returned 202 Accepted.
3. Save the request_id and message_id from the response.
4. Search Delivery TraceMail using the account, domain, date, recipient, or message details available in your application.
5. Check whether the recipient was suppressed, bounced, rejected, delayed, or delivered.
6. If no final event appears, check account status, quota, and sending domain configuration.

Migrate mailboxes

Use the Management API.

1. Upload or create the migration/import resource.
2. Validate resources.
3. Start or schedule the migration.
4. Read migration runs, resource logs, and stats.
5. Use Vault import endpoints when moving archived mailbox data.

The Send API is not involved in mailbox migration.