Kalo te dokumentacioni
API

Mjetet

Çdo veprim në këtë grup: çfarë pranon, çfarë kthen dhe gabimet me të cilat mund të përgjigjet.

Veprimet

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

Pa lejeLexon

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.

Parametrat e pyetjes

domainstringE detyrueshme

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.

Deri në 320 karaktere

Kthen

What the DMARC record says.

Gabimet

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.

Gabimet që mund të kthejë çdo veprim400401403404500Katalogu i gabimeve

E disponueshme edhe në

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

GET/tools/bimi

Check a domain's BIMI logo

Pa lejeLexon

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.

Parametrat e pyetjes

domainstringE detyrueshme

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.

Deri në 320 karaktere

Kthen

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

Gabimet

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.

Gabimet që mund të kthejë çdo veprim400401403404500Katalogu i gabimeve

E disponueshme edhe në

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

GET/tools/deliverability

Check a domain's deliverability

Pa lejeLexon

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.

Parametrat e pyetjes

domainstringE detyrueshme

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.

Deri në 320 karaktere

Kthen

Each check, the score and the grade.

Gabimet

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.

Gabimet që mund të kthejë çdo veprim400401403404500Katalogu i gabimeve

E disponueshme edhe në

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

Objektet

BimiReportobject

objectstringE detyrueshme
Një nga"bimi_report"
domainstringE detyrueshme
recordstringE detyrueshme

The BIMI record at default._bimi, or null.

Mund të jetë null
versionstring
Mund të jetë null
logoUrlstring

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

Mund të jetë null
authorityUrlstring

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

Mund të jetë null
logoSvgstring

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

Mund të jetë null
logoReachableboolean
dmarcPolicystring

The p= of the DMARC record beside it.

Mund të jetë null
dmarcEnforcedboolean

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

statusstringE detyrueshme
Një nga"present""partial""absent""invalid"
issuesstring[]E detyrueshme

DeliverabilityCheckobject

idstringE detyrueshme
Një nga"mx""spf""dkim""dmarc""bimi"
labelstringE detyrueshme
statusstringE detyrueshme
Një nga"pass""warn""fail""absent"
verdictstringE detyrueshme

One line saying what was found.

recordstringE detyrueshme

The record that was read, when there is one.

Mund të jetë null
notesstring[]E detyrueshme

DeliverabilityReportobject

objectstringE detyrueshme
Një nga"deliverability_report"
domainstringE detyrueshme
scoreintegerE detyrueshme
Të paktën 0Më së shumti 100
gradestringE detyrueshme
Një nga"A""B""C""D""F"
providerstringE detyrueshme

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

Mund të jetë null
checksDeliverabilityCheck[]E detyrueshme

DmarcReportobject

objectstringE detyrueshme
Një nga"dmarc_report"
domainstringE detyrueshme

The domain that was checked, lower-cased.

recordstringE detyrueshme

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

Mund të jetë null
inheritedFromstringE detyrueshme

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.

Mund të jetë null
tagsRecord<string, string>E detyrueshme

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

stagestringE detyrueshme
Një nga"missing""invalid""monitor""quarantine""reject"
issuesstring[]E detyrueshme

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