Gmail API

Gmail API ช่วยให้คุณดูและจัดการข้อมูลกล่องจดหมาย Gmail เช่น ชุดข้อความ ข้อความ และป้ายกำกับได้

บริการ: gmail.googleapis.com

หากต้องการเรียกใช้บริการนี้ เราขอแนะนำให้คุณใช้ไลบรารีของไคลเอ็นต์ที่ Google มีให้ หากแอปพลิเคชันจำเป็นต้องใช้ไลบรารีของคุณเองเพื่อเรียกใช้บริการนี้ ให้ใช้ข้อมูลต่อไปนี้เมื่อคุณส่งคำขอ API

เอกสารการค้นพบ

เอกสารการค้นพบเป็นข้อกำหนดที่เครื่องอ่านได้สำหรับการอธิบายและใช้งาน REST API ใช้สำหรับสร้างไลบรารีของไคลเอ็นต์, ปลั๊กอิน IDE และเครื่องมืออื่นๆ ที่โต้ตอบกับ Google APIs บริการเดียวอาจมีเอกสารการค้นพบได้หลายรายการ บริการนี้มีเอกสารการค้นพบต่อไปนี้

ปลายทางบริการ

ปลายทางของบริการคือ URL พื้นฐานที่ระบุที่อยู่เครือข่ายของบริการ API บริการเดียวอาจมีปลายทางบริการหลายรายการ บริการนี้มีปลายทางบริการต่อไปนี้และ URI ด้านล่างทั้งหมดจะเกี่ยวข้องกับปลายทางของบริการนี้

  • https://gmail.googleapis.com

ทรัพยากร REST: v1.users

วิธีการ
getProfile GET /gmail/v1/users/{userId}/profile
รับโปรไฟล์ Gmail ของผู้ใช้ปัจจุบัน
stop POST /gmail/v1/users/{userId}/stop
หยุดรับข้อความ Push สำหรับกล่องจดหมายของผู้ใช้ที่ระบุ
watch POST /gmail/v1/users/{userId}/watch
ตั้งค่าหรืออัปเดตนาฬิกาข้อความ Push ในกล่องจดหมายของผู้ใช้ที่ระบุ

ทรัพยากร REST: v1.users.drafts

วิธีการ
create POST /gmail/v1/users/{userId}/drafts
POST /upload/gmail/v1/users/{userId}/drafts
สร้างฉบับร่างใหม่ที่มีป้ายกำกับ DRAFT
delete DELETE /gmail/v1/users/{userId}/drafts/{id}
ลบฉบับร่างที่ระบุทันทีและอย่างถาวร
get GET /gmail/v1/users/{userId}/drafts/{id}
รับฉบับร่างที่ระบุ
list GET /gmail/v1/users/{userId}/drafts
แสดงฉบับร่างในกล่องจดหมายของผู้ใช้
send POST /gmail/v1/users/{userId}/drafts/send
POST /upload/gmail/v1/users/{userId}/drafts/send
ส่งฉบับร่างที่ระบุไว้ที่มีอยู่ไปยังผู้รับในส่วนหัว To, Cc และ Bcc
update PUT /gmail/v1/users/{userId}/drafts/{id}
PUT /upload/gmail/v1/users/{userId}/drafts/{id}
แทนที่เนื้อหาของฉบับร่าง

ทรัพยากร REST: v1.users.history

วิธีการ
list GET /gmail/v1/users/{userId}/history
แสดงประวัติการเปลี่ยนแปลงทั้งหมดในกล่องจดหมายที่ระบุ

ทรัพยากร REST: v1.users.labels

วิธีการ
create POST /gmail/v1/users/{userId}/labels
สร้างป้ายกำกับใหม่
delete DELETE /gmail/v1/users/{userId}/labels/{id}
ลบป้ายกำกับที่ระบุและนำป้ายกำกับออกจากข้อความและชุดข้อความที่ใช้ป้ายนั้นอย่างถาวรทันที
get GET /gmail/v1/users/{userId}/labels/{id}
รับป้ายกำกับที่ระบุ
list GET /gmail/v1/users/{userId}/labels
แสดงป้ายกำกับทั้งหมดในกล่องจดหมายของผู้ใช้
patch PATCH /gmail/v1/users/{userId}/labels/{id}
แพตช์ป้ายกํากับที่ระบุ
update PUT /gmail/v1/users/{userId}/labels/{id}
อัปเดตป้ายกำกับที่ระบุ

ทรัพยากร REST: v1.users.messages

