Class GmailDraft

GmailDraft

טיוטה של הודעה שנוצרה על ידי משתמש בחשבון 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.

אישור

סקריפטים שמשתמשים ב-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()}`,
);

פרמטרים

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

חזרה

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

פרמטרים

שםסוגתיאור
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 – הטיוטה שעודכנה לאחרונה

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

  • https://mail.google.com/

ראה גם