דף זה תורגם על ידי Cloud Translation API.

Class GmailMessage

הודעה בחשבון Gmail של משתמש.

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
`createDraftReply(body)`	`GmailDraft`	יצירת טיוטה של הודעה שתישלח לשולח ההודעה הזו באמצעות כתובת התשובה.
`createDraftReply(body, options)`	`GmailDraft`	יצירת טיוטה של הודעה שתישלח בתשובה לשולח ההודעה הזו באמצעות כתובת התשובה, עם ארגומנטים אופציונליים.
`createDraftReplyAll(body)`	`GmailDraft`	יצירת טיוטה של הודעה שתישלח כתגובה לשולח באמצעות כתובת התשובה וכל הנמענים של ההודעה הזו.
`createDraftReplyAll(body, options)`	`GmailDraft`	יצירת טיוטה של תשובה לשולח ההודעה הזו באמצעות כתובת התשובה וכל הנמענים, עם ארגומנטים אופציונליים.
`forward(recipient)`	`GmailMessage`	העברת ההודעה הזו לנמענים חדשים.
`forward(recipient, options)`	`GmailMessage`	העברה של ההודעה הזו לנמענים חדשים, עם ארגומנטים אופציונליים.
`getAttachments()`	`GmailAttachment[]`	הפונקציה מקבלת את כל הקבצים המצורפים להודעה הזו.
`getAttachments(options)`	`GmailAttachment[]`	הפונקציה מקבלת את כל הקבצים המצורפים להודעה הזו.
`getBcc()`	`String`	הפונקציה מקבלת את הנמענים שמפורטים בפסיקים, שמוגדרים כעותק מוסתר בהודעה הזו.
`getBody()`	`String`	הפונקציה מקבלת את תוכן ה-HTML של גוף ההודעה.
`getCc()`	`String`	הפונקציה מקבלת את הנמענים שנוספו בשדה 'עותק' של ההודעה הזו, מופרדים בפסיקים.
`getDate()`	`Date`	הפונקציה מקבלת את התאריך והשעה של ההודעה הזו.
`getFrom()`	`String`	הפונקציה מקבלת את השולח של ההודעה.
`getHeader(name)`	`String`	הפונקציה מקבלת את השם של כותרת RFC 2822 ומציגה את הערך שלה.
`getId()`	`String`	הפונקציה מקבלת את המזהה של ההודעה הזו.
`getPlainBody()`	`String`	הפונקציה מקבלת את תוכן גוף ההודעה הזו ללא עיצוב HTML.
`getRawContent()`	`String`	הפונקציה מקבלת את התוכן הגולמי של ההודעה.
`getReplyTo()`	`String`	הפונקציה מקבלת את כתובת התשובה של ההודעה הזו (בדרך כלל זו כתובת השולח).
`getSubject()`	`String`	הפונקציה מקבלת את נושא ההודעה.
`getThread()`	`GmailThread`	הפונקציה מקבלת את השרשור שמכיל את ההודעה הזו.
`getTo()`	`String`	הפונקציה מקבלת את הנמענים של ההודעה הזו, שמופרדים בפסיקים.
`isDraft()`	`Boolean`	הפונקציה מקבלת את הערך 'כן' אם ההודעה היא טיוטה.
`isInChats()`	`Boolean`	הפונקציה מקבלת את ההודעה ומציינת אם היא צ'אט.
`isInInbox()`	`Boolean`	הפונקציה מקבלת את הערך 'true' אם ההודעה הזו נמצאת בתיבת הדואר הנכנס.
`isInPriorityInbox()`	`Boolean`	הפונקציה מחזירה את הערך `true` אם ההודעה הזו נמצאת בתיבת הדואר הנכנס בעדיפות גבוהה, ואת הערך `false` במקרים אחרים.
`isInTrash()`	`Boolean`	הפונקציה מקבלת את הערך 'true' אם ההודעה נמצאת באשפה.
`isStarred()`	`Boolean`	הפונקציה מקבלת את הערך שמציין אם ההודעה מסומנת בכוכב.
`isUnread()`	`Boolean`	הפונקציה מקבלת את הסטטוס של ההודעה – אם היא נקראת או לא.
`markRead()`	`GmailMessage`	סימון ההודעה כהודעה ש'כבר קראתי'.
`markUnread()`	`GmailMessage`	סימון ההודעה כהודעה שלא נקראה.
`moveToTrash()`	`GmailMessage`	ההודעה מועברת לאשפה.
`refresh()`	`GmailMessage`	טעינת מחדש של ההודעה הזו והמצב המשויך מ-Gmail (שימושי במקרה שהתוויות, מצב הקריאה וכו' השתנו).
`reply(body)`	`GmailMessage`	משיבים לשולח ההודעה הזו באמצעות כתובת התשובה.
`reply(body, options)`	`GmailMessage`	שליחת תשובה לשולח ההודעה הזו באמצעות כתובת התשובה, עם ארגומנטים אופציונליים.
`replyAll(body)`	`GmailMessage`	התשובות יישלחו לשולח באמצעות כתובת האימייל ל'תשובה אל' ולכל הנמענים של ההודעה הזו.
`replyAll(body, options)`	`GmailMessage`	שליחת תשובה לשולח ההודעה הזו באמצעות כתובת התשובה לכל הנמענים, עם ארגומנטים אופציונליים.
`star()`	`GmailMessage`	סימון ההודעה בכוכב.
`unstar()`	`GmailMessage`	הסרת הכוכב מההודעה.

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

`createDraftReply(body)`

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

// Create a draft reply to the original message with an acknowledgment.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReply('Got your message');

פרמטרים

שם	סוג	תיאור
`body`	`String`	תוכן האימייל.

חזרה

GmailDraft — טיוטת ההודעה החדשה שנוצרה.

אישור

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

https://mail.google.com/

`createDraftReply(body, options)`

יצירת טיוטה של הודעה שתישלח בתשובה לשולח ההודעה הזו באמצעות כתובת התשובה, עם ארגומנטים אופציונליים.

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

// Create a draft response with an HTML text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReply('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: 'another@example.com',
});

