Gmail API

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

שירות: gmail.googleapis.com

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

מסמך Discovery

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

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

נקודת קצה של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות API. יכול להיות שלשירות אחד יהיו כמה נקודות קצה של שירות. לשירות הזה יש נקודת קצה (endpoint) משלו, וכל כתובות ה-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
הסרה של השרשור שצוין מהאשפה.