MCP Tools Reference: gmailmcp.googleapis.com

เครื่องมือ: list_drafts

แสดงอีเมลฉบับร่างจากบัญชี Gmail ของผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์

เครื่องมือนี้สามารถกรองฉบับร่างตามสตริงการค้นหาและรองรับการแบ่งหน้า โดยจะแสดงรายการฉบับร่าง รวมถึงรหัสและเรื่อง (เว้นแต่จะตั้งค่า view เป็น DRAFT_VIEW_METADATA_ONLY) คุณสามารถใช้ page_token เพื่อแบ่งหน้าผลลัพธ์ได้ หากต้องการดึงข้อมูลผลลัพธ์ในหน้าถัดไป ให้ใช้ page_token ที่แสดงในคำตอบก่อนหน้า

พารามิเตอร์ view จะควบคุมช่องที่จะแสดงในคำตอบ โดยค่าเริ่มต้น (หรือเมื่อใช้ DRAFT_VIEW_FULL) ระบบจะแสดงเนื้อหาทั้งหมด ใช้ DRAFT_VIEW_METADATA_ONLY เพื่อยกเว้นเนื้อหาที่ละเอียดอ่อน เช่น เรื่องและเนื้อหา

ตัวอย่างต่อไปนี้แสดงวิธีใช้ curl เพื่อเรียกใช้เครื่องมือ MCP list_drafts

คำขอ 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 (DraftView)
}
ช่อง

ฟิลด์ Union _page_size

_page_size สามารถเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
pageSize

integer

ไม่บังคับ จำนวนฉบับร่างสูงสุดที่จะแสดง หากไม่ระบุ ค่าเริ่มต้นจะเป็น 20 ค่าสูงสุดที่อนุญาตคือ 50

ฟิลด์ Union _page_token

_page_token สามารถเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
pageToken

string

ไม่บังคับ โทเค็นที่ได้รับจากการเรียกใช้ list_drafts ครั้งก่อนเพื่อดึงข้อมูลผลลัพธ์ในหน้าถัดไป ปล่อยว่างไว้เพื่อดึงข้อมูลหน้าแรก โดยส่วนใหญ่จะใช้สำหรับการแบ่งหน้าเพื่อดึงข้อมูลผลลัพธ์ต่อจากที่การเรียกใช้ ListDraft ครั้งก่อนหยุดไว้ โดยเฉพาะอย่างยิ่งเมื่อจำนวนฉบับร่างที่ตรงกับคำค้นหาเกินขีดจำกัด page_size

ฟิลด์ Union _query

_query สามารถเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
query

string

ตัวอย่าง

  • subject:OneMCP Update
  • from:gduser1@workspacesamples.dev
  • to:gduser2@workspacesamples.dev AND newer_than:7d
  • project proposal has:attachment
  • is:unread

การเว้นวรรคหรือเครื่องหมายขีดกลาง (-) จะเป็นการแยกหมายเลข ในขณะที่จุด (.) จะหมายถึงจุดทศนิยม เช่น 01.2047-100 ถือว่าเป็นตัวเลข 2 ชุด คือ 01.2047 และ 100

หมายเหตุ: หากต้องการให้แน่ใจว่าระบบจะแสดงฉบับร่างทั้งหมดสำหรับคำค้นหา เราสามารถแบ่งหน้าผลลัพธ์ได้โดยการเรียกใช้เครื่องมือซ้ำๆ จนกว่าคำตอบจะมีรายการฉบับร่างว่างเปล่า

ฟิลด์ Union _view

_view สามารถเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
view

enum (DraftView)

ไม่บังคับ ควบคุมช่องที่จะแสดงสำหรับฉบับร่างในรายการฉบับร่าง โดยค่าเริ่มต้น (หรือเมื่อใช้ DRAFT_VIEW_FULL) ระบบจะแสดงเนื้อหาทั้งหมด ซึ่งมีรหัสฉบับร่าง, threadID, ผู้รับ, สำเนา, สำเนาลับ, วันที่, เรื่อง และเนื้อหา ใช้ DRAFT_VIEW_METADATA_ONLY เพื่อยกเว้นเรื่องและเนื้อหา

DraftView

Enum เพื่อควบคุมช่องที่จะแสดงสำหรับฉบับร่างในคำตอบ ListDrafts

Enum
DRAFT_VIEW_UNSPECIFIED แมปกับ DRAFT_VIEW_FULL เพื่อความเข้ากันได้แบบย้อนหลัง
DRAFT_VIEW_METADATA_ONLY ข้อมูลเมตาเท่านั้น: ไม่รวมเรื่อง, plaintext_body, html_body
DRAFT_VIEW_FULL ข้อมูลเมตา + UGC (ลักษณะการทำงานเริ่มต้น)

สคีมาเอาต์พุต

ข้อความคำตอบสำหรับ ListDrafts RPC

ListDraftsResponse

การแสดง JSON 
{
  "drafts": [
    {
      object (Draft)
    }
  ],
  "nextPageToken": string
}
ช่อง
drafts[]

object (Draft)

รายการฉบับร่าง
nextPageToken

string

โทเค็นที่ใช้ในการเรียกใช้ครั้งถัดไปเพื่อดึงข้อมูลฉบับร่างในหน้าถัดไป หากจำนวนฉบับร่างที่ตรงกับคำค้นหาเกินขีดจำกัด page_size คำตอบจะมี next_page_token หากต้องการดึงข้อมูลผลลัพธ์ในหน้าถัดไป ให้ส่งโทเค็นนี้ในช่อง page_token ของ ListDraftsRequest ครั้งถัดไป

Draft

การแสดง JSON 
{
  "id": string,
  "subject": string,
  "threadId": string,
  "toRecipients": [
    string
  ],
  "ccRecipients": [
    string
  ],
  "bccRecipients": [
    string
  ],
  "plaintextBody": string,
  "date": string,
  "htmlBody": string
}
ช่อง
id

string

ตัวระบุที่ไม่ซ้ำกันของทรัพยากรฉบับร่าง
subject

string

บรรทัดเรื่องของข้อความฉบับร่าง
threadId

string

รหัสของเธรดที่ฉบับร่างนี้เป็นของ
toRecipients[]

string

รายการอีเมลของผู้รับ "ถึง" ที่แยกจากส่วนหัว
ccRecipients[]

string

รายการอีเมลของผู้รับ "สำเนา" ที่แยกจากส่วนหัว
bccRecipients[]

string

รายการอีเมลของผู้รับ "สำเนาลับ" ที่แยกจากส่วนหัว
plaintextBody

string

เนื้อหาข้อความธรรมดา (หากมี)
date

string

วันที่ของฉบับร่างในรูปแบบ ISO 8601 (YYYY-MM-DD)
htmlBody

string

เนื้อหา HTML ของฉบับร่าง (หากมี)

คำอธิบายประกอบของเครื่องมือ

คำแนะนำที่อาจทำให้เกิดการเปลี่ยนแปลง: ❌ | คำแนะนำที่อาจทำให้เกิดการเปลี่ยนแปลงซ้ำได้: ❌ | คำแนะนำแบบอ่านอย่างเดียว: ✅ | คำแนะนำแบบเปิด: ❌

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.compose
  • https://www.googleapis.com/auth/gmail.readonly