Configure email-channel infrastructure, including domains, verified senders, suppression, and inbound receiving.
The email resource covers the infrastructure behind email sending and receiving:
the domains you send from, the senders you send as, suppression, and inbound routing.
The actual send and message retrieval calls live on
Messages; this resource is the setup surface around
them.
What you can do
- Domains, add a sending domain, verify its DNS, check status, and enable receiving for inbound.
- Senders, register and verify the From addresses you send as.
- Suppression, list the addresses Samva will not send to and why, and remove one.
- Inbound, configure catch-all and forwarding rules for received mail, and block addresses or domains from reaching you.
- Stats, pull aggregate email statistics.
Reading deliverability
Domain and sender rows carry a deliverability block: bounceRate and complaintRate
as fractions between 0 and 1, windowSends for the deliveries they were divided by,
plus sendingStatus, which says whether your organization can currently send. Both rates read the last 24 hours,
which is the same window the 5% bounce limit is enforced over, rather than recording
your organization's history. An identity with no traffic in that window reports zeroes.
Read the rates with windowSends. The pause rule ignores a window below 200 sends,
because one bounce in three sends is a 33% bounce rate and means nothing, so a rate
over a smaller windowSends is a quotient rather than a reading. The rule also counts
your organization's whole sending, not one domain's or one sender's, so a per-identity
rate tells you where bounces are coming from rather than predicting a pause.
Those rows also carry series: the last 14 days of daily email sends, oldest first,
in your organization's timezone and zero-filled to fourteen entries.
Before you can send from your domain
You send from a domain you own, so add and verify it first; see
Verify your domain for the DNS walkthrough.
A new organization is also reviewed before it can send; until the review clears, a send
returns 403 with OnboardingReviewRequiredError.
Shared conventions (auth, status codes, errors, pagination) are in the REST API reference. Per-operation request and response detail is in the sidebar.
Related documentation
Validate an email message
Resolves recipients, sender, and inline or published-template content without sending anything, creating contacts or messages, or counting toward your quota.
Add a block entry
Blocks an email address or domain from inbound receiving and returns the created block entry. Responds with 201.