SDK

ラベル

`labels.list`、`get`、`create`、`update`、`delete`。

すべてのメソッド

usage.ts

const labels = await openemail.labels.list()const label = await openemail.labels.get('USER_INVOICES') const created = await openemail.labels.create({  name: 'Invoices',  color: { backgroundColor: '#e8eaed', textColor: '#3c4043' },}) await openemail.labels.update(created.id!, { name: 'Invoices 2027' })await openemail.labels.delete(created.id!)

ラベルはページングされないため、list は素の配列に解決する。color は読み取り時に破棄されず返されるので、クライアントはユーザーが見ているとおりにラベルを描画できる。type は常に user であり、分岐すべきものはない。id は名前から導出されるため、Invoices は USER_INVOICES になる。

パラメーター: labels.create と labels.update

namestring必須: ラベルの表示名。長さを測る前にトリムされるため、上限はトリム後で 1 〜 225 文字となる。空白だけの値は 422 となり、色の点だけで読むことも押すこともできない名前なしの行が作られることはない。さらに `create` は、メールボックスがすでに 50 個のユーザーラベルを保持している場合、`name` を指す 422 `label_limit_reached` で拒否する。
colorLabelColor: どちらの呼び出しでも省略可能で、`update` で省略した場合、保存済みの色はクリアされずそのまま残る。ボディは厳格に検証されるため、`colour` のような惜しいキーは黙って無視されるのではなく 422 になる。
color.backgroundColorstring必須: `color` を指定した場合は必須で、最大 32 文字。ネイティブのメールボックスでは保持されるのはこちらだけであり、行には色が 1 つだけ保存される。
color.textColorstring必須: `color` を指定した場合は必須で、最大 32 文字。

レスポンス: Label

object'label': 常に文字列 `label`。書き込み時にも返されるが、その場合はこの型ではなく `SavedLabelResource` 上に現れる。
idstring: メールボックス側の id であり、`get`、`update`、`delete` が受け取る値。書き込み時は `SavedLabelResource.id` として返り、この値は null になりうる。null の場合は一覧からラベルを探すこと。
namestring: ユーザーに表示される値。メールボックスが名前のないラベルを返した場合は null ではなく空文字列になる。ネイティブのメールボックスでは id がこの名前から導出されるため(`Follow up` は `USER_FOLLOW_UP` になる)、正規化すると同じ id になる 2 つ目のラベルは、最初のものを上書きするのではなく 409 `label_name_taken` で拒否される。
typestring: 常に `user`。ここで提供されるのはユーザーラベルだけで、標準フォルダーの id はレスポンスを組み立てる前に除外され、システム id を `get` に渡すと 404 になる。メールボックスがこのフィールドを返さない場合、ルートは `user` にフォールバックする。`LabelInput` にはこれを設定する手段はない。
colorLabelColor | null: メールボックスがそのラベルの色を返さない場合は null。描画の前にはオブジェクトではなく文字列の方を検査すること。空のペアと、ペアが存在しないことは同じではない。
color.backgroundColorstring: メールボックスが保持しているとおりのラベルの背景色。破棄されずに返されるため、クライアントはアプリ上でユーザーが見ているとおりにラベルを描画できる。
color.textColorstring: 前景色。ネイティブのメールボックスにはこのための列がなく、何を書き込んでも読み取りは `#ffffff` を返す。そのため淡い背景色を指定すると、その上のテキストは読めない状態で返ってくる。