Get a site's email settings
Answers the site's sending domains with the DNS records each needs and whether they have been found, the sender, and what you may do next. The default sending domain is also answered at the top level. store_mapping is what was last read on the site: read_stores=true asks for a fresh read.
Path parameters
The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.
Query parameters
True to have the stores of a live Magento 2 site read again. The fresh read is queued: this answer still holds store_mapping as it was last read, and a later one holds the new reading. Without it the stores are read again by themselves from time to time. It changes nothing on any other site. Defaults to false.
Returns
200 The email settings.
Fields of the 200 answer
Whether another sending domain can be added.
Fields
The sending domain a set-up creates when it names none.
Every sending domain of the site, the default first.
Fields of each item
Whether the site sends through this domain now.
Format: date-time.
Whether the DNS endpoint can write this domain's records.
Fields
Whether your company has a connected Cloudflare account.
When the records were last written in full. Format: date-time.
The Cloudflare zone the domain is in, or null when it is in none of the connected account's.
The domain of the sender addresses that go through it.
At least 1.
Format: date-time.
The last test email sent through this domain, or null.
The operation that set the domain up. At least 1.
Fields of each item
The record as written in Cloudflare by the DNS endpoint. Null when it was not.
What was found in DNS when it differs from value.
MX records only.
What the record is for, such as spf, dkim, mx, tracking or dmarc.
False for the records sending works without (mx, dmarc).
validuncheckedmismatchmissingThe record type, such as TXT, CNAME or MX.
Fields
The address the site's email comes from.
The name shown beside it.
The domain email is sent through, such as mg.harbourandfinch.example.com.
pending_dns: the domain exists and waits for its DNS records. preview: the site is not live, and its email is caught rather than sent.
previewnot_set_upcreatingpending_dnsverifiedfailedremovingWhy a test cannot be sent, when it cannot.
Format: date-time.
What went wrong with the last set-up or DNS write, in plain words.
Format: date-time.
Where the email of a site that is not live is caught. Null on a live site.
The email change that is running, or null.
Fields of each item
The record as written in Cloudflare by the DNS endpoint. Null when it was not.
What was found in DNS when it differs from value.
MX records only.
What the record is for, such as spf, dkim, mx, tracking or dmarc.
False for the records sending works without (mx, dmarc).
validuncheckedmismatchmissingThe record type, such as TXT, CNAME or MX.
The default sending domain, or null when none is set up.
pending_dns: the domain exists and waits for its DNS records. preview: the site is not live, and its email is caught rather than sent.
previewnot_set_upcreatingpending_dnsverifiedfailedremovingOn a live Magento 2 site with a sending domain, its stores' sender addresses and the sending domain each goes through, as last read on the site. Null otherwise, and until the first read has answered.
Fields
Format: date-time.
How many test emails can still be sent today.
Format: date-time.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | scope_required | Use a token with the scope named in scope. |
404 | feature_off | This feature is not on for your organisation yet. |
409 | deleted | The site, environment or copy has been deleted, or is being deleted. Nothing can be changed on it. Restore a deleted site first if it can still be restored. |
409 | provisioning | The site is still being created. Try again in a few minutes. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/corestack/sites/1042/email \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/corestack/sites/1042/email');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/email', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.get(
"https://manage.corefinity.com/api/corestack/sites/1042/email",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"add": {
"allowed": true,
"count": 1,
"default_prefix": "mg",
"max": 5,
"reason": null
},
"cloudflare": {
"can_write_records": true,
"connected": true,
"written_at": null,
"zone": {
"id": "example-zone-id",
"name": "harbourandfinch.example.com"
}
},
"default_domain": "mg.harbourandfinch.example.com",
"domains": [
{
"active": true,
"added_at": "2026-11-03T09:16:42Z",
"added_by": "Daniel Reyes",
"can_make_default": false,
"can_remove": true,
"can_rotate": true,
"can_test": false,
"cloudflare": {
"can_write_records": true,
"connected": true,
"written_at": null,
"zone": {
"id": "example-zone-id",
"name": "harbourandfinch.example.com"
}
},
"error": null,
"from_domain": "harbourandfinch.example.com",
"id": 3101,
"is_default": true,
"last_checked_at": "2026-11-03T09:16:40Z",
"last_test": null,
"make_default_reason": null,
"operation_id": 5120,
"records": [
{
"cloudflare": null,
"found": null,
"name": "mg.harbourandfinch.example.com",
"priority": null,
"purpose": "spf",
"required": true,
"state": "missing",
"type": "TXT",
"value": "v=spf1 include:mail.example.net ~all"
},
{
"cloudflare": null,
"found": null,
"name": "pic._domainkey.mg.harbourandfinch.example.com",
"priority": null,
"purpose": "dkim",
"required": true,
"state": "missing",
"type": "TXT",
"value": "k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY"
},
{
"cloudflare": null,
"found": null,
"name": "mg.harbourandfinch.example.com",
"priority": 10,
"purpose": "mx",
"required": false,
"state": "missing",
"type": "MX",
"value": "mxa.eu.mail.example.net"
},
{
"cloudflare": null,
"found": null,
"name": "mg.harbourandfinch.example.com",
"priority": 10,
"purpose": "mx",
"required": false,
"state": "missing",
"type": "MX",
"value": "mxb.eu.mail.example.net"
},
{
"cloudflare": null,
"found": null,
"name": "email.mg.harbourandfinch.example.com",
"priority": null,
"purpose": "tracking",
"required": true,
"state": "missing",
"type": "CNAME",
"value": "eu.mail.example.net"
}
],
"remove_reason": null,
"sender": {
"address": "[email protected]",
"name": "Harbour & Finch"
},
"sending_domain": "mg.harbourandfinch.example.com",
"state": "pending_dns",
"state_label": "Waiting for DNS",
"test_reason": "Test emails can be sent once the sending domain is verified",
"verified_at": null
}
],
"error": null,
"last_checked_at": "2026-11-03T09:16:40Z",
"mailpit": null,
"operation": null,
"records": [
{
"cloudflare": null,
"found": null,
"name": "mg.harbourandfinch.example.com",
"priority": null,
"purpose": "spf",
"required": true,
"state": "missing",
"type": "TXT",
"value": "v=spf1 include:mail.example.net ~all"
},
{
"cloudflare": null,
"found": null,
"name": "pic._domainkey.mg.harbourandfinch.example.com",
"priority": null,
"purpose": "dkim",
"required": true,
"state": "missing",
"type": "TXT",
"value": "k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY"
},
{
"cloudflare": null,
"found": null,
"name": "mg.harbourandfinch.example.com",
"priority": 10,
"purpose": "mx",
"required": false,
"state": "missing",
"type": "MX",
"value": "mxa.eu.mail.example.net"
},
{
"cloudflare": null,
"found": null,
"name": "mg.harbourandfinch.example.com",
"priority": 10,
"purpose": "mx",
"required": false,
"state": "missing",
"type": "MX",
"value": "mxb.eu.mail.example.net"
},
{
"cloudflare": null,
"found": null,
"name": "email.mg.harbourandfinch.example.com",
"priority": null,
"purpose": "tracking",
"required": true,
"state": "missing",
"type": "CNAME",
"value": "eu.mail.example.net"
}
],
"sender": {
"address": "[email protected]",
"name": "Harbour & Finch"
},
"sending_domain": "mg.harbourandfinch.example.com",
"state": "pending_dns",
"state_label": "Waiting for DNS",
"store_mapping": null,
"test": {
"last_sent_at": null,
"last_to": null,
"remaining_today": 20
},
"verified_at": null
}{
"message": "Unauthenticated."
}{
"code": "scope_required",
"message": "This access token does not have the destructive scope this needs. Use a token with the destructive scope.",
"reason": "scope_required",
"scope": "destructive"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "deleted",
"message": "This site is deleted and waiting to be purged. Restore it first.",
"reason": "deleted"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}