दस्तावेज़ पर जाएँ
API

टूल

इस समूह का हर ऑपरेशन: वह क्या लेता है, क्या लौटाता है और किन त्रुटियों के साथ जवाब दे सकता है।

ऑपरेशन

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_parameter on domain: 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त्रुटि सूची

इनमें भी उपलब्ध

SDK
tools.checkDmarc()
CLI
openemail tools check-dmarc
MCP
checkDmarc

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_parameter on domain: 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त्रुटि सूची

इनमें भी उपलब्ध

SDK
tools.checkBimi()
CLI
openemail tools check-bimi
MCP
checkBimi

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_parameter on domain: 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त्रुटि सूची

इनमें भी उपलब्ध

SDK
tools.checkDeliverability()
CLI
openemail tools check-deliverability
MCP
checkDeliverability

ऑब्जेक्ट

BimiReportobject

objectstringआवश्यक
इनमें से एक"bimi_report"
domainstringआवश्यक
recordstringआवश्यक

The BIMI record at default._bimi, or null.

null हो सकता है
versionstring
null हो सकता है
logoUrlstring

The l= of the record: where the SVG logo is served.

null हो सकता है
authorityUrlstring

The a= of the record: where the mark certificate is served, or null without one.

null हो सकता है
logoSvgstring

The logo as it was fetched, when it could be, to show it.

null हो सकता है
logoReachableboolean
dmarcPolicystring

The p= of the DMARC record beside it.

null हो सकता है
dmarcEnforcedboolean

Whether that policy is quarantine or reject, 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, pct and rua, as written.

stagestringआवश्यक
इनमें से एक"missing""invalid""monitor""quarantine""reject"
issuesstring[]आवश्यक

Problems found, each written to be shown to a person. Empty when there are none.