טיוטה של הודעה שנוצרה על ידי משתמש בחשבון Gmail של משתמש.
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
deleteDraft() | void | טיוטת ההודעה תימחק. |
getId() | String | קבלת המזהה של טיוטת ההודעה. |
getMessage() | GmailMessage | מחזירה הודעת GmailMessage שמייצגת את הטיוטה הזו. |
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()
מחזירה הודעת GmailMessage שמייצגת את הטיוטה הזו.
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("mike@example.com", "current time", "The time is: " + now.toString());
פרמטרים
שם | סוג | תיאור |
---|---|---|
recipient | String | רשימה של כתובות אימייל מופרדות בפסיקים |
subject | String | נושא האימייל (250 תווים לכל היותר) |
body | String | גוף האימייל |
חזרה
GmailDraft
– הטיוטה המעודכנת החדשה
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:
-
https://mail.google.com/
ראה גם
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('mike@example.com', '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/