ツール
このグループのすべてのオペレーションの、受け付ける内容、返す内容、返しうるエラー。
オペレーション
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.