Skip to Content

Get public logo image.

Returns raw image bytes for a domain's published white-label logo. No credential: a login screen needs this before anyone signs in.

openemail.branding.getLogo(
  domain: string,
  options?: BrandingGetLogoOptions,
): ApiPromise<Blob>

It calls GET /branding/{domain}/logo: Get public logo image in the API reference. The operation is public: the client sends it without its credential.

Example

const blob = await openemail.branding.getLogo(domain)

Arguments

ArgumentTypeDescription
domainstringCustomer domain name (e.g. example.com). The path's {domain}.

Options

The last argument, options, a BrandingGetLogoOptions, takes:

OptionTypeSent asDescription
ifNoneMatchstringheader if-none-matchRevalidation ETag from previous response

Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).

Answer

Awaited, it is a Blob: the bytes the API answers, with their media type. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
404No published logo or domain not found
503temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description)

A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.