טיוטה של הודעה שנוצרה על ידי משתמש בחשבון Gmail שלו.
Methods
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
delete | void | מחיקת הטיוטה הזו של ההודעה. |
get | String | מחזירה את המזהה של טיוטת ההודעה. |
get | Gmail | מחזירה GmailMessage שמייצג את הטיוטה הזו. |
get | String | מחזירה את המזהה של Gmail שמייצג את הטיוטה הזו. |
send() | Gmail | שליחת טיוטת האימייל. |
update(recipient, subject, body) | Gmail | התוכן של הטיוטה הזו יוחלף. |
update(recipient, subject, body, options) | Gmail | התוכן של טיוטת ההודעה הזו מוחלף באמצעות ארגומנטים אופציונליים. |
תיעוד מפורט
deleteDraft()
מחיקת הטיוטה הזו של ההודעה.
const draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder draft.deleteDraft(); draft.getMessage(); // Throws exception.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
getId()
מחזירה את המזהה של טיוטת ההודעה.
const draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder const draftId = draft.getId(); const draftById = GmailApp.getDraft(draftId); Logger.log( draft.getMessage().getSubject() === draftById.getMessage().getSubject(), );
חזרה
String – מזהה הטיוטה
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
getMessage()
מחזירה GmailMessage שמייצג את הטיוטה הזו.
const draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder const message = draft.getMessage(); Logger.log(message.getSubject());
חזרה
GmailMessage – ההודעה שמייצגת את התוכן של הטיוטה הזו
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
getMessageId()
מחזירה את המזהה של GmailMessage שמייצג את הטיוטה הזו.
const draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder const messageId = draft.getMessageId(); Logger.log(messageId === draft.getMessage().getId());
חזרה
String — מזהה ההודעה
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
send()
שליחת טיוטת האימייל. הגודל של האימייל (כולל הכותרות) הוא quota limited.
const draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder const msg = draft.send(); // Send it Logger.log(msg.getDate()); // Should be approximately the current timestamp
חזרה
GmailMessage – ההודעה שנשלחה זה עתה
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
update(recipient, subject, body)
התוכן של הטיוטה הזו יוחלף. הגודל של האימייל (כולל הכותרות) הוא quota limited.
// The code below will update a draft email with the current date and time. const draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder const now = new Date(); draft.update( 'mike@example.com', 'current time', `The time is: ${now.toString()}`, );
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
recipient | String | רשימה של כתובות אימייל שמופרדות בפסיקים |
subject | String | נושא האימייל (עד 250 תווים) |
body | String | תוכן האימייל |
חזרה
GmailDraft – הטיוטה שעודכנה לאחרונה
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
update(recipient, subject, body, options)
התוכן של טיוטת ההודעה הזו מוחלף באמצעות ארגומנטים אופציונליים. האימייל יכול להכיל טקסט רגיל או תוכן HTML. הגודל של האימייל (כולל הכותרות) הוא quota limited.
// Update a draft email with a file from Google Drive attached as a PDF. const draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder const 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 | Blob | מערך של קבצים לשליחה עם האימייל |
bcc | String | רשימה של כתובות אימייל שמופרדות בפסיקים, להוספה לעותק מוסתר |
cc | String | רשימה של כתובות אימייל שמופרדות בפסיקים לשליחת עותק |
from | String | הכתובת שממנה צריך לשלוח את האימייל, שחייבת להיות אחת מהכתובות שמוחזרות על ידי Gmail |
html | String | אם מוגדר, מכשירים שיכולים להציג HTML ישתמשו בו במקום בארגומנט body הנדרש. אפשר להוסיף שדה inline אופציונלי בגוף ה-HTML אם יש לכם תמונות מוטמעות באימייל |
inline | Object | אובייקט JavaScript שמכיל מיפוי ממפתח התמונה
(String) לנתוני התמונה (Blob). ההנחה היא שהפרמטר html נמצא בשימוש ומכיל הפניות לתמונות האלה בפורמט <img src="cid:imageKey" /> |
name | String | השם של שולח האימייל (ברירת מחדל: השם של המשתמש) |
reply | String | כתובת אימייל שתשמש ככתובת ברירת המחדל לתשובה (ברירת מחדל: כתובת האימייל של המשתמש) |
חזרה
GmailDraft – הטיוטה שעודכנה לאחרונה
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/