Email

Get the inbox logo (BIMI) of a sending domain

Whether the domain can show its logo next to emails in the inbox (BIMI): the DMARC policy (it must be quarantine or reject for all mail), the BIMI record at default._bimi, and the steps that are left. Gmail shows the logo only with a mark certificate (VMC or CMC) that the user gets from a certificate authority; Apple Mail only with a VMC; Yahoo can show it without a certificate for domains with a good sending reputation, but that is not guaranteed. Read-only.

get/email-domains/{id}/bimi

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/email-domains/{id}/bimi
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: sites:read)

Path parameters

idstring uuid required

The id of the sending domain.

Response

The logo settings of the domain.

email_domain_idstring required
domainstring required
readyboolean required
dns_managedboolean required

The DNS is hosted here, so set_email_bimi sets the record itself.

stepsstring[] required
notestring required

Which mailboxes show the logo, and what they need.

Changes

No recorded changes to this operation across all 1 revision of this API.