วิธีการ
batchDelete POST /gmail/v1/users/{userId}/messages/batchDelete
ลบข้อความจำนวนมากตามรหัสข้อความ
batchModify POST /gmail/v1/users/{userId}/messages/batchModify
แก้ไขป้ายกำกับในข้อความที่ระบุ
delete DELETE /gmail/v1/users/{userId}/messages/{id}
ลบข้อความที่ระบุทันทีและอย่างถาวร
get GET /gmail/v1/users/{userId}/messages/{id}
รับข้อความที่ระบุ
import POST /gmail/v1/users/{userId}/messages/import
POST /upload/gmail/v1/users/{userId}/messages/import
นำเข้าข้อความไปยังกล่องจดหมายของผู้ใช้รายนี้เท่านั้น โดยใช้การสแกนการส่งอีเมลแบบมาตรฐานและการจัดประเภทคล้ายกับการรับผ่าน SMTP
insert POST /gmail/v1/users/{userId}/messages
POST /upload/gmail/v1/users/{userId}/messages
แทรกข้อความโดยตรงเฉพาะในกล่องจดหมายของผู้ใช้รายนี้ซึ่งคล้ายกับ IMAP APPEND เพื่อเลี่ยงการสแกนและการจัดประเภทส่วนใหญ่
list GET /gmail/v1/users/{userId}/messages
แสดงข้อความในกล่องจดหมายของผู้ใช้
modify POST /gmail/v1/users/{userId}/messages/{id}/modify
แก้ไขป้ายกำกับในข้อความที่ระบุ
send POST /gmail/v1/users/{userId}/messages/send
POST /upload/gmail/v1/users/{userId}/messages/send
ส่งข้อความที่ระบุไปยังผู้รับในส่วนหัว To, Cc และ Bcc
trash POST /gmail/v1/users/{userId}/messages/{id}/trash
ย้ายข้อความที่ระบุไปยังถังขยะ
untrash POST /gmail/v1/users/{userId}/messages/{id}/untrash
นำข้อความที่ระบุออกจากถังขยะ

ทรัพยากร REST: v1.users.messages.attachments

วิธีการ
get GET /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}
รับไฟล์แนบของข้อความที่ระบุ

ทรัพยากร REST: v1.users.settings

วิธีการ
getAutoForwarding GET /gmail/v1/users/{userId}/settings/autoForwarding
รับการตั้งค่าการส่งต่ออัตโนมัติสำหรับบัญชีที่ระบุ
getImap GET /gmail/v1/users/{userId}/settings/imap
รับการตั้งค่า IMAP
getLanguage GET /gmail/v1/users/{userId}/settings/language
รับการตั้งค่าภาษา
getPop GET /gmail/v1/users/{userId}/settings/pop
รับการตั้งค่า POP
getVacation GET /gmail/v1/users/{userId}/settings/vacation
รับการตั้งค่าการช่วยตอบอีเมลอัตโนมัติ
updateAutoForwarding PUT /gmail/v1/users/{userId}/settings/autoForwarding
อัปเดตการตั้งค่าการส่งต่ออัตโนมัติสำหรับบัญชีที่ระบุ
updateImap PUT /gmail/v1/users/{userId}/settings/imap
อัปเดตการตั้งค่า IMAP
updateLanguage PUT /gmail/v1/users/{userId}/settings/language
อัปเดตการตั้งค่าภาษา
updatePop PUT /gmail/v1/users/{userId}/settings/pop
อัปเดตการตั้งค่า POP
updateVacation PUT /gmail/v1/users/{userId}/settings/vacation
อัปเดตการตั้งค่าการช่วยตอบอีเมลอัตโนมัติ

ทรัพยากร REST: v1.users.settings.cse.identities

วิธีการ
create POST /gmail/v1/users/{userId}/settings/cse/identities
สร้างและกำหนดค่าข้อมูลระบุตัวตนการเข้ารหัสฝั่งไคลเอ็นต์ที่ได้รับอนุญาตให้ส่งอีเมลจากบัญชีผู้ใช้
delete DELETE /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
ลบข้อมูลระบุตัวตนการเข้ารหัสฝั่งไคลเอ็นต์
get GET /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
เรียกข้อมูลการกำหนดค่าข้อมูลประจำตัวสำหรับการเข้ารหัสฝั่งไคลเอ็นต์
list GET /gmail/v1/users/{userId}/settings/cse/identities
แสดงรายการข้อมูลประจำตัวที่เข้ารหัสฝั่งไคลเอ็นต์สำหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
patch PATCH /gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
เชื่อมโยงคู่คีย์อื่นกับข้อมูลระบุตัวตนการเข้ารหัสฝั่งไคลเอ็นต์ที่มีอยู่

ทรัพยากร REST: v1.users.settings.cse.keypairs

วิธีการ
create POST /gmail/v1/users/{userId}/settings/cse/keypairs
สร้างและอัปโหลดเชนใบรับรองคีย์สาธารณะ S/MIME สำหรับการเข้ารหัสฝั่งไคลเอ็นต์และข้อมูลเมตาของคีย์ส่วนตัวสำหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
disable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
ปิดคู่คีย์การเข้ารหัสฝั่งไคลเอ็นต์
enable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
เปิดคู่คีย์การเข้ารหัสฝั่งไคลเอ็นต์ที่ปิดอยู่
get GET /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}
เรียกคู่คีย์การเข้ารหัสฝั่งไคลเอ็นต์ที่มีอยู่
list GET /gmail/v1/users/{userId}/settings/cse/keypairs
แสดงรายการคู่คีย์การเข้ารหัสฝั่งไคลเอ็นต์สําหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
obliterate POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
ลบคู่คีย์การเข้ารหัสฝั่งไคลเอ็นต์อย่างถาวรและทันที

