Инструменты
Каждая операция этой группы: что она принимает, что возвращает и какими ошибками может ответить.
Операции
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.
Параметры запроса
domainstringОбязательно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.До 320 символов
Возвращает
What the DMARC record says.
Ошибки
- 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.
Ошибки, которые может вернуть любая операция400401403404500Каталог ошибок
Также доступно в
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.
Параметры запроса
domainstringОбязательно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.До 320 символов
Возвращает
What the BIMI record says and whether inboxes can draw the logo.
Ошибки
- 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.
Ошибки, которые может вернуть любая операция400401403404500Каталог ошибок
Также доступно в
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.
Параметры запроса
domainstringОбязательно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.До 320 символов
Возвращает
Each check, the score and the grade.
Ошибки
- 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.
Ошибки, которые может вернуть любая операция400401403404500Каталог ошибок
Также доступно в
Объекты
BimiReportobject
objectstringОбязательно- Одно из
"bimi_report" domainstringОбязательноrecordstringОбязательноThe BIMI record at
default._bimi, or null.Может быть nullversionstring- Может быть null
logoUrlstringThe
l=of the record: where the SVG logo is served.Может быть nullauthorityUrlstringThe
a=of the record: where the mark certificate is served, or null without one.Может быть nulllogoSvgstringThe logo as it was fetched, when it could be, to show it.
Может быть nulllogoReachablebooleandmarcPolicystringThe
p=of the DMARC record beside it.Может быть nulldmarcEnforcedbooleanWhether that policy is
quarantineorreject, the only ones under which a logo is drawn.statusstringОбязательно- Одно из
"present""partial""absent""invalid" issuesstring[]Обязательно
DeliverabilityCheckobject
idstringОбязательно- Одно из
"mx""spf""dkim""dmarc""bimi" labelstringОбязательноstatusstringОбязательно- Одно из
"pass""warn""fail""absent" verdictstringОбязательноOne line saying what was found.
recordstringОбязательноThe record that was read, when there is one.
Может быть nullnotesstring[]Обязательно
DeliverabilityReportobject
objectstringОбязательно- Одно из
"deliverability_report" domainstringОбязательноscoreintegerОбязательно- Не меньше 0Не больше 100
gradestringОбязательно- Одно из
"A""B""C""D""F" providerstringОбязательноThe mail provider its MX records point at, such as
Google Workspace, when it is known.Может быть nullchecksDeliverabilityCheck[]Обязательно
DmarcReportobject
objectstringОбязательно- Одно из
"dmarc_report" domainstringОбязательноThe domain that was checked, lower-cased.
recordstringОбязательноThe DMARC record as published, or null when there is none.
Может быть nullinheritedFromstringОбязательно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.
Может быть nulltagsRecord<string, string>ОбязательноEvery tag of the record, such as
p,sp,pctandrua, as written.stagestringОбязательно- Одно из
"missing""invalid""monitor""quarantine""reject" issuesstring[]ОбязательноProblems found, each written to be shown to a person. Empty when there are none.