Outils
Chaque opération de ce groupe : ce qu'elle accepte, ce qu'elle retourne et les erreurs qu'elle peut renvoyer.
Opérations
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.
Paramètres de requête
domainstringObligatoireThe 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.Jusqu'à 320 caractères
Retourne
What the DMARC record says.
Erreurs
- 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.
Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de requête
domainstringObligatoireThe 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.Jusqu'à 320 caractères
Retourne
What the BIMI record says and whether inboxes can draw the logo.
Erreurs
- 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.
Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de requête
domainstringObligatoireThe 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.Jusqu'à 320 caractères
Retourne
Each check, the score and the grade.
Erreurs
- 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.
Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs
Aussi disponible dans
Objets
BimiReportobject
objectstringObligatoire- L'un de
"bimi_report" domainstringObligatoirerecordstringObligatoireThe BIMI record at
default._bimi, or null.Peut être nullversionstring- Peut être null
logoUrlstringThe
l=of the record: where the SVG logo is served.Peut être nullauthorityUrlstringThe
a=of the record: where the mark certificate is served, or null without one.Peut être nulllogoSvgstringThe logo as it was fetched, when it could be, to show it.
Peut être nulllogoReachablebooleandmarcPolicystringThe
p=of the DMARC record beside it.Peut être nulldmarcEnforcedbooleanWhether that policy is
quarantineorreject, the only ones under which a logo is drawn.statusstringObligatoire- L'un de
"present""partial""absent""invalid" issuesstring[]Obligatoire
DeliverabilityCheckobject
idstringObligatoire- L'un de
"mx""spf""dkim""dmarc""bimi" labelstringObligatoirestatusstringObligatoire- L'un de
"pass""warn""fail""absent" verdictstringObligatoireOne line saying what was found.
recordstringObligatoireThe record that was read, when there is one.
Peut être nullnotesstring[]Obligatoire
DeliverabilityReportobject
objectstringObligatoire- L'un de
"deliverability_report" domainstringObligatoirescoreintegerObligatoire- Au moins 0Au plus 100
gradestringObligatoire- L'un de
"A""B""C""D""F" providerstringObligatoireThe mail provider its MX records point at, such as
Google Workspace, when it is known.Peut être nullchecksDeliverabilityCheck[]Obligatoire
DmarcReportobject
objectstringObligatoire- L'un de
"dmarc_report" domainstringObligatoireThe domain that was checked, lower-cased.
recordstringObligatoireThe DMARC record as published, or null when there is none.
Peut être nullinheritedFromstringObligatoireThe parent domain whose record applies, when the domain has none of its own. Null when the record is its own or there is none.
Peut être nulltagsRecord<string, string>ObligatoireEvery tag of the record, such as
p,sp,pctandrua, as written.stagestringObligatoire- L'un de
"missing""invalid""monitor""quarantine""reject" issuesstring[]ObligatoireProblems found, each written to be shown to a person. Empty when there are none.