ラベルを使用すると、Gmail でメールやスレッドにタグを付けたり、整理したり、分類したりできます。ラベルは、メッセージとスレッドとの間に多対多の関係があります。1 つのメッセージまたはスレッドに複数のラベルを適用したり、1 つのラベルを複数のメッセージまたはスレッドに適用したりできます。
ラベルのcreate、取得、一覧表示、更新、削除方法については、ラベルのリファレンスをご覧ください。
ラベルを管理するには、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 を使用します。