הודעה בחשבון 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/
ראה גם
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/
ראה גם
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/
ראה גם
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)
העברת ההודעה הזו לנמענים חדשים, עם ארגומנטים אופציונליים.
האימייל יכול להכיל גם טקסט פשוט וגם גוף 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/
ראה גם
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/
ראה גם
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/
ראה גם
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/
ראה גם
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/
ראה גם
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/
ראה גם
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/
ראה גם
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/
ראה גם
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/
ראה גם
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/
ראה גם
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/
ראה גם
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/
ראה גם
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)
משיב לשולח ההודעה באמצעות הכתובת לתשובה, עם ארגומנטים אופציונליים.
האימייל יכול להכיל גם טקסט פשוט וגם גוף 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/
ראה גם
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/
ראה גם
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/
ראה גם
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()
הסרת הכוכב מההודעה.
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/