ラベルを使用すると、Gmail でメッセージやスレッドにタグ付け、整理、分類を行うことができます。ラベルには、メッセージやスレッドと多対多の関係があります。1 つのメッセージまたはスレッドに複数のラベルを適用し、複数のメッセージまたはスレッドに 1 つのラベルを適用できます。
ラベルの作成、取得、一覧表示、更新、削除の方法については、ラベルのリファレンスをご覧ください。
ラベルを管理するには、https://www.googleapis.com/auth/gmail.labels スコープを使用する必要があります。スコープの詳細については、Gmail API 固有の認可と認証情報をご覧ください。
ラベルの種類
ラベルには、予約済みの SYSTEM ラベルとカスタム USER ラベルの 2 種類があります。システムラベルは通常、受信トレイなど、Gmail ウェブ インターフェースの事前定義された要素に対応しています。システムラベル名は予約されています。SYSTEM ラベルと同じ名前で USER ラベルを作成することはできません。次の表に、よく使用される Gmail システムラベルを示します。
| 名前 | 手動で適用可能 | メモ |
|---|---|---|
INBOX |
あり | |
SPAM |
はい | |
TRASH |
はい | |
UNREAD |
はい | |
STARRED |
はい | |
IMPORTANT |
あり | |
SENT |
× | drafts.send または messages.send で送信されたメッセージ、From ヘッダーに messages.insert とユーザーのメールアドレス、またはユーザーがウェブ インターフェースで送信したメッセージに自動的に適用されます。 |
DRAFT |
× | Gmail API または Gmail インターフェースで作成されたすべての draft メッセージに自動的に適用されます。 |
CATEGORY_PERSONAL |
あり | Gmail インターフェースの [個人用] タブに表示されるメッセージに対応します。 |
CATEGORY_SOCIAL |
あり | Gmail インターフェースの [ソーシャル] タブに表示されるメッセージに対応します。 |
CATEGORY_PROMOTIONS |
あり | Gmail インターフェースの [プロモーション] タブに表示されるメッセージに対応します。 |
CATEGORY_UPDATES |
あり | Gmail インターフェースの [アップデート] タブに表示されるメッセージに対応します。 |
CATEGORY_FORUMS |
あり | Gmail インターフェースの [フォーラム] タブに表示されるメッセージに対応します。 |
メッセージとスレッドのラベルを管理する
ラベルはメールにのみ存在します。たとえば、スレッドのラベルを一覧表示すると、スレッド内の任意のメッセージに存在するラベルのリストが表示されます。スレッド内のすべてのメッセージにラベルが存在するとは限りません。メッセージには複数のラベルを適用できますが、下書きメッセージにラベルを適用することはできません。
スレッドへのラベルの追加または削除
スレッドにラベルを追加または削除すると、スレッド内の既存のすべてのメールに対して指定したラベルが追加または削除されます。
ラベルを追加した後にメールがスレッドに追加された場合、新しいメールはスレッドに関連付けられている既存のラベルを継承しません。これらのメッセージにラベルを追加するには、スレッドにもう一度ラベルを追加します。
スレッドに関連付けられたラベルを追加または削除するには、threads.modify を使用します。
メールにラベルを追加または削除する
メッセージにラベルを追加すると、そのメッセージにラベルが追加され、メッセージが属するスレッドに関連付けられます。スレッド内の他のメッセージには追加されません。
メールからラベルを削除すると、スレッド内でそのラベルが付けられた唯一のメールだった場合、そのラベルはスレッドから削除されます。
メッセージに適用されたラベルを追加または削除するには、messages.modify を使用します。