Docs/Reference

Glossary

Short definitions of the terms used across these docs. Where a term has its own article, the definition links to it.

API key

A credential that authenticates everything you send. It has a public ID (key_...) that names it and a secret (ap_...) that authenticates requests. The same key works for the HTTP API and for SMTP. See Authentication.

Attachment

A file sent alongside a message, such as a PDF receipt. A message may carry up to 20 attachments. See Attachments & inline images.

Batch send

One POST /v1/email/batch request that submits many independent messages, each with its own recipients and content. See Batch sending.

Bounce

A delivery that ended without reaching the recipient. It emits an email.bounced event whose bounce.type says which kind it was. A permanent bounce is the receiving server refusing the message outright, usually because the address does not exist; that one adds the address to your suppression list. An expired bounce is the message running out its 72-hour retry window with no verdict from the receiving server, which says nothing about the address, so it is not suppressed.

Campaign

A correlation dimension: a customer-supplied label grouping messages from one send effort, so their events can be reported together. See Tags, topics & campaigns.

Click tracking

Rewriting links in an HTML message so Anypost records when a recipient clicks one, emitting an email.clicked event. See Open & click tracking.

CNAME

A DNS record that aliases one name to another. Domain verification works by publishing CNAMEs that point your domain at records Anypost manages. See Domains & DNS setup.

Complaint

A recipient marking a message as spam. A complaint emits an email.complained event and suppresses the address. A rising complaint rate damages sending reputation.

Correlation dimension

One of four optional labels (tags, topic, campaign, template_id) that travel with a message so its events can be filtered and reported. They carry no delivery meaning. See Core concepts.

DKIM

DomainKeys Identified Mail: a cryptographic signature proving a message was authorized by the sending domain. Anypost generates DKIM keys and signs your mail automatically once a domain is verified.

DMARC

A policy, published in DNS, telling receiving servers how to handle mail that fails SPF and DKIM checks. It builds on the authentication Anypost sets up. Anypost recommends a record when you add a domain. See Domains & DNS setup.

Domain

A domain you own that Anypost is authorized to send mail for, also called a sending domain. The domain in a from address must be verified. See Domains & DNS setup.

Event

A record of something that happened to a message: delivered, bounced, complained, opened, or clicked. Events are how Anypost reports delivery outcomes. See Core concepts.

Idempotency key

A client-supplied Idempotency-Key header on a send request that makes a retry safe: the same key returns the original response instead of sending again. See API conventions.

Inline image

An image embedded in the body of an HTML message and displayed in place, rather than offered as a downloadable attachment. See Attachments & inline images.

IP pool

A named subset of an account's dedicated IP addresses. Passing its name as ip_pool on a send routes that message through those addresses only, which keeps one stream's sending reputation separate from another's. Not a correlation dimension: it changes how the message is delivered. See Email API.

Message

One email Anypost has accepted, identified by an email_ ID. Acceptance is not delivery. See Send a single email.

Open tracking

Embedding a tracking pixel in an HTML message so Anypost records when a recipient opens it, emitting an email.opened event. See Open & click tracking.

Permission level

The scope of an API key, either full (every endpoint) or send_only (send mail and read its own identity only). See Authentication.

Reply-to

An address, distinct from from, that recipient replies are directed to. A message may set up to 10. See Send a single email.

SMTP

The standard mail-submission protocol. Anypost accepts mail over SMTP with near-parity to the HTTP API, so existing software can send through Anypost without code changes. See Sending over SMTP.

SPF

Sender Policy Framework: a DNS record listing the servers allowed to send mail for a domain. Anypost publishes and maintains it for verified domains.

Suppression

An address Anypost will not send to, added automatically by a hard bounce or a complaint. A send to a suppressed address is dropped. See Suppressions.

Tag

A correlation dimension: a short freeform label ([A-Za-z0-9_-], up to 64 characters) attached to a message, up to 10 per message. See Tags, topics & campaigns.

Team

The owner of every resource: domains, keys, templates, webhooks, and messages. Resources never cross team boundaries. See Core concepts.

Template

Stored message content (subject, HTML, text) with placeholders, referenced by ID and rendered with per-recipient variables. See Sending with templates.

Topic

A correlation dimension: a single customer-supplied label categorizing what a message is about. See Tags, topics & campaigns.

Tracking domain

A branded subdomain (such as track.example.com) under which open and click tracking links are served, verified separately from the sending domain. See Tracking domains.

Variables

Per-recipient values substituted into a template's placeholders when a message is rendered. See Variables & personalization.

Verification

The one-time process of proving you control a domain, by publishing the CNAME records Anypost provides. See Domains & DNS setup.

Webhook

An HTTPS endpoint you register so Anypost can POST each event to your application as it happens. See Webhooks.