ממשק ה-API של Gmail מאפשר להציג ולנהל נתוני תיבת דואר ב-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
מסמך Discovery הוא מפרט קריא למחשבים שמיועד לתיאור ולשימוש בממשקי API ל-REST. הוא משמש לבניית ספריות לקוח, יישומי פלאגין ל-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 הפסקת קבלת ההתראות לגבי תיבת הדואר הנכנס של המשתמש. |
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 הנתונה לכינוי השליחה בשדה 'שליחה בשם' שצוין. |
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} הפונקציה מקבלת את ה-thread שצוין. |
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 – הסרת השרשור שצוין מהאשפה. |