Gmail API v1（Java）を使用して、
Gmailのメールボックス内のスレッドを取得する方法
についてご紹介します。
スレッドとは
件名と宛先が同じで関連する複数の一連のメールのやりとりをまとめて表示する機能です。
APIを利用する環境の準備から始める場合や、コードを実行する際は、
⧉[Gmail API] JavaでGmail APIを使う
を参照ください。
本文中の引数にある「メールアドレス」の指定は、
OAuth 2.0使用の場合は「me」（自身）と指定してください。
「me」は認証されたユーザーを示します。
| No | 目次 | |
|---|---|---|
| 1 | スレッド一覧を取得 | |
| 1 | スコープ | |
| 2 | 実行 | |
| 3 | レスポンスの内容 | |
| 2 | スレッドを取得 | |
| 1 | スコープ | |
| 2 | 実行 | |
| 3 | レスポンスの内容 |
1. スレッド一覧を取得
スレッド一覧を取得します。
一覧の取得ではスレッドの詳細内容までは取得できません。
詳細内容を取得したい場合は2. スレッドを取得を参照ください。
1.1. スコープ
このAPIを実行するには、以下のいずれかのスコープを指定してください。
GmailScopes.MAIL_GOOGLE_COM
GmailScopes.GMAIL_MODIFY
GmailScopes.GMAIL_READONLY
GmailScopes.GMAIL_METADATA
⧉[Gmail API] JavaでGmail APIを使う(2.2 Gmailインスタンスを取得)
でスコープを指定してください。
1.2. 実行
public static void main(String[] args) throws Exception{
Gmail gmail = getGmail();
Gmail.Users users = gmail.users();
Gmail.Users.Threads threads = users.threads();
Gmail.Users.Threads.List list = threads.list("メールアドレス");
ListThreadsResponse res = list.execute();
System.out.println(res);
}
1.2.1. HTTPリクエスト
GET: https://gmail.googleapis.com/gmail/v1/users/{メールアドレス}/threads
が実行されます。
1.2.2. クエリパラメータ
Gmail.Users.Threads.Listのsetメソッドにより、クエリパラメータを追加できます。
| メソッド | 引数 | 説明 |
|---|---|---|
| setMaxResults | Long | 返されるスレッドの最大数 デフォルトは100、最大値は500 |
| setPageToken | String | リスト内の結果の特定のページを取得するためのページトークン |
| setQ | String | 指定されたクエリに一致するスレッドのみを取得 Gmailの検索ボックスと同じクエリ形式 |
| setLabelIds | List<String> | 取得するスレッドのラベルID |
| setIncludeSpamTrash | Boolean | SPAMからのスレッドとTRASH結果にスレッドを含めるか |
1.3. レスポンスの内容
ListThreadsResponse
| メソッド | 戻り値 | 説明 |
|---|---|---|
| getThreads | List<Thread> | スレッドのリスト |
| getNextPageToken | String | リスト内の結果の次のページを取得するためのページトークン |
| getResultSizeEstimate | Long | 結果の推定合計数 |
Thread
(com.google.api.services.gmail.model.Thread)
| メソッド | 戻り値 | 説明 |
|---|---|---|
| getId | String | スレッドID |
| getSnippet | String | メッセージテキスト |
| getHistoryId | String | スレッドを変更した最後の履歴レコードID |
| getMessages | List<Message> | スレッド内のメッセージのリスト |
Message
| メソッド | 戻り値 | 説明 |
|---|---|---|
| getId | String | メッセージID |
| getThreadId | String | メッセージが属するスレッドID |
| getLabelIds | List<String> | このメッセージに適用されるラベルのIDのリスト |
| getSnippet | String | メッセージテキストの短い部分 |
| getHistoryId | String | このメッセージを変更した最後の履歴レコードの ID |
| getInternalDate | Long | 内部メッセージ作成タイムスタンプ(エポックミリ秒) |
| getPayload | MessagePart | メッセージ部分の解析された電子メール構造。 |
| getSizeEstimate | Integer | メッセージの推定サイズ(バイト単位) |
| getRaw | String | RFC2822形式で Base64URLエンコードされた文字列の電子メールメッセージ全体 |
MessagePart
| メソッド | 戻り値 | 説明 |
|---|---|---|
| getPartId | String | メッセージ部分ID |
| getMimeType | String | メッセージ部分のMIMEタイプ |
| getFilename | String | 添付ファイルのファイル名 |
| getHeaders | List<MessagePartHeader> | メッセージ部分のヘッダーのリスト |
| getBody | MessagePartBody | メッセージ部分の本文 |
| getParts | List<MessagePart> | 子のMIMEメッセージ部分 |
MessagePartHeader
| メソッド | 戻り値 | 説明 |
|---|---|---|
| getName | String | セパレータの前のヘッダーの名前 |
| getValue | String | 区切り文字の後のヘッダーの値 |
MessagePartBody
| メソッド | 戻り値 | 説明 |
|---|---|---|
| getAttachmentId | String | 添付ファイルID |
| getSize | Integer | メッセージ部分データのバイト数 |
| getData | String | MIME メッセージ部分の本文データ(base64 url エンコード文字列) |
2. スレッドを取得
スレッドを取得します。
2.1. スコープ
このAPIを実行するには、以下のいずれかのスコープを指定してください。
GmailScopes.MAIL_GOOGLE_COM
GmailScopes.GMAIL_MODIFY
GmailScopes.GMAIL_READONLY
GmailScopes.GMAIL_METADATA
⧉[Gmail API] JavaでGmail APIを使う(2.2 Gmailインスタンスを取得)
でスコープを指定してください。
2.2. 実行
public static void main(String[] args) throws Exception{
Gmail gmail = getGmail();
Gmail.Users users = gmail.users();
Gmail.Users.Threads threads = users.threads();
Gmail.Users.Threads.Get get = threads.get("メールアドレス","スレッドID");
com.google.api.services.gmail.model.Thread res = get.execute();
System.out.println(res);
}
2.2.1. HTTPリクエスト
GET: https://gmail.googleapis.com/gmail/v1/users/{メールアドレス}/threads/{スレッドID}
が実行されます。
2.2.2. クエリパラメータ
Gmail.Users.Threads.Getのsetメソッドにより、クエリパラメータを追加できます。
| メソッド | 引数 | 説明 |
|---|---|---|
| setFormat | Format(enum) | メッセージを返す形式 |
| setMetadataHeaders | List<String> | 取得するスレッドのMETADATA |
Format
| 定義値 | 内容 |
|---|---|
| full | 全てのメールメッセージのデータ |
| metadata | メッセージID、ラベル、およびメールヘッダのみ |
| minimal | メッセージIDとラベルのみ |
2.3. レスポンスの内容
Thread
1.3. レスポンスの内容(Thread)の内容と同じです。
おしまい。。