$client->tools
Cada método deste espaço de nomes: a sua assinatura, os seus parâmetros, o que devolve e um exemplo.
Métodos
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->checkDmarc
Check a domain's DMARC policy
checkDmarc(string $domain, ?string $apiKey = null): arrayReads 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.
Parâmetros
domainstringObrigatórioThe 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.apiKeystringOverrides the client's API key for this call only.
Devolve
An array with domain, record, inheritedFrom, every tag in tags, stage and issues.
Exemplo
$report = $client->tools->checkDmarc('acme.com'); echo $report['stage'], ' with p=', $report['tags']['p'] ?? 'none', PHP_EOL; foreach ($report['issues'] as $issue) { echo '- ', $issue, PHP_EOL;}Notas
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.
Também disponível em
- API
GET /tools/dmarc- TypeScript
tools.checkDmarc()- Python
tools.check_dmarc()- Ruby
tools.check_dmarc- CLI
openemail tools check-dmarc
tools->checkBimi
Check a domain's BIMI logo
checkBimi(string $domain, ?string $apiKey = null): arrayReads 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.
Parâmetros
domainstringObrigatórioThe 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.apiKeystringOverrides the client's API key for this call only.
Devolve
An array with record, logoUrl, authorityUrl, logoSvg, logoReachable, dmarcPolicy, dmarcEnforced, status and issues.
Exemplo
$report = $client->tools->checkBimi('acme.com'); if ($report['status'] !== 'present') { echo implode(PHP_EOL, $report['issues']), PHP_EOL;}Notas
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.
Também disponível em
- API
GET /tools/bimi- TypeScript
tools.checkBimi()- Python
tools.check_bimi()- Ruby
tools.check_bimi- CLI
openemail tools check-bimi
tools->checkDeliverability
Check a domain's deliverability
checkDeliverability(string $domain, ?string $apiKey = null): arrayChecks 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.
Parâmetros
domainstringObrigatórioThe 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.apiKeystringOverrides the client's API key for this call only.
Devolve
An array with score, grade, provider and checks, a list of arrays each with id, label, status, verdict, record and notes.
Exemplo
$report = $client->tools->checkDeliverability('acme.com'); echo $report['grade'], ' (', $report['score'], '/100)', PHP_EOL; foreach ($report['checks'] as $check) { echo $check['id'], ' ', $check['status'], ' ', $check['verdict'], PHP_EOL;}Notas
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.