פרמטרים

שם	סוג	תיאור
`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`	כתובת אימייל שישמש ככתובת ברירת המחדל לתשובות (ברירת המחדל: כתובת האימייל של המשתמש)
`subject`	`String`	שורת נושא חדשה לאימייל, עד 250 תווים.

חזרה

GmailDraft — טיוטת ההודעה החדשה שנוצרה.

אישור

https://mail.google.com/

ראה גם

reply(body, options)
createDraftReply(body)
createDraftReplyAll(body)
createDraftReplyAll(body, options)

`createDraftReplyAll(body)`

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

// Create a draft response to all recipients (except those bcc'd) with an
// acknowledgment.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReplyAll('Got your message');

פרמטרים

שם	סוג	תיאור
`body`	`String`	תוכן האימייל.

חזרה

GmailDraft — טיוטת ההודעה החדשה שנוצרה.

אישור

https://mail.google.com/

ראה גם

replyAll(body)
createDraftReply(body)
createDraftReply(body, options)
createDraftReplyAll(body, options)

`createDraftReplyAll(body, options)`

יצירת טיוטה של תשובה לשולח ההודעה הזו באמצעות כתובת התשובה וכל הנמענים, עם ארגומנטים אופציונליים.

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

// Create a draft response to all recipients (except those bcc'd) using an HTML
// text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReplyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: 'another@example.com',
});

פרמטרים

שם	סוג	תיאור
`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`	כתובת אימייל שישמש ככתובת ברירת המחדל לתשובות (ברירת המחדל: כתובת האימייל של המשתמש)
`subject`	`String`	שורת נושא חדשה לאימייל, עד 250 תווים.

חזרה

GmailDraft — טיוטת ההודעה החדשה שנוצרה.

אישור

https://mail.google.com/

ראה גם

replyAll(body, options)
createDraftReply(body)
createDraftReply(body, options)
createDraftReplyAll(body)

`forward(recipient)`

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

// Forward first message of first inbox thread to recipient1 & recipient2,
// both @example.com
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.forward('recipient1@example.com,recipient2@example.com');

פרמטרים

שם	סוג	תיאור
`recipient`	`String`	רשימה של כתובות אימייל מופרדות בפסיקים.

חזרה

GmailMessage — ההודעה הזו שימושית לשרשור.

אישור

https://mail.google.com/

ראה גם

forward(recipient, options)

`forward(recipient, options)`

העברה של ההודעה הזו לנמענים חדשים, עם ארגומנטים אופציונליים.

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

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.forward('recipient1@example.com,recipient2@example.com', {
  cc: 'myboss@example.com',
  bcc: 'mybosses-boss@example.com,vp@example.com',
});

