Belgelere geç
API

Araçlar

Bu gruptaki her işlem: neyi kabul ettiği, ne döndürdüğü ve hangi hatalarla yanıt verebileceği.

İşlemler

Checks of the public mail records of any domain, the free tools on the OpenEmail website: its DMARC policy, its BIMI logo, and a deliverability report across MX, SPF, DKIM, DMARC and BIMI. They read public DNS and nothing in the workspace, so they need no scope, and every answer is what DNS said at that moment.

GET/tools/dmarc

Check a domain's DMARC policy

Kapsam yokOkur

Reads the domain's DMARC record from public DNS, or the record of the organisational domain it inherits from, and says how strict it is and what is wrong with it. stage is missing, invalid, monitor for p=none, quarantine or reject.

Needs no scope: any key or access token for the workspace may run it.

Sorgu parametreleri

domainstringZorunlu

The domain to check, such as acme.com. An email address, a URL or a domain with a trailing dot is read as its domain. Any public domain works, not only the ones in this workspace.

En çok 320 karakter

Döndürür

What the DMARC record says.

Hatalar

422

invalid_parameter on domain: it does not read as a domain.

503

unreachable: public DNS did not answer for the domain just now. Nothing about the domain was decided, so try again in a moment.

Her işlemin döndürebileceği hatalar400401403404500Hata kataloğu

Şurada da var

SDK
tools.checkDmarc()
CLI
openemail tools check-dmarc
MCP
checkDmarc

GET/tools/bimi

Check a domain's BIMI logo

Kapsam yokOkur

Reads the domain's BIMI record, fetches the logo it names and checks the DMARC policy beside it, since inboxes draw a logo only at p=quarantine or p=reject. status is present, partial when the record is there but something stops inboxes showing it, absent or invalid, and issues says why.

Needs no scope: any key or access token for the workspace may run it.

Sorgu parametreleri

domainstringZorunlu

The domain to check, such as acme.com. An email address, a URL or a domain with a trailing dot is read as its domain. Any public domain works, not only the ones in this workspace.

En çok 320 karakter

Döndürür

What the BIMI record says and whether inboxes can draw the logo.

Hatalar

422

invalid_parameter on domain: it does not read as a domain.

503

unreachable: public DNS did not answer for the domain just now. Nothing about the domain was decided, so try again in a moment.

Her işlemin döndürebileceği hatalar400401403404500Hata kataloğu

Şurada da var

SDK
tools.checkBimi()
CLI
openemail tools check-bimi
MCP
checkBimi

GET/tools/deliverability

Check a domain's deliverability

Kapsam yokOkur

Checks the records a receiving mailbox reads before it trusts mail from the domain: MX, SPF, DKIM at the selectors its mail provider uses, DMARC and BIMI. Each check says pass, warn, fail or absent with a verdict and notes written to be shown to a person, and score weighs them into 0 to 100, graded A to F.

Needs no scope: any key or access token for the workspace may run it.

Sorgu parametreleri

domainstringZorunlu

The domain to check, such as acme.com. An email address, a URL or a domain with a trailing dot is read as its domain. Any public domain works, not only the ones in this workspace.

En çok 320 karakter

Döndürür

Each check, the score and the grade.

Hatalar

422

invalid_parameter on domain: it does not read as a domain.

503

unreachable: public DNS did not answer for the domain just now. Nothing about the domain was decided, so try again in a moment.

Her işlemin döndürebileceği hatalar400401403404500Hata kataloğu

Şurada da var

SDK
tools.checkDeliverability()
CLI
openemail tools check-deliverability
MCP
checkDeliverability

Nesneler

BimiReportobject

objectstringZorunlu
Şunlardan biri"bimi_report"
domainstringZorunlu
recordstringZorunlu

The BIMI record at default._bimi, or null.

null olabilir
versionstring
null olabilir
logoUrlstring

The l= of the record: where the SVG logo is served.

null olabilir
authorityUrlstring

The a= of the record: where the mark certificate is served, or null without one.

null olabilir
logoSvgstring

The logo as it was fetched, when it could be, to show it.

null olabilir
logoReachableboolean
dmarcPolicystring

The p= of the DMARC record beside it.

null olabilir
dmarcEnforcedboolean

Whether that policy is quarantine or reject, the only ones under which a logo is drawn.

statusstringZorunlu
Şunlardan biri"present""partial""absent""invalid"
issuesstring[]Zorunlu

DeliverabilityCheckobject

idstringZorunlu
Şunlardan biri"mx""spf""dkim""dmarc""bimi"
labelstringZorunlu
statusstringZorunlu
Şunlardan biri"pass""warn""fail""absent"
verdictstringZorunlu

One line saying what was found.

recordstringZorunlu

The record that was read, when there is one.

null olabilir
notesstring[]Zorunlu

DeliverabilityReportobject

objectstringZorunlu
Şunlardan biri"deliverability_report"
domainstringZorunlu
scoreintegerZorunlu
En az 0En çok 100
gradestringZorunlu
Şunlardan biri"A""B""C""D""F"
providerstringZorunlu

The mail provider its MX records point at, such as Google Workspace, when it is known.

null olabilir

DmarcReportobject

objectstringZorunlu
Şunlardan biri"dmarc_report"
domainstringZorunlu

The domain that was checked, lower-cased.

recordstringZorunlu

The DMARC record as published, or null when there is none.

null olabilir
inheritedFromstringZorunlu

The parent domain whose record applies, when the domain has none of its own. Null when the record is its own or there is none.

null olabilir
tagsRecord<string, string>Zorunlu

Every tag of the record, such as p, sp, pct and rua, as written.

stagestringZorunlu
Şunlardan biri"missing""invalid""monitor""quarantine""reject"
issuesstring[]Zorunlu

Problems found, each written to be shown to a person. Empty when there are none.