ツール: list_drafts
認証されたユーザーの Gmail アカウントの下書きメールを一覧表示します。
このツールでは、クエリ文字列に基づいて下書きをフィルタし、ページネーションをサポートできます。ID と件名を含む下書きのリストを返します(view が DRAFT_VIEW_METADATA_ONLY に設定されていない場合)。page_token を使用して結果をページ設定できます。結果の次のページを取得するには、前のレスポンスで返された page_token を使用します。
view パラメータは、レスポンスに入力されるフィールドを制御します。デフォルト(または DRAFT_VIEW_FULL を使用した場合)では、コンテンツ全体が返されます。DRAFT_VIEW_METADATA_ONLY を使用して、件名や本文などのデリケートなコンテンツを除外します。
次のサンプルは、curl を使用して list_drafts MCP ツールを呼び出す方法を示しています。
| Curl リクエスト |
|---|
curl --location 'https://gmailmcp.googleapis.com/mcp/v1' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "list_drafts", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
入力スキーマ
ListDrafts RPC のリクエスト メッセージ。
ListDraftsRequest
| JSON 表現 |
|---|
{
"pageSize": integer
"pageToken": string
"query": string
"view": enum ( |
| フィールド | |
|---|---|
共用体フィールド
|
|
pageSize |
省略可。返す下書きの最大数。指定しない場合のデフォルトは 20 です。最大許容値は 50 です。 |
共用体フィールド
|
|
pageToken |
省略可。結果の次のページを取得するために、前の list_drafts 呼び出しから受け取ったトークン。最初のページを取得するには、空欄のままにします。これは主に、ページネーションで前の |
共用体フィールド
|
|
query |
例:
スペースまたはハイフン( 注: クエリのすべての下書きが返されるようにするには、レスポンスに下書きの空のリストが含まれるまで、ツールを繰り返し呼び出して結果をページネーションします。 |
共用体フィールド
|
|
view |
省略可。下書きリストの下書きに設定されるフィールドを制御します。デフォルト(または |
DraftView
ListDrafts レスポンスで下書きに入力されるフィールドを制御する列挙型。
| 列挙型 | |
|---|---|
DRAFT_VIEW_UNSPECIFIED |
下位互換性のために DRAFT_VIEW_FULL にマッピングされます。 |
DRAFT_VIEW_METADATA_ONLY |
メタデータのみ: subject、plaintext_body、html_body は含まれません。 |
DRAFT_VIEW_FULL |
メタデータ + UGC(デフォルトの動作)。 |
出力スキーマ
ListDrafts RPC に対するレスポンス メッセージ。
ListDraftsResponse
| JSON 表現 |
|---|
{
"drafts": [
{
object ( |
| フィールド | |
|---|---|
drafts[] |
下書きのリスト。 |
nextPageToken |
下書きの次のページを取得するために、後続の呼び出しで使用できるトークン。クエリに一致する下書きの数が page_size の上限を超えると、レスポンスに |
ドラフト
| JSON 表現 |
|---|
{ "id": string, "subject": string, "threadId": string, "toRecipients": [ string ], "ccRecipients": [ string ], "bccRecipients": [ string ], "plaintextBody": string, "date": string, "htmlBody": string } |
| フィールド | |
|---|---|
id |
下書きリソースの一意の識別子。 |
subject |
下書きメッセージの件名。 |
threadId |
この下書きが属するスレッドの ID。 |
toRecipients[] |
ヘッダーから抽出された [宛先] 受信者のメールアドレスのリスト。 |
ccRecipients[] |
ヘッダーから抽出された [Cc] 受信者のメールアドレスのリスト。 |
bccRecipients[] |
ヘッダーから抽出された [Bcc] 受信者のメールアドレスのリスト。 |
plaintextBody |
利用可能な場合は、プレーン テキストの本文コンテンツ。 |
date |
下書きの日付(ISO 8601 形式(YYYY-MM-DD))。 |
htmlBody |
下書きの HTML 本文コンテンツ(利用可能な場合)。 |
ツールのアノテーション
破壊的ヒント: ❌ | べき等ヒント: ❌ | 読み取り専用ヒント: ✅ | オープン ワールド ヒント: ❌
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://mail.google.com/https://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.composehttps://www.googleapis.com/auth/gmail.readonly