ドメイン

get はドメイン上のアドレスも一覧にします。関連する呼び出しが addresses.list です：このキーが From ヘッダーに入れられるアドレスで、こちらのほうが範囲は狭く、それぞれ canSend の判定を持ちます。これは OpenEmail::AddressBookPage を返し、アドレスを items ではなく addresses に、domains と unrestricted と並べて保持します。その list_all は OpenEmail::AddressBook を 1 つ返します。

app_host は独立した名前空間で、client.app_host です。get、set、verify、delete は、ワークスペースの WebアプリのURL を読み取り・変更します。これは、これらのドメインのいずれか、またはワークスペースが管理するほかのドメイン上にある mailbox.acme.com のようなサブドメインで、ワークスペースの人々はそこでワークスペースのブランドのもとサインインします。set は公開する DNS レコードを record に、ワークスペース外のドメインではさらに ownershipRecord に入れて返します。delete と、アドレスを置き換える set は、OAuth アプリに確認コードを求めます：確認コードを得るまで、呼び出しは step_up_required? が true の 403 を送出します。

branding はそのブランドを設定します。get はマーク、ロゴ、ダークモード用ロゴ、ログイン画面の写真へのリンク、2 つのフォント、ログインページの背景を読み取ります。update はフォントと背景を変更し、upload_image(variant, data, content_type: nil) は 4 つの画像のいずれかをアップロードし、remove_image(variant) は 1 つを削除します。variant は mark、wordmark、wordmark-dark、login-background のいずれかで、OpenEmail::BRAND_IMAGE_VARIANTS がそれらを定義しています。data はバイナリの String、IO、Pathname のいずれかです。Pathname("logo.svg") のような Pathname、File、Rails のアップロードは種類を持っています。それ以外のバイト列には content_type: が必要で、種類のない画像は 422 invalid_image で拒否されます。WebアプリのURL と、有料プランではワークスペースのために送られるメールにブランドを付けるのはロゴです。

拒否されたホストは、param に trackingHost を示す OpenEmail::ApiError を送出します：ドメイン外の名前など使用できない名前は 422 invalid_tracking_host、receiving.verified が false でドメインの _openemail-challenge TXT レコードがまだ公開されていない状態での新しいホストは 409 domain_not_verified、他のドメインがすでに使っている名前や、別の OpenEmail サーバーが管理しているトラッキングドメインは 409 tracking_host_in_use です。422 は OpenEmail::ValidationError として、各 409 は OpenEmail::ConflictError として届きます。特定のアドレスに限定されたキーは 422 capability_unsupported になります。トラッキングドメインはドメイン上のすべてのアドレスに適用されるからです。

変更内容はキーワード引数または 1 つの Hash で、そのフィールドは API の camelCase の名前のままです。そのため tracking_host: は書かれたとおりに送られ、422 unknown_parameter で拒否されます。update は catchAll、files.acme.com のようなファイル用ドメインを指定する storageHost、dmarcPolicy も受け取ります。どのフィールドも省略可能で、メソッドリファレンスでそれぞれを説明しています。繰り返してもホストはすでに設定されていて、せいぜい再チェックされるだけなので、gem は update を読み取りと同じようにリトライします。