במאמר הזה מוסבר איך ליצור, לעדכן ולשלוח טיוטות של אימיילים באמצעות Gmail API.
טיוטות של אימיילים מייצגות הודעות שלא נשלחו עם תווית המערכת DRAFT.
אחרי שיוצרים את ההודעה בטיוטה, אי אפשר לערוך אותה, אבל אפשר להחליף אותה. במובן הזה, המשאב drafts הוא מאגר שמספק מזהה יציב, כי מזהי ההודעות הבסיסיים משתנים בכל פעם שההודעה מוחלפת.
למשאב messages בטיוטה יש התנהגות דומה לזו של הודעות אחרות, למעט ההבדלים הבאים:
- הודעות בטיוטה לא יכולות לקבל תוויות אחרות מלבד תווית המערכת
DRAFT. - כששולחים את הטיוטה, היא נמחקת באופן אוטומטי ונוצרת הודעה חדשה עם מזהה מעודכן ותווית המערכת
SENT. ההודעה הזו מוחזרת בתגובת השיטהdrafts.send.
יצירת טיוטות
האפליקציה יכולה ליצור טיוטות באמצעות ה-method drafts.create. כדי ליצור טיוטה:
- יצירת הודעת MIME שתואמת ל-RFC 2822.
- ממירים את ההודעה למחרוזת בקידוד base64URL.
- מבצעים קריאה ל-
drafts.createומגדירים את הערך של השדהmessages.rawלמחרוזת המקודדת.
בדוגמאות הקוד הבאות אפשר לראות את התהליך:
Java
Python
cURL
curl --request POST \
'https://gmail.googleapis.com/gmail/v1/users/me/drafts' \
--header 'Authorization: Bearer ACCESS_TOKEN" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"message":{"raw":"MESSAGE"}}'
מחליפים את מה שכתוב בשדות הבאים:
- ACCESS_TOKEN: טוקן הגישה שמאפשר גישה ל-API.
- MESSAGE: הודעת MIME בפורמט RFC 2822, בקידוד base64URL.
עדכון טיוטה אחת
בדומה ליצירת טיוטה, כדי לעדכן טיוטה צריך לספק משאב drafts בגוף הבקשה, כשהשדה messages.raw מוגדר למחרוזת בקידוד base64URL שמכילה את הודעת ה-MIME. מכיוון שאי אפשר לעדכן הודעות, ההודעה שנכללת בטיוטה נמחקת ומוחלפת בהודעת ה-MIME החדשה שסופקה בבקשת העדכון.
כדי לאחזר את הודעת ה-MIME הנוכחית שנמצאת בטיוטה, צריך להפעיל את השיטה drafts.get עם פרמטר השאילתה format=raw.
מידע נוסף זמין בשיטה drafts.update.
שליחת טיוטות
כששולחים טיוטה, אפשר לשלוח אותה כמו שהיא או לספק עדכונים בבקשת השליחה.
כדי לעדכן את הטיוטה כששולחים אותה, צריך לספק משאב drafts בגוף הבקשה של שיטת drafts.send. במשאב drafts, צריך לציין את הטיוטה id של הטיוטה שרוצים לשלוח ולהגדיר את השדה messages.raw להודעת ה-MIME החדשה בקידוד כמחרוזת base64URL.
מידע על שליחת הודעות ב-Gmail מופיע במאמר שליחת הודעות.