Tools
Jede Operation in dieser Gruppe: was sie annimmt, was sie zurückgibt und mit welchen Fehlern sie antworten kann.
Operationen
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
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.
Query-Parameter
domainstringErforderlichThe 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.Bis zu 320 Zeichen
Rückgabe
What the DMARC record says.
Fehler
- 422
invalid_parameterondomain: 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.
Die Fehler, die jede Operation zurückgeben kann400401403404500Fehlerkatalog
Auch verfügbar über
GET/tools/bimi
Check a domain's BIMI logo
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.
Query-Parameter
domainstringErforderlichThe 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.Bis zu 320 Zeichen
Rückgabe
What the BIMI record says and whether inboxes can draw the logo.
Fehler
- 422
invalid_parameterondomain: 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.
Die Fehler, die jede Operation zurückgeben kann400401403404500Fehlerkatalog
Auch verfügbar über
GET/tools/deliverability
Check a domain's deliverability
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.
Query-Parameter
domainstringErforderlichThe 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.Bis zu 320 Zeichen
Rückgabe
Each check, the score and the grade.
Fehler
- 422
invalid_parameterondomain: 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.
Die Fehler, die jede Operation zurückgeben kann400401403404500Fehlerkatalog
Auch verfügbar über
Objekte
BimiReportobject
objectstringErforderlich- Einer von
"bimi_report" domainstringErforderlichrecordstringErforderlichThe BIMI record at
default._bimi, or null.Kann null seinversionstring- Kann null sein
logoUrlstringThe
l=of the record: where the SVG logo is served.Kann null seinauthorityUrlstringThe
a=of the record: where the mark certificate is served, or null without one.Kann null seinlogoSvgstringThe logo as it was fetched, when it could be, to show it.
Kann null seinlogoReachablebooleandmarcPolicystringThe
p=of the DMARC record beside it.Kann null seindmarcEnforcedbooleanWhether that policy is
quarantineorreject, the only ones under which a logo is drawn.statusstringErforderlich- Einer von
"present""partial""absent""invalid" issuesstring[]Erforderlich
DeliverabilityCheckobject
idstringErforderlich- Einer von
"mx""spf""dkim""dmarc""bimi" labelstringErforderlichstatusstringErforderlich- Einer von
"pass""warn""fail""absent" verdictstringErforderlichOne line saying what was found.
recordstringErforderlichThe record that was read, when there is one.
Kann null seinnotesstring[]Erforderlich
DeliverabilityReportobject
objectstringErforderlich- Einer von
"deliverability_report" domainstringErforderlichscoreintegerErforderlich- Mindestens 0Höchstens 100
gradestringErforderlich- Einer von
"A""B""C""D""F" providerstringErforderlichThe mail provider its MX records point at, such as
Google Workspace, when it is known.Kann null seinchecksDeliverabilityCheck[]Erforderlich
DmarcReportobject
objectstringErforderlich- Einer von
"dmarc_report" domainstringErforderlichThe domain that was checked, lower-cased.
recordstringErforderlichThe DMARC record as published, or null when there is none.
Kann null seininheritedFromstringErforderlichThe parent domain whose record applies, when the domain has none of its own. Null when the record is its own or there is none.
Kann null seintagsRecord<string, string>ErforderlichEvery tag of the record, such as
p,sp,pctandrua, as written.stagestringErforderlich- Einer von
"missing""invalid""monitor""quarantine""reject" issuesstring[]ErforderlichProblems found, each written to be shown to a person. Empty when there are none.