ทรัพยากร REST: v1.users.settings.delegates

วิธีการ
create POST /gmail/v1/users/{userId}/settings/delegates
เพิ่มผู้รับมอบสิทธิ์ที่ตั้งสถานะการยืนยันเป็น accepted โดยตรง โดยไม่ต้องส่งอีเมลยืนยัน
delete DELETE /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
นําผู้รับมอบสิทธิ์ที่ระบุออก (ซึ่งอาจเป็นสถานะการยืนยันใดก็ได้) และเพิกถอนการยืนยันที่อาจจําเป็นสําหรับการใช้งาน
get GET /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
รับผู้รับมอบสิทธิ์ที่ระบุ
list GET /gmail/v1/users/{userId}/settings/delegates
แสดงผู้รับมอบสิทธิ์สำหรับบัญชีที่ระบุ

ทรัพยากร REST: v1.users.settings.filters

วิธีการ
create POST /gmail/v1/users/{userId}/settings/filters
สร้างตัวกรอง
delete DELETE /gmail/v1/users/{userId}/settings/filters/{id}
ลบตัวกรองที่ระบุทันทีและอย่างถาวร
get GET /gmail/v1/users/{userId}/settings/filters/{id}
รับตัวกรอง
list GET /gmail/v1/users/{userId}/settings/filters
แสดงรายการตัวกรองข้อความของผู้ใช้ Gmail

ทรัพยากร REST: v1.users.settings.forwardingAddresses

วิธีการ
create POST /gmail/v1/users/{userId}/settings/forwardingAddresses
สร้างอีเมลที่ใช้รับการส่งต่อ
delete DELETE /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
ลบอีเมลที่ใช้รับการส่งต่อที่ระบุและเพิกถอนการยืนยันที่อาจจำเป็น
get GET /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
รับที่อยู่ส่งต่อที่ระบุ
list GET /gmail/v1/users/{userId}/settings/forwardingAddresses
แสดงรายการอีเมลสำหรับส่งต่อของบัญชีที่ระบุ

ทรัพยากร REST: v1.users.settings.sendAs

วิธีการ
create POST /gmail/v1/users/{userId}/settings/sendAs
สร้างอีเมลแทนสำหรับส่ง "จาก" ที่กำหนดเอง
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
ลบชื่อแทนที่ใช้ส่งที่ระบุ
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
รับชื่อแทนที่ใช้ส่งที่ระบุ
list GET /gmail/v1/users/{userId}/settings/sendAs
แสดงชื่อแทนที่ใช้ส่งสำหรับบัญชีที่ระบุ
patch PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
แพตช์ชื่อแทนการส่งที่ระบุ
update PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
อัปเดตชื่อแทนที่ใช้ส่งเป็น
verify POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
ส่งอีเมลยืนยันไปยังที่อยู่อีเมลแทนที่ระบุ

ทรัพยากร REST: v1.users.settings.sendAs.smimeInfo

วิธีการ
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
ลบการกำหนดค่า S/MIME ที่ระบุสำหรับชื่อแทน "ส่งในชื่อ" ที่ระบุ
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
รับการกำหนดค่า S/MIME ที่ระบุสำหรับชื่อแทน "ส่งในชื่อ" ที่ระบุ
insert POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
แทรก (อัปโหลด) การกำหนดค่า S/MIME ที่ระบุให้กับชื่อแทน Send-as ที่ระบุ
list GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
แสดงรายการการกำหนดค่า S/MIME ของชื่อแทน "ส่งในชื่อ" ที่ระบุ
setDefault POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault
ตั้งค่าการกำหนดค่า S/MIME เริ่มต้นสำหรับชื่อแทนการส่งที่ระบุ

ทรัพยากร REST: v1.users.threads

วิธีการ
delete DELETE /gmail/v1/users/{userId}/threads/{id}
ลบชุดข้อความที่ระบุอย่างถาวรทันที
get GET /gmail/v1/users/{userId}/threads/{id}
รับชุดข้อความที่ระบุ
list GET /gmail/v1/users/{userId}/threads
แสดงรายการชุดข้อความในกล่องจดหมายของผู้ใช้
modify POST /gmail/v1/users/{userId}/threads/{id}/modify
แก้ไขป้ายกํากับที่ใช้กับชุดข้อความ
trash POST /gmail/v1/users/{userId}/threads/{id}/trash
ย้ายชุดข้อความที่ระบุไปยังถังขยะ
untrash POST /gmail/v1/users/{userId}/threads/{id}/untrash
นำชุดข้อความที่ระบุออกจากถังขยะ