Skip to content

Mail from WordPress

Capture every message WordPress tries to send on a site that is not live yet, set up signed mail for your domain, and set the rate limit.

Parts of this feature are still being built. The Not yet section lists them.

The Mail tab controls what happens to the mail WordPress sends from an environment. Open your site, then Mail, to capture messages instead of sending them, add a signed-mail identity, and change the rate limit.

Turn on capture mode

Capture mode stores every message WordPress tries to send instead of sending it. Use it on a site that is not live yet, so a test order or a password reset never reaches a real inbox.

  1. Open your site, then Mail.
  2. Turn on capture mode.
  3. Save.

Avaloi applies the change through a job. While capture mode is on, nothing is sent.

Read captured messages

The Mail tab lists captured messages from the last seven days. Open a message to read it. Messages older than seven days are gone.

Set up signed mail

Signed mail lets receiving servers confirm that mail from your domain is yours.

  1. Under Mail identities, add your sending domain.
  2. Avaloi creates DKIM keys for it through a job.
  3. If the domain's DNS is on Cloudflare DNS, the DKIM, SPF, and DMARC records are written for you.
  4. Otherwise, the page shows the three records to add at your DNS provider.

Open an identity at any time to see its records.

Change the rate limit

The rate limit is 500 messages an hour per site by default. On a spike, Avaloi pauses sending and tells you. Change the limit on the Mail tab if your site sends more than that on purpose.

Limits

  • Captured messages stay for seven days.
  • Rate limit: 500 messages an hour per site by default.

Quick answers

My test site sent a real email. Turn on capture mode. Everything WordPress tries to send is then stored on the Mail tab instead.

How long do captured messages stay? Seven days.

Where are my DKIM records? Open the identity under Mail identities. If your DNS is on Cloudflare DNS they are already in your zone, with a lock.

Sending stopped after a burst of mail. You hit the rate limit. Avaloi paused sending and told you. Raise the limit if the burst was intended.

API

  • GET /v1/environments/{id}/mail/settings
  • PUT /v1/environments/{id}/mail/settings
  • GET /v1/environments/{id}/mail/captured
  • GET /v1/environments/{id}/mail/captured/{mail_id}
  • GET /v1/mail/identities
  • POST /v1/mail/identities
  • GET /v1/mail/identities/{id}

Not yet

The sending log is not built. The route GET /v1/environments/{id}/mail/log exists but returns nothing until the relay sidecar and a mail provider exist. When it arrives, the Mail tab will list every message the environment sent, with its result.

Still stuck?

Email [email protected] with your site name and what you tried, or send us a message.