도구
이 그룹의 모든 작업: 받는 값, 반환하는 값, 응답할 수 있는 오류.
작업
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.