Gmail API ช่วยให้คุณดูและจัดการข้อมูลกล่องจดหมาย Gmail เช่น ชุดข้อความ ข้อความ และป้ายกำกับได้
- ทรัพยากร REST: v1.users
- ทรัพยากร REST: v1.users.drafts
- ทรัพยากร REST: v1.users.history
- ทรัพยากร REST: v1.users.labels
- ทรัพยากร REST: v1.users.messages
- ทรัพยากร REST: v1.users.messages.attachments
- ทรัพยากร REST: v1.users.settings
- ทรัพยากร REST: v1.users.settings.cse.identities
- ทรัพยากร REST: v1.users.settings.cse.keypairs
- ทรัพยากร REST: v1.users.settings.delegates
- ทรัพยากร REST: v1.users.settings.filters
- ทรัพยากร REST: v1.users.settings.forwardingAddresses
- ทรัพยากร REST: v1.users.settings.sendAs
- ทรัพยากร REST: v1.users.settings.sendAs.smimeInfo
- ทรัพยากร REST: v1.users.threads
บริการ: gmail.googleapis.com
หากต้องการเรียกใช้บริการนี้ เราขอแนะนำให้คุณใช้ไลบรารีไคลเอ็นต์ที่ Google มีให้ หากแอปพลิเคชันของคุณต้องใช้ไลบรารีของคุณเองเพื่อเรียกใช้บริการนี้ ให้ใช้ข้อมูลต่อไปนี้เมื่อส่งคำขอ API
เอกสารการค้นพบ
เอกสาร Discovery คือข้อกำหนดเฉพาะที่เครื่องอ่านได้สำหรับอธิบายและใช้ REST API โดยใช้ในการสร้างไลบรารีของไคลเอ็นต์ ปลั๊กอิน IDE และเครื่องมืออื่นๆ ที่โต้ตอบกับ Google API บริการหนึ่งๆ อาจให้เอกสารการค้นพบได้หลายรายการ บริการนี้มีเอกสารการค้นพบต่อไปนี้
ปลายทางของบริการ
ปลายทางบริการคือ 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 ตั้งค่าหรืออัปเดตการตรวจสอบการแจ้งเตือนแบบพุชในกล่องจดหมายของผู้ใช้ที่ระบุ |
ทรัพยากร 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 ที่ระบุสำหรับอีเมลแทนที่ใช้ส่ง |
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 นำชุดข้อความที่ระบุออกจากถังขยะ |