الأدوات
كل عملية في هذه المجموعة: ما تقبله وما تُرجعه والأخطاء التي قد تردّ بها.
العمليات
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.