Gmail API

באמצעות Gmail API אפשר להציג ולנהל נתונים של תיבת הדואר הנכנס ב-Gmail, כמו שיחות, הודעות ותוויות.

שירות: gmail.googleapis.com

כדי לקרוא לשירות הזה, מומלץ להשתמש בספריות הלקוח ש-Google מספקת. אם האפליקציה שלכם צריכה להשתמש בספריות משלכם כדי לקרוא לשירות הזה, צריך להשתמש במידע הבא כששולחים את בקשות ה-API.

מסמך Discovery

מסמך Discovery הוא מפרט שקריא למכונות, שמתאר ממשקי API ל-REST ומאפשר להשתמש בהם. הוא משמש ליצירת ספריות לקוח, יישומי פלאגין ל-IDE וכלים אחרים שמקיימים אינטראקציה עם Google APIs. שירות אחד יכול לספק כמה מסמכי גילוי. השירות הזה מספק את מסמך הגילוי הבא:

נקודת קצה לשירות

נקודת קצה של שירות היא כתובת URL בסיסית שצוינה בה כתובת הרשת של שירות API. לשירות אחד יכולות להיות כמה נקודות קצה של שירות. לשירות הזה יש את נקודת הקצה הבאה, וכל מזהי ה-URI שבהמשך הם יחסיים לנקודת הקצה הזו:

  • https://gmail.googleapis.com

משאב REST: v1.users

Methods
getProfile GET /gmail/v1/users/{userId}/profile
הפונקציה מקבלת את פרופיל Gmail של המשתמש הנוכחי.
stop POST /gmail/v1/users/{userId}/stop
הפסקת קבלת התראות בדחיפה עבור תיבת הדואר הנכנס של המשתמש הנתון.
watch POST /gmail/v1/users/{userId}/watch
הגדרה או עדכון של מעקב אחר התראות בתיבת הדואר של המשתמש הנתון.

משאב REST: v1.users.drafts

Methods
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

Methods
list GET /gmail/v1/users/{userId}/history
הצגת היסטוריית כל השינויים בתיבת הדואר הנתונה.

משאב REST: v1.users.labels

Methods
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

Methods
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

Methods
get GET /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}
הפונקציה מקבלת את הקובץ המצורף של ההודעה שצוינה.

משאב REST: v1.users.settings

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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
הסרת השרשור שצוין מהאשפה.