פרמטרים

שם	סוג	תיאור
`recipient`	`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`	השם של השולח של האימייל (ברירת המחדל: שם המשתמש)
`noReply`	`Boolean`	`true` אם האימייל צריך להישלח מכתובת אימייל גנרית ללא מענה כדי למנוע מהנמענים להשיב לאימיילים. האפשרות הזו זמינה רק לחשבונות Google Workspace, ולא למשתמשי Gmail.
`replyTo`	`String`	כתובת אימייל שישמש ככתובת ברירת המחדל לתשובות (ברירת המחדל: כתובת האימייל של המשתמש)
`subject`	`String`	שורת נושא חדשה לאימייל, עד 250 תווים.

חזרה

GmailMessage — ההודעה הזו שימושית לשרשור.

אישור

https://mail.google.com/

ראה גם

forward(recipient)

`getAttachments()`

הפונקציה מקבלת את כל הקבצים המצורפים להודעה הזו.

חזרה

GmailAttachment[] – מערך של קבצים מצורפים מסוג Blob להודעה הזו.

אישור

https://mail.google.com/

`getAttachments(options)`

הפונקציה מקבלת את כל הקבצים המצורפים להודעה הזו.

פרמטרים

שם	סוג	תיאור
`options`	`Object`	אובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורטים בהמשך.

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

שם	סוג	תיאור
`includeInlineImages`	`Boolean`	`true` אם המערך המוחזר של קבצים מצורפים מסוג Blob צריך לכלול תמונות בתוך שורות (ברירת המחדל היא `true`).
`includeAttachments`	`Boolean`	`true` אם המערך המוחזר של קבצים מצורפים מסוג Blob צריך לכלול קבצים מצורפים רגילים (לא בתוך שורת הטקסט) (ברירת המחדל היא `true`).

חזרה

GmailAttachment[] – מערך של קבצים מצורפים מסוג Blob להודעה הזו.

אישור

https://mail.google.com/

`getBcc()`

הפונקציה מקבלת את הנמענים שמפורטים בפסיקים, שמוגדרים כעותק מוסתר בהודעה הזו.

מעצם הגדרתה, השדה הזה ריק בכל ההודעות שהתקבלו.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getBcc());                      // Log bcc'd addresses

חזרה

String – הנמענים שמפורטים באמצעות פסיק, שנוספו להודעה הזו בשדה 'עותק מוסתר'.

אישור

https://mail.google.com/

ראה גם

getTo()

`getBody()`

הפונקציה מקבלת את תוכן ה-HTML של גוף ההודעה.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getBody());                     // Log contents of the body

חזרה

String — תוכן גוף ההודעה.

אישור

https://mail.google.com/

ראה גם

getSubject()

`getCc()`

הפונקציה מקבלת את הנמענים שנוספו בשדה 'עותק' של ההודעה הזו, מופרדים בפסיקים.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getCc());                       // Log cc'd addresses

חזרה

String – הנמענים שמפורטים עם פסיק בשדה 'עותק' של ההודעה הזו.

אישור

https://mail.google.com/

ראה גם

getTo()

`getDate()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getDate());  // Log date and time of the message

חזרה

Date – התאריך והשעה של ההודעה הזו.

אישור

https://mail.google.com/

`getFrom()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getFrom());  // Log from address of the message

חזרה

String – כתובת האימייל של שולח ההודעה.

אישור

https://mail.google.com/

ראה גם

getReplyTo()

`getHeader(name)`

הפונקציה מקבלת את השם של כותרת RFC 2822 ומציגה את הערך שלה.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox.
const message = thread.getMessages()[0];           // Get the first message.
Logger.log(
    message.getHeader('Message-ID'));  // Logs the Message-ID RFC 2822 header.

פרמטרים

שם	סוג	תיאור
`name`	`String`	השם של כותרת ה-RFC, ללא הנקודתיים שמפרידות בינה לבין הערך.

חזרה

String — הערך של הכותרת, או מחרוזת ריקה אם הכותרת לא קיימת בהודעה.

אישור

https://mail.google.com/

