ابزارها
هر عملیات در این گروه: آنچه می‌پذیرد، آنچه برمی‌گرداند و خطاهایی که ممکن است با آن‌ها پاسخ دهد.
عملیات‌ها
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.می‌تواند null باشدversionstring- می‌تواند null باشد
logoUrlstringThe
l=of the record: where the SVG logo is served.می‌تواند null باشدauthorityUrlstringThe
a=of the record: where the mark certificate is served, or null without one.می‌تواند null باشدlogoSvgstringThe logo as it was fetched, when it could be, to show it.
می‌تواند null باشدlogoReachablebooleandmarcPolicystringThe
p=of the DMARC record beside it.می‌تواند null باشدdmarcEnforcedbooleanWhether 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.
می‌تواند null باشدnotesstring[]الزامی
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.می‌تواند null باشدchecksDeliverabilityCheck[]الزامی
DmarcReportobject
objectstringالزامی- یکی از
"dmarc_report" domainstringالزامیThe domain that was checked, lower-cased.
recordstringالزامیThe DMARC record as published, or null when there is none.
می‌تواند null باشدinheritedFromstringالزامی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.
می‌تواند null باشدtagsRecord<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.