--- title: "openemail branding" description: "Every command in this namespace, with its arguments, flags and examples." url: "https://openemail.uk/docs/cli/reference/branding" area: "CLI" category: "Reference" --- # openemail branding Every command in this namespace, with its arguments, flags and examples. ## Commands ### `openemail branding get` Read the brand of the workspace ```bash openemail branding get [flags] ``` Returns the brand of the workspace, as its Customisations page shows it: a link to each brand image in `images`, the primary and secondary fonts in `fonts`, and the background of the sign-in page in `loginBackground`. The mark shows in the workspace switcher. The logo shows at the top of the sidebar, and it is what brands the web app address and, on a paid plan, the emails OpenEmail sends for the workspace, at their top and foot. Without a logo, both look like OpenEmail. The fonts apply in the web app for everyone in the workspace, the primary font to its text and the secondary font to page headings, and the sign-in background shows on the web app address, either way. A personal space carries no brand, so every image and font reads as null there and `editable` is false. - Scopes: `settings:read`. - Needs a sign-in. - Aliases: `show`, `view`. **Examples** ```bash openemail branding get ``` Print the raw JSON ```bash openemail branding get --json ``` Also available in: API [`GET /branding`](https://openemail.uk/docs/api/reference/settings#get-branding); SDK [`branding.get()`](https://openemail.uk/docs/sdk/reference/branding#get). ### `openemail branding update` Change the fonts and the sign-in background of the brand ```bash openemail branding update [flags] ``` Changes the fonts, the sign-in page background or both, and returns the brand in the same shape as `get`. A field left out keeps its value, and so does a font left out of `fonts`. `--login-background` replaces the background there was, and null sets the default. With `kind: 'image'` the sign-in page shows the photo uploaded with `uploadImage('login-background', ...)`, so upload that first: without it the call is refused. Uploading one switches the page to it on its own, so most callers never send `kind: 'image'` themselves. - Scopes: `settings:write`. - Needs a sign-in. - Aliases: `edit`. **Flags** - `--fonts `: The fonts to change. Leave it out to keep both. JSON shaped as `BrandingFontsUpdate`, inline or from a file with @path. - `--fonts-primary `: The primary font: one of the ids in `BRAND_FONT_IDS`, such as `inter` or `georgia`, or null for the default. Left out, it keeps its value. - `--fonts-secondary `: The secondary font, an id from `BRAND_FONT_IDS` or null for the default. Left out, it keeps its value. - `--login-background `: The sign-in page background, replacing the one there was, or null for the default. Leave it out to keep it. JSON shaped as `LoginBackgroundInput | null`, inline or from a file with @path. - `--login-background-kind `: `preset`, `color` or `image`. Required once `--login-background` is given. - `--login-background-preset `: `dusk`, `mist`, `sand` or `night`. Required when `kind` is `preset`, and kept for later otherwise. - `--login-background-color `: A colour as `#` and six hex digits, such as `#1f2937`, stored lowercased. Required when `kind` is `color`, and kept for later otherwise. - `--login-background-logo `: `dark` shows your logo and `light` your logo for dark mode. Null, the default, picks the one that stands out against the background. - `--data `: The whole `body` as JSON, inline, from a file with @path, or - for standard input. Flags override its keys. **Examples** With optional flags ```bash openemail branding update --fonts-primary inter --fonts-secondary georgia --login-background-kind color ``` Print the raw JSON ```bash openemail branding update --fonts-primary inter --fonts-secondary georgia --login-background-kind color --json ``` Also available in: API [`PATCH /branding`](https://openemail.uk/docs/api/reference/settings#patch-branding); SDK [`branding.update()`](https://openemail.uk/docs/sdk/reference/branding#update). ### `openemail branding upload-image` Upload one of the brand images ```bash openemail branding upload-image [flags] ``` Sends the image bytes as the request body, replacing the image there was, and returns the brand. `variant` names the image: `mark`, the square icon, `wordmark`, the logo, `wordmark-dark`, the logo for dark mode, or `login-background`, the photo behind the sign-in page of the web app address. Up to 5 MB goes in, and it is fitted and stored as WebP: the mark into 512 by 512 pixels, the two logos into 1024 by 256, and the sign-in photo into 2560 by 1600. The mark and the logos take SVG, PNG, JPEG or WebP, and the sign-in photo PNG, JPEG, WebP or GIF. An SVG is turned into a picture, and an animated image keeps its first frame. Uploading the sign-in photo also switches the sign-in page to it. The type is read from `--content-type`, or from a `Blob`'s own type when that is left out, and without either the server refuses the bytes with 422 `invalid_image`. - Scopes: `settings:write`. - Needs a sign-in. **Arguments** - `` (required): `mark`, `wordmark`, `wordmark-dark` or `login-background`. - `` (required): The image: a `Blob`, `ArrayBuffer` or `Uint8Array`. **Flags** - `--content-type `: `image/svg+xml`, `image/png`, `image/jpeg`, `image/webp` or `image/gif`. Required unless `data` is a `Blob` with a type. **Examples** The required values only ```bash openemail branding upload-image wordmark ./photo.jpg ``` With optional flags ```bash openemail branding upload-image wordmark ./photo.jpg --content-type image/svg+xml ``` Also available in: API [`PUT /branding/images/{variant}`](https://openemail.uk/docs/api/reference/settings#put-branding-images-variant); SDK [`branding.uploadImage()`](https://openemail.uk/docs/sdk/reference/branding#uploadImage). ### `openemail branding remove-image` Remove one of the brand images ```bash openemail branding remove-image [flags] ``` Removes one brand image, deletes the stored file and returns the brand, so the default shows in its place. Removing the sign-in photo while the sign-in page shows it switches the page back to the preset or colour chosen before it, or to the default. Removing an image that is not set changes nothing. - Scopes: `settings:write`. - Needs a sign-in. - Asks you to confirm. **Arguments** - `` (required): `mark`, `wordmark`, `wordmark-dark` or `login-background`. **Examples** ```bash openemail branding remove-image login-background ``` Skip the confirmation, for scripts ```bash openemail branding remove-image login-background --yes ``` Also available in: API [`DELETE /branding/images/{variant}`](https://openemail.uk/docs/api/reference/settings#delete-branding-images-variant); SDK [`branding.removeImage()`](https://openemail.uk/docs/sdk/reference/branding#removeImage).