`getId()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
const id = message.getId();
const messageById = GmailApp.getMessageById(id);
Logger.log(
    message.getSubject() === messageById.getMessage());  // Always logs true

חזרה

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

`getPlainBody()`

הפונקציה מקבלת את תוכן גוף ההודעה הזו ללא עיצוב HTML. התהליך הזה מורכב יותר מ-getBody() ונמשך זמן רב יותר.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getPlainBody());                // Log contents of the body

חזרה

String — תוכן הגוף הרגיל של ההודעה הזו.

אישור

https://mail.google.com/

ראה גם

getSubject()

`getRawContent()`

הפונקציה מקבלת את התוכן הגולמי של ההודעה. האפשרות הזו זהה לאפשרות 'הצגת המקור' בממשק המשתמש של Gmail.

חזרה

String — התוכן הגולמי של ההודעה הזו.

אישור

https://mail.google.com/

`getReplyTo()`

הפונקציה מקבלת את כתובת התשובה של ההודעה הזו (בדרך כלל זו כתובת השולח).

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getReplyTo());                  // Logs reply-to address

חזרה

String — כתובת האימייל לשליחת תשובות.

אישור

https://mail.google.com/

ראה גם

getCc()

`getSubject()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getSubject());                  // Log subject line

חזרה

String – הנושא של ההודעה הזו.

אישור

https://mail.google.com/

ראה גם

getAttachments()

`getThread()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(
    message.getThread().getFirstMessageSubject() ===
        thread.getFirstMessageSubject(),
);  // Always logs true

חזרה

GmailThread — השרשור ב-Gmail שמכיל את ההודעה הזו.

אישור

https://mail.google.com/

`getTo()`

הפונקציה מקבלת את הנמענים של ההודעה הזו, שמופרדים בפסיקים.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getTo());  // Log the recipient of message

חזרה

String – הנמענים של ההודעה הזו, מופרדים בפסיקים.

אישור

https://mail.google.com/

ראה גם

getCc()

`isDraft()`

הפונקציה מקבלת את הערך 'כן' אם ההודעה היא טיוטה.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is draft? ${message.isDraft()}`);

חזרה

Boolean — אם ההודעה הזו היא טיוטה.

אישור

https://mail.google.com/

`isInChats()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is a chat? ${message.isInChats()}`);

חזרה

Boolean — האם ההודעה הזו היא צ'אט.

`isInInbox()`

הפונקציה מקבלת את הערך 'true' אם ההודעה הזו נמצאת בתיבת הדואר הנכנס.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in inbox? ${message.isInInbox()}`);

חזרה

Boolean — האם ההודעה הזו נמצאת בתיבת הדואר הנכנס.

אישור

https://mail.google.com/

`isInPriorityInbox()`

הפונקציה מחזירה את הערך true אם ההודעה הזו נמצאת בתיבת הדואר הנכנס בעדיפות גבוהה, ואת הערך false במקרים אחרים.

const thread = GmailApp.getPriorityInboxThreads(
    0, 1)[0];  // Get first thread in priority inbox
const messages = thread.getMessages();
for (let i = 0; i < messages.length; i++) {
  // At least one of the messages is in priority inbox
  Logger.log(`is in priority inbox? ${messages[i].isInPriorityInbox()}`);
}

חזרה

Boolean — אם ההודעה הזו נמצאת בתיבת הדואר הנכנס ברשימת העדיפויות.

אישור

https://mail.google.com/

`isInTrash()`

הפונקציה מקבלת את הערך 'true' אם ההודעה נמצאת באשפה.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in the trash? ${message.isInTrash()}`);

חזרה

Boolean — אם ההודעה הזו נמצאת באשפה.

`isStarred()`

הפונקציה מקבלת את הערך שמציין אם ההודעה מסומנת בכוכב.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is starred? ${message.isStarred()}`);

חזרה

Boolean — אם ההודעה הזו מסומנת בכוכב.

`isUnread()`

הפונקציה מקבלת את הסטטוס של ההודעה – אם היא נקראת או לא.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is unread? ${message.isUnread()}`);

חזרה

Boolean – הסטטוס של ההודעה הזו (לא נקראה).

אישור

https://mail.google.com/

`markRead()`

סימון ההודעה כהודעה ש'כבר קראתי'.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.markRead();                                // Mark as read

חזרה

GmailMessage – GmailMessage, שימושי לשרשור.

אישור

https://mail.google.com/

ראה גם

isUnread()

`markUnread()`

