Class GmailDraft

Gmailטיוטה

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

Methods

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

מסמכים מפורטים

deleteDraft()

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

const 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()

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

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 – מזהה הטיוטה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מההיקפי הגישה הבאים, או עם היקפי גישה מתאימים מה-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 – ההודעה שמייצגת את תוכן הטיוטה הזו

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מההיקפי הגישה הבאים, או עם היקפי גישה מתאימים מה-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 – מזהה ההודעה

אישור

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

  • https://mail.google.com/

send()

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

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 – ההודעה שנשלחה לאחרונה

אישור

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

  • https://mail.google.com/

update(recipient, subject, body)

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

// 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()}`,
);

פרמטרים

שםסוגתיאור
recipientStringרשימה של כתובות אימייל מופרדות בפסיקים
subjectStringנושא האימייל (עד 250 תווים)
bodyStringגוף האימייל

חזרה

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.
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',
    },
);

פרמטרים

שםסוגתיאור
recipientStringרשימה של כתובות אימייל מופרדות בפסיקים
subjectStringנושא האימייל (עד 250 תווים)
bodyStringגוף האימייל
optionsObjectאובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורטים בהמשך

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

שםסוגתיאור
attachmentsBlobSource[]מערך של קבצים שרוצים לשלוח באימייל
bccStringרשימה של כתובות אימייל שמופרדות בפסיקים, לצורך שליחת עותק מוסתר
ccStringרשימה מופרדת בפסיקים של כתובות אימייל לשליחת עותק
fromStringהכתובת שממנה צריך לשלוח את האימייל, והיא חייבת להיות אחד מהערכים שמוחזרים על ידי GmailApp.getAliases()
htmlBodyStringאם השדה מוגדר, מכשירים שיכולים להציג HTML ישתמשו בו במקום בארגומנט הנדרש body. אפשר להוסיף שדה inlineImages אופציונלי בגוף ה-HTML אם יש תמונות מוטמעות באימייל.
inlineImagesObjectאובייקט JavaScript שמכיל מיפוי ממפתח תמונה (String) לנתוני תמונה (BlobSource). ההנחה היא שמשתמשים בפרמטר htmlBody והוא מכיל הפניות לתמונות האלה בפורמט <img src="cid:imageKey" />
nameStringהשם של השולח של האימייל (ברירת המחדל: שם המשתמש)
replyToStringכתובת אימייל שישמש ככתובת ברירת המחדל לתשובות (ברירת המחדל: כתובת האימייל של המשתמש)

חזרה

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

אישור

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

  • https://mail.google.com/

ראה גם