client.tools
Каждый метод этого пространства имён: его сигнатура, параметры, что он возвращает, и пример.
Методы
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 need no scope.
tools.check_dmarc
Check a domain's DMARC policy
check_dmarc(domain, api_key: nil) -> HashReads 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, the DMARC checker on the OpenEmail website. stage is missing, invalid, monitor for p=none, quarantine or reject, and issues lists the problems written to be shown to a person.
Параметры
domainStringОбязательноThe domain to check, such as
acme.com. An email address or a URL is read as its domain, and any public domain works, not only the ones in this workspace.api_keyStringOverrides the client's API key for this call only.
Возвращает
A Hash with domain, record, inheritedFrom, every tag in tags, stage and issues.
Пример
report = client.tools.check_dmarc("acme.com") puts report[:stage], report[:tags][:p]p report[:issues]Примечания
Needs no scope: any key or access token for the workspace may run it.
A domain that does not read as one is 422
invalid_parameterondomain, and DNS that did not answer is 503unreachable, which is worth retrying.
Также доступно в
- API
GET /tools/dmarc- TypeScript
tools.checkDmarc()- Python
tools.check_dmarc()- CLI
openemail tools check-dmarc
tools.check_bimi
Check a domain's BIMI logo
check_bimi(domain, api_key: nil) -> HashReads 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, the BIMI checker on the OpenEmail website. status is present, partial when the record is there but something stops inboxes showing the logo, absent or invalid, and issues says why.
Параметры
domainStringОбязательноThe domain to check, such as
acme.com. An email address or a URL is read as its domain, and any public domain works, not only the ones in this workspace.api_keyStringOverrides the client's API key for this call only.
Возвращает
A Hash with record, logoUrl, authorityUrl, logoSvg, logoReachable, dmarcPolicy, dmarcEnforced, status and issues.
Пример
report = client.tools.check_bimi("acme.com") p report[:issues] unless report[:status] == "present"Примечания
Needs no scope: any key or access token for the workspace may run it.
A domain that does not read as one is 422
invalid_parameterondomain, and DNS that did not answer is 503unreachable, which is worth retrying.
Также доступно в
- API
GET /tools/bimi- TypeScript
tools.checkBimi()- Python
tools.check_bimi()- CLI
openemail tools check-bimi
tools.check_deliverability
Check a domain's deliverability
check_deliverability(domain, api_key: nil) -> HashChecks the records a receiving mailbox reads before it trusts mail from the domain, the deliverability checker on the OpenEmail website: 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, and score weighs them into 0 to 100, graded A to F.
Параметры
domainStringОбязательноThe domain to check, such as
acme.com. An email address or a URL is read as its domain, and any public domain works, not only the ones in this workspace.api_keyStringOverrides the client's API key for this call only.
Возвращает
A Hash with score, grade, provider and checks, an Array of Hashes each with id, label, status, verdict, record and notes.
Пример
report = client.tools.check_deliverability("acme.com") puts report[:grade], report[:score]report[:checks].each { |check| puts check.values_at(:id, :status, :verdict).join(" ") }Примечания
Needs no scope: any key or access token for the workspace may run it.
A domain that does not read as one is 422
invalid_parameterondomain, and DNS that did not answer is 503unreachable, which is worth retrying.