סימון ההודעה כהודעה שלא נקראה.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.markUnread();                              // Mark as unread

חזרה

GmailMessage – GmailMessage, שימושי לשרשור.

אישור

https://mail.google.com/

ראה גם

isUnread()

`moveToTrash()`

ההודעה מועברת לאשפה.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.moveToTrash();                             // Move message to trash

חזרה

GmailMessage – GmailMessage, שימושי לשרשור.

אישור

https://mail.google.com/

ראה גם

isInTrash()

`refresh()`

טעינת מחדש של ההודעה הזו והמצב המשויך מ-Gmail (שימושי במקרה שהתוויות, מצב הקריאה וכו' השתנו).

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
// .. Do bunch of stuff here
message.refresh();  // Make sure it's up to date
// Do more stuff to message

חזרה

GmailMessage — ההודעה הזו לשרשור.

אישור

https://mail.google.com/

`reply(body)`

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

// Respond to author of message with acknowledgment
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.reply('Got your message');

פרמטרים

שם	סוג	תיאור
`body`	`String`	תוכן האימייל.

חזרה

GmailMessage — ההודעה הזו שימושית לשרשור.

אישור

https://mail.google.com/

ראה גם

reply(body, options)
replyAll(body)
replyAll(body, options)

`reply(body, options)`

שליחת תשובה לשולח ההודעה הזו באמצעות כתובת התשובה, עם ארגומנטים אופציונליים.

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

// Respond with HTML body text
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.reply('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  noReply: true,
});

פרמטרים

שם	סוג	תיאור
`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`	השם של השולח של האימייל (ברירת המחדל: שם המשתמש)
`noReply`	`Boolean`	`true` אם האימייל צריך להישלח מכתובת אימייל גנרית ללא מענה כדי למנוע מהנמענים להשיב לאימיילים. האפשרות הזו זמינה רק לחשבונות Google Workspace, ולא למשתמשי Gmail.
`replyTo`	`String`	כתובת אימייל שישמש ככתובת ברירת המחדל לתשובות (ברירת המחדל: כתובת האימייל של המשתמש)
`subject`	`String`	שורת נושא חדשה לאימייל, עד 250 תווים.

חזרה

GmailMessage — ההודעה הזו שימושית לשרשור.

אישור

https://mail.google.com/

ראה גם

reply(body)
replyAll(body)
replyAll(body, options)

`replyAll(body)`

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

// Respond to all recipients (except bcc'd) of last email in thread with
// acknowledgment
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.replyAll('Got your message');

פרמטרים

שם	סוג	תיאור
`body`	`String`	תוכן האימייל.

חזרה

GmailMessage — ההודעה הזו שימושית לשרשור.

אישור

https://mail.google.com/

ראה גם

reply(body)
reply(body, options)
replyAll(body, options)

`replyAll(body, options)`

שליחת תשובה לשולח ההודעה הזו באמצעות כתובת התשובה לכל הנמענים, עם ארגומנטים אופציונליים.

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

// Respond with HTML body text
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.replyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  noReply: true,
});

פרמטרים

שם	סוג	תיאור
`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`	השם של השולח של האימייל (ברירת המחדל: שם המשתמש)
`noReply`	`Boolean`	`true` אם האימייל צריך להישלח מכתובת אימייל גנרית ללא מענה כדי למנוע מהנמענים להשיב לאימיילים. האפשרות הזו זמינה רק לחשבונות Google Workspace, ולא למשתמשי Gmail.
`replyTo`	`String`	כתובת אימייל שישמש ככתובת ברירת המחדל לתשובות (ברירת המחדל: כתובת האימייל של המשתמש)
`subject`	`String`	שורת נושא חדשה לאימייל, עד 250 תווים.

חזרה

GmailMessage — ההודעה הזו שימושית לשרשור.

אישור

https://mail.google.com/

ראה גם

reply(body)
reply(body, options)
replyAll(body)

`star()`

סימון ההודעה בכוכב.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.star();                                    // Star the message

חזרה

GmailMessage – GmailMessage, שימושי לשרשור.

אישור

https://mail.google.com/

ראה גם

unstar()

`unstar()`

הסרת הכוכב מההודעה.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.unstar();                                  // Unstar the message

חזרה

GmailMessage – GmailMessage, שימושי לשרשור.

אישור

https://mail.google.com/

ראה גם

star()