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.forwardingAddress
- ทรัพยากร 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 ตั้งค่าหรืออัปเดตนาฬิกาข้อความ 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.forwardingAddress
| วิธีการ | |
|---|---|
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 นําชุดข้อความที่ระบุออกจากถังขยะ |