ブランドを取得する
ワークスペースのブランド: 各ブランド画像へのリンク、メインフォントとサブフォント、ログインページの背景。
実際の呼び出しをワークスペースに対して実行します。
GET /branding
ワークスペースのブランド: 各ブランド画像へのリンク、メインフォントとサブフォント、ログインページの背景。
ブランドとは
export OE=https://api.openemail.ukexport AUTH="Authorization: Bearer $OPENEMAIL_API_KEY"ブランドとは、ワークスペースの外観ページで設定するもので、4 つの画像、2 つのフォント、ログインページの背景からなります。個人スペースにはありません。
markは正方形のアイコンで、ワークスペーススイッチャーに表示され、ロゴを設定すると WebアプリのURL のアイコンにもなります。wordmarkはロゴで、サイドバーの上部に表示されます。WebアプリのURL と、有料プランではワークスペースのために OpenEmail が送るメールにブランドを付けるのはこのロゴです。メールでは上部とフッターにロゴが入り、OpenEmail の代わりにワークスペースの名前が使われます。ロゴがないと、どちらも OpenEmail の見た目になります。wordmarkDarkはダークモード用ロゴで、アプリがダーク表示のときにロゴの代わりに使われます。loginBackgroundは写真で、WebアプリのURL のログインページの背後に表示されます。
2 つのフォントは、Web アプリでワークスペースの全員に適用されます。メインフォントは本文に、サブフォントはページの見出しに使われます。ログインページの背景は、ロゴの有無にかかわらず WebアプリのURL に表示されます。各フォントは次の ID のいずれか、またはデフォルトを表す null です: system, arial, helvetica, verdana, tahoma, trebuchet-ms, georgia, times-new-roman, courier-new, dm-sans, inter, roboto, open-sans, lato, montserrat, poppins, nunito, work-sans, source-sans-3, ibm-plex-sans, merriweather, playfair-display, instrument-serif, jetbrains-mono, dm-mono, geist-mono。
例
settings:read が必要です。
curl "$OE/branding" -H "$AUTH"{ "object": "branding", "editable": true, "images": { "mark": "https://cdn-prod.openemail.uk/workspaces/icons/0199a1c2-7d4e-7a31-9b52-3c8e1f0a6d24.webp", "wordmark": "https://cdn-prod.openemail.uk/workspaces/wordmarks/0199a1c2-8b10-7e45-a2f1-6d9c3b7e0f58.webp", "wordmarkDark": null, "loginBackground": null }, "fonts": { "primary": "inter", "secondary": "georgia" }, "loginBackground": { "kind": "preset", "preset": "dusk", "color": null }}editable は、このキーでブランドを変更できるかどうかを示します。個人スペース、settings:write のないキー、特定のアドレスやドメインに限定されたキーでは false です。
種類が image の loginBackground は、ログイン画面の写真がアップロードされるまで null として読み取られます。