CorefinityCorefinityDocs
Open the Control PanelControl Panel
Outbound email · 1 of 12

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.

GET/api/corestack/sites/{site}/email

Path parameters

siteintegerRequired

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

read_storesboolean

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
addobjectRequired

Whether another sending domain can be added.

Fields
allowedbooleanRequired
countintegerRequired
default_prefixstringRequired
maxintegerRequired
reasonstring or nullRequired
cloudflareobject or any or nullRequired
default_domainstringRequired

The sending domain a set-up creates when it names none.

domainsarray of objectsRequired

Every sending domain of the site, the default first.

Fields of each item
activebooleanRequired

Whether the site sends through this domain now.

added_atstring or nullRequired

Format: date-time.

added_bystring or nullRequired
can_make_defaultbooleanRequired
can_removebooleanRequired
can_rotatebooleanRequired
can_testbooleanRequired
cloudflareobjectRequired

Whether the DNS endpoint can write this domain's records.

Fields
can_write_recordsbooleanRequired
connectedbooleanRequired

Whether your company has a connected Cloudflare account.

written_atstring or nullRequired

When the records were last written in full. Format: date-time.

zoneobject or any or nullRequired

The Cloudflare zone the domain is in, or null when it is in none of the connected account's.

errorstring or nullRequired
from_domainstringRequired

The domain of the sender addresses that go through it.

idintegerRequired

At least 1.

is_defaultbooleanRequired
last_checked_atstring or nullRequired

Format: date-time.

last_testobject or any or nullRequired

The last test email sent through this domain, or null.

make_default_reasonstring or nullRequired
operation_idinteger or nullRequired

The operation that set the domain up. At least 1.

recordsarray of objectsRequired
Fields of each item
cloudflareobject or any or nullRequired

The record as written in Cloudflare by the DNS endpoint. Null when it was not.

foundstring or nullRequired

What was found in DNS when it differs from value.

namestringRequired
priorityinteger or nullRequired

MX records only.

purposestringRequired

What the record is for, such as spf, dkim, mx, tracking or dmarc.

requiredbooleanRequired

False for the records sending works without (mx, dmarc).

statestringRequired
validuncheckedmismatchmissing
typestringRequired

The record type, such as TXT, CNAME or MX.

valuestringRequired
remove_reasonstring or nullRequired
senderobjectRequired
Fields
addressstringRequired

The address the site's email comes from.

namestring or nullRequired

The name shown beside it.

sending_domainstringRequired

The domain email is sent through, such as mg.harbourandfinch.example.com.

statestringRequired

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_dnsverifiedfailedremoving
state_labelstringRequired
test_reasonstring or nullRequired

Why a test cannot be sent, when it cannot.

verified_atstring or nullRequired

Format: date-time.

errorstring or nullRequired

What went wrong with the last set-up or DNS write, in plain words.

last_checked_atstring or nullRequired

Format: date-time.

mailpitobject or any or nullRequired

Where the email of a site that is not live is caught. Null on a live site.

operationobject or any or nullRequired

The email change that is running, or null.

recordsarray of objectsRequired
Fields of each item
cloudflareobject or any or nullRequired

The record as written in Cloudflare by the DNS endpoint. Null when it was not.

foundstring or nullRequired

What was found in DNS when it differs from value.

namestringRequired
priorityinteger or nullRequired

MX records only.

purposestringRequired

What the record is for, such as spf, dkim, mx, tracking or dmarc.

requiredbooleanRequired

False for the records sending works without (mx, dmarc).

statestringRequired
validuncheckedmismatchmissing
typestringRequired

The record type, such as TXT, CNAME or MX.

valuestringRequired
senderobject or any or nullRequired
sending_domainstring or nullRequired

The default sending domain, or null when none is set up.

statestringRequired

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_dnsverifiedfailedremoving
state_labelstringRequired
store_mappingobject or any or nullRequired

On 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.

testobjectRequired
Fields
last_sent_atstring or nullRequired

Format: date-time.

last_tostring or nullRequired
remaining_todayintegerRequired

How many test emails can still be sent today.

verified_atstring or nullRequired

Format: date-time.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403scope_requiredUse a token with the scope named in scope.
404feature_offThis feature is not on for your organisation yet.
409deletedThe 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.
409provisioningThe site is still being created. Try again in a few minutes.
429rate_limitedWait 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"
{
  "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
}
Try it
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT