เอกสารนี้อธิบายวิธีค้นหาและค้นหาข้อความโดยใช้ Gmail API
คุณค้นหาหรือกรองไฟล์ได้โดยใช้เมธอด
messages.list
และ threads.list
เมธอดเหล่านี้ยอมรับพารามิเตอร์การค้นหา q ซึ่งรองรับไวยากรณ์การค้นหาขั้นสูงส่วนใหญ่เช่นเดียวกับ
อินเทอร์เฟซเว็บของ Gmail ดูรายการความแตกต่างในการค้นหาและการกรอง
ระหว่าง UI ของ Gmail กับ Gmail API ได้ที่ความแตกต่างจาก
UI ของ Gmail
ไวยากรณ์การค้นหาขั้นสูงนี้ช่วยให้คุณใช้คำค้นหาเพื่อกรองข้อความตามพร็อพเพอร์ตี้ เช่น ผู้ส่ง วันที่ หรือป้ายกำกับ ตัวอย่างเช่น คำค้นหาต่อไปนี้
messages.list method query จะดึงข้อมูลข้อความทั้งหมดที่ผู้ใช้ส่งในเดือนมกราคม
2014
GET https://www.googleapis.com/gmail/v1/users/me/messages?q=in:sent after:2014/01/01 before:2014/02/01
นอกจากคำค้นหาแล้ว คุณยังกรองข้อความและเธรดตามป้ายกำกับได้ด้วยlabelIds[]พารามิเตอร์ ซึ่งจะช่วยให้คุณค้นหาข้อความและเธรด
ที่มีป้ายกำกับของระบบหรือผู้ใช้ที่ระบุได้ ดูข้อมูลเพิ่มเติมได้ที่วิธีการ
messages.listและthreads.list ดูข้อมูลเพิ่มเติมเกี่ยวกับป้ายกำกับได้ที่จัดการป้ายกำกับ
ความแตกต่างจาก UI ของ Gmail
แม้ว่า Gmail API จะรองรับไวยากรณ์การค้นหาขั้นสูงส่วนใหญ่ที่ใช้ใน UI ของ Gmail แต่ก็มีความแตกต่างอยู่บ้าง ดังนี้
UI ของ Gmail จะทำการขยาย Alias ซึ่งช่วยให้สามารถ อนุมาน Alias ของบัญชีจากบัญชี Google Workspace ได้ เช่น สมมติว่าคุณมีบัญชี
myprimary@cymbalgroup.comและผู้ดูแลระบบ ตั้งค่าอีเมลแทนสำหรับบัญชีmyalias@cymbalgroup.comหากmyalias@cymbalgroup.comส่งอีเมล แต่คุณค้นหา "from: myprimary@cymbalgroup.com" อีเมลที่ส่งโดยmyalias@cymbalgroup.comจะปรากฏในผลการค้นหาใน UI ของ Gmail แต่ไม่ปรากฏในการตอบกลับของ APIUI ของ Gmail อนุญาตให้ผู้ใช้ทำการค้นหาในเธรดได้ แต่ API ไม่อนุญาต