Class GmailDraft

GmailDraft

טיוטת הודעה שנוצרה על ידי משתמש בחשבון Gmail של משתמש.

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
deleteDraft()	void	מחיקת הטיוטה של ההודעה.
getId()	String	הפונקציה מקבלת את המזהה של טיוטת ההודעה.
getMessage()	GmailMessage	מחזירה הודעה Gmail שמייצגת את הטיוטה.
getMessageId()	String	מחזירה את המזהה של GmailMessage שמייצג את הטיוטה.
send()	GmailMessage	שולח טיוטת אימייל זו.
update(recipient, subject, body)	GmailDraft	מחליף את התוכן של טיוטת ההודעה.
update(recipient, subject, body, options)	GmailDraft	מחליף את תוכן הטיוטה של ההודעה באמצעות ארגומנטים אופציונליים.

תיעוד מפורט

deleteDraft()

מחיקת הטיוטה של ההודעה.

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
draft.deleteDraft();
draft.getMessage(); // Throws exception.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה עם אחד או יותר מההיקפים הבאים או עם ההיקפים המתאימים מ-API ל-REST הקשור:

• https://mail.google.com/

---

getId()

הפונקציה מקבלת את המזהה של טיוטת ההודעה.

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var draftId = draft.getId();
var draftById = GmailApp.getDraft(draftId);
Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());

החזרות

String – מזהה הטיוטה

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה עם אחד או יותר מההיקפים הבאים או עם ההיקפים המתאימים מ-API ל-REST הקשור:

• https://mail.google.com/

---

getMessage()

מחזירה הודעה Gmail שמייצגת את הטיוטה.

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var message = draft.getMessage();
Logger.log(message.getSubject());

החזרות

GmailMessage – ההודעה שמייצגת את תוכן הטיוטה הזו

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה עם אחד או יותר מההיקפים הבאים או עם ההיקפים המתאימים מ-API ל-REST הקשור:

• https://mail.google.com/

---

getMessageId()

מחזירה את המזהה של GmailMessage שמייצג את הטיוטה.

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var messageId = draft.getMessageId();
Logger.log(messageId == draft.getMessage().getId());

החזרות

String – מזהה ההודעה

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה עם אחד או יותר מההיקפים הבאים או עם ההיקפים המתאימים מ-API ל-REST הקשור:

• https://mail.google.com/

---

send()

שולח טיוטת אימייל זו. גודל הודעת האימייל (כולל הכותרות) מוגבל במכסה.

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var msg = draft.send(); // Send it
Logger.log(msg.getDate()); // Should be approximately the current timestamp

החזרות

GmailMessage – ההודעה החדשה שנשלחה

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה עם אחד או יותר מההיקפים הבאים או עם ההיקפים המתאימים מ-API ל-REST הקשור:

• https://mail.google.com/

---

update(recipient, subject, body)

מחליף את התוכן של טיוטת ההודעה. גודל הודעת האימייל (כולל הכותרות) מוגבל במכסה.

// The code below will update a draft email with the current date and time.
var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var now = new Date();
draft.update("[e-mail]", "current time", "The time is: " + now.toString());

פרמטרים

שם	תיאור	התיאור
recipient	String	רשימת כתובות אימייל מופרדות בפסיקים
subject	String	נושא האימייל (250 תווים לכל היותר)
body	String	גוף האימייל

החזרות

GmailDraft – הטיוטה המעודכנת

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה עם אחד או יותר מההיקפים הבאים או עם ההיקפים המתאימים מ-API ל-REST הקשור:

• https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

• GmailApp.createDraft(recipient, subject, body)

---

update(recipient, subject, body, options)

מחליף את תוכן הטיוטה של ההודעה באמצעות ארגומנטים אופציונליים. הודעת האימייל יכולה להכיל טקסט פשוט או גוף HTML. גודל הודעת האימייל (כולל הכותרות) מוגבל במכסה.

// Update a draft email with a file from Google Drive attached as a PDF.
var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
draft.update('[e-mail]', 'Attachment example', 'Please see attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

פרמטרים

שם	תיאור	התיאור
recipient	String	רשימת כתובות אימייל מופרדות בפסיקים
subject	String	נושא האימייל (250 תווים לכל היותר)
body	String	גוף האימייל
options	Object	אובייקט JavaScript המציין פרמטרים מתקדמים, כפי שמתואר בהמשך

פרמטרים מתקדמים

שם	תיאור	התיאור
attachments	BlobSource[]	מערך של קבצים לשליחה עם כתובת האימייל
bcc	String	רשימה מופרדת בפסיקים של כתובות אימייל בשדה 'עותק מוסתר'
cc	String	רשימה של כתובות אימייל שמופרדות באמצעות פסיקים,
from	String	הכתובת שממנה יש לשלוח את האימייל, והיא צריכה להיות אחד מהערכים שמוחזרים על ידי GmailApp.getAliases()
htmlBody	String	אם המדיניות מוגדרת, מכשירים שמסוגלים לעבד HTML ישתמשו בו במקום בארגומנט הנדרש; אפשר להוסיף שדה inlineImages אופציונלי בגוף ה-HTML אם יש הודעות אימייל בתוך שורות
inlineImages	Object	אובייקט JavaScript שמכיל מיפוי ממפתח תמונה (String) לנתוני תמונה (BlobSource); ההנחה היא שהפרמטר htmlBody נמצא בשימוש ומכיל הפניות לתמונות האלה בפורמט <img src="cid:imageKey" />
name	String	שם השולח של האימייל (ברירת המחדל: שם המשתמש)
replyTo	String	כתובת אימייל שתשמש ככתובת ברירת המחדל לתשובה (ברירת המחדל: כתובת האימייל של המשתמש)

החזרות

GmailDraft – הטיוטה המעודכנת

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה עם אחד או יותר מההיקפים הבאים או עם ההיקפים המתאימים מ-API ל-REST הקשור:

• https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

• GmailApp.createDraft(recipient, subject, body, options)