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

Class GmailMessage

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

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`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`	מציין אם ההודעה נמצאת בתיבת הדואר הנכנס.
`isInPriorityInbox()`	`Boolean`	הפונקציה מחזירה את הערך `true` אם ההודעה הזו נמצאת בתיבת הדואר הנכנס בעדיפות גבוהה. אחרת, היא מחזירה את הערך `false`.
`isInTrash()`	`Boolean`	הפונקציה בודקת אם ההודעה נמצאת באשפה.
`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.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var 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.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var 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 – טיוטת ההודעה שנוצרה לאחרונה.

הרשאות

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

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.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReplyAll("Got your message");

פרמטרים

שם	תיאור	התיאור
`body`	`String`	גוף האימייל.

החזרות

GmailDraft – טיוטת ההודעה שנוצרה לאחרונה.

הרשאות

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

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.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var 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 – טיוטת ההודעה שנוצרה לאחרונה.

הרשאות

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

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
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("recipient1@example.com,recipient2@example.com");

פרמטרים

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

החזרות

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

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

forward(recipient, options)

`forward(recipient, options)`

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

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

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var 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 – ההודעה הזו שימושית לשרשור.

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

forward(recipient)

`getAttachments()`

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

החזרות

GmailAttachment[] - מערך של קבצים מצורפים ב-blob עבור ההודעה הזו.

הרשאות

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

https://mail.google.com/

`getAttachments(options)`

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

פרמטרים

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

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

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

החזרות

GmailAttachment[] - מערך של קבצים מצורפים ב-blob עבור ההודעה הזו.

הרשאות

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

https://mail.google.com/

`getBcc()`

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

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

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

החזרות

String - הנמענים שמופרדים בפסיקים מופיעים כעותק מוסתר בהודעה הזו.

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

getTo()

`getBody()`

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

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

החזרות

String - התוכן של ההודעה.

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

getSubject()

`getCc()`

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

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

החזרות

String - הנמענים המופרדים בפסיקים נכללים בעותק להודעה הזו.

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

getTo()

`getDate()`

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

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

החזרות

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

הרשאות

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

https://mail.google.com/

`getFrom()`

מידע על השולח של ההודעה הזו.

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

החזרות

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

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

getReplyTo()

`getHeader(name)`

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox.
var 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 - הערך של הכותרת או מחרוזת ריקה אם הכותרת לא קיימת בהודעה.

הרשאות

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

https://mail.google.com/

`getId()`

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

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

החזרות

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

`getPlainBody()`

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

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

החזרות

String - התוכן הפשוט של ההודעה הזו.

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

getSubject()

`getRawContent()`

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

החזרות

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

הרשאות

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

https://mail.google.com/

`getReplyTo()`

קבלת הכתובת לתשובה של ההודעה הזו (בדרך כלל השולח).

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

החזרות

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

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

getCc()

`getSubject()`

מוצא את הנושא של ההודעה הזו.

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

החזרות

String - נושא ההודעה.

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

getAttachments()

`getThread()`

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

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

החזרות

GmailThread - ה-GmailThread שמכיל את ההודעה הזו.

הרשאות

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

https://mail.google.com/

`getTo()`

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

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

החזרות

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

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

getCc()

`isDraft()`

מציין אם ההודעה הזו היא טיוטה.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is draft? " + message.isDraft());

החזרות

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

הרשאות

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

https://mail.google.com/

`isInChats()`

אפשר לדעת אם ההודעה הזו היא צ'אט.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is a chat? " + message.isInChats());

החזרות

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

`isInInbox()`

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in inbox? " + message.isInInbox());

החזרות

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

הרשאות

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

https://mail.google.com/

`isInPriorityInbox()`

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

var thread = GmailApp.getPriorityInboxThreads(0,1)[0]; // Get first thread in priority inbox
var messages = thread.getMessages();
for (var 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 – אם ההודעה הזו נמצאת בתיבת הדואר הנכנס.

הרשאות

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

https://mail.google.com/

`isInTrash()`

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in the trash? " + message.isInTrash());

החזרות

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

`isStarred()`

מציין אם ההודעה מסומנת בכוכב.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is starred? " + message.isStarred());

החזרות

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

`isUnread()`

מציין אם הודעה זו לא נקראה.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is unread? " + message.isUnread());

החזרות

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

הרשאות

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

https://mail.google.com/

`markRead()`

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

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

החזרות

GmailMessage – הודעת Gmail הזו, שימושית ליצירת שרשורים.

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

isUnread()

`markUnread()`

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

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

החזרות

GmailMessage – הודעת Gmail הזו, שימושית ליצירת שרשורים.

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

isUnread()

`moveToTrash()`

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

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

החזרות

GmailMessage – הודעת Gmail הזו, שימושית ליצירת שרשורים.

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

isInTrash()

`refresh()`

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var 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 – ההודעה הזו לשרשור.

הרשאות

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

https://mail.google.com/

`reply(body)`

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

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

פרמטרים

שם	תיאור	התיאור
`body`	`String`	גוף האימייל.

החזרות

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

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

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

`reply(body, options)`

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

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

// Respond with HTML body text
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var 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 – ההודעה הזו שימושית לשרשור.

הרשאות

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

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
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.replyAll("Got your message");

פרמטרים

שם	תיאור	התיאור
`body`	`String`	גוף האימייל.

החזרות

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

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

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

`replyAll(body, options)`

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

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

// Respond with HTML body text
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
messageThread.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 – ההודעה הזו שימושית לשרשור.

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

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

`star()`

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

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

החזרות

GmailMessage – הודעת Gmail הזו, שימושית ליצירת שרשורים.

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

unstar()

`unstar()`

ביטול הסימון של ההודעה בכוכב.

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

החזרות

GmailMessage – הודעת Gmail הזו, שימושית ליצירת שרשורים.

הרשאות

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

https://mail.google.com/

כדאי לעיין גם בפרטים הבאים

star()