הודעה בחשבון Gmail של משתמש.
Methods
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
create | Gmail | יוצר טיוטה של תשובה לשולח של ההודעה הזו באמצעות הכתובת לתשובה. |
create | Gmail | יוצר טיוטה של הודעה בתשובה לשולח של ההודעה הזו באמצעות כתובת התשובה, עם ארגומנטים אופציונליים. |
create | Gmail | יוצר טיוטה של תשובה לשולח באמצעות כתובת התשובה ולכל הנמענים של ההודעה הזו. |
create | Gmail | יוצר טיוטה של הודעה בתשובה לשולח של ההודעה הזו באמצעות כתובת התשובה וכל הנמענים, עם ארגומנטים אופציונליים. |
forward(recipient) | Gmail | ההודעה תועבר לנמענים חדשים. |
forward(recipient, options) | Gmail | מעבירה את ההודעה הזו למכותבים חדשים, עם ארגומנטים אופציונליים. |
get | Gmail | מקבל את כל הקבצים המצורפים להודעה הזו. |
get | Gmail | מקבל את כל הקבצים המצורפים להודעה הזו. |
get | String | מחזירה את הנמענים שנוספו לעותק מוסתר בהודעה הזו, מופרדים באמצעות פסיקים. |
get | String | מחזירה את תוכן ה-HTML של גוף ההודעה. |
get | String | מחזירה את הנמענים שקיבלו עותק של ההודעה הזו, מופרדים בפסיקים. |
get | Date | הפונקציה מחזירה את התאריך והשעה של ההודעה. |
get | String | מחזירה את השולח של ההודעה. |
get | String | מקבל את הערך של כותרת RFC 2822 בהינתן שם הכותרת. |
get | String | מחזירה את המזהה של ההודעה. |
get | String | מחזירה את התוכן של גוף ההודעה בלי עיצוב HTML. |
get | String | מקבל את התוכן הגולמי של ההודעה. |
get | String | מקבל את הכתובת לתשובה של ההודעה הזו (בדרך כלל השולח). |
get | String | מחזירה את הנושא של ההודעה. |
get | Gmail | מחזירה את השרשור שמכיל את ההודעה הזו. |
get | String | מקבל את הנמענים של ההודעה הזו, מופרדים באמצעות פסיקים. |
is | Boolean | מחזירה אם ההודעה הזו היא טיוטה. |
is | Boolean | מחזירה אם ההודעה הזו היא צ'אט. |
is | Boolean | מחזירה אם ההודעה נמצאת בתיבת הדואר הנכנס. |
is | Boolean | הפונקציה מחזירה true אם ההודעה נמצאת בתיבת הדואר הנכנס עם העדיפות, אחרת היא מחזירה false. |
is | Boolean | מחזירה אם ההודעה הזו נמצאת באשפה. |
is | Boolean | מחזירה אם ההודעה הזו מסומנת בכוכב. |
is | Boolean | מחזירה אם ההודעה הזו לא נקראה. |
mark | Gmail | סימון ההודעה כהודעה שנקראה. |
mark | Gmail | ההודעה מסומנת כהודעה שלא נקראה. |
move | Gmail | ההודעה מועברת לאשפה. |
refresh() | Gmail | טעינה מחדש של ההודעה הזו והמצב המשויך שלה מ-Gmail (שימושי אם התוויות, מצב הקריאה וכו' השתנו). |
reply(body) | Gmail | התשובות לשולח ההודעה הזו יישלחו לכתובת 'תשובה אל'. |
reply(body, options) | Gmail | תשובות לשולח ההודעה הזו באמצעות כתובת התשובה, עם ארגומנטים אופציונליים. |
reply | Gmail | התשובות יישלחו לשולח באמצעות כתובת התשובה ולכל הנמענים של ההודעה. |
reply | Gmail | שליחת תשובה לשולח של ההודעה הזו באמצעות כתובת התשובה וכל הנמענים, עם ארגומנטים אופציונליים. |
star() | Gmail | ההודעה מסומנת בכוכב. |
unstar() | Gmail | הכוכב יוסר מההודעה. |
תיעוד מפורט
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 – טיוטת ההודעה שנוצרה.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 | Blob | מערך של קבצים לשליחה עם האימייל |
bcc | String | רשימה של כתובות אימייל שמופרדות בפסיקים, להוספה לעותק מוסתר |
cc | String | רשימה של כתובות אימייל שמופרדות בפסיקים לשליחת עותק |
from | String | הכתובת שממנה צריך לשלוח את האימייל, שחייבת להיות אחת מהכתובות שמוחזרות על ידי Gmail |
html | String | אם ההגדרה מוגדרת, מכשירים שיכולים להציג HTML משתמשים בה במקום בארגומנט body הנדרש. אפשר להוסיף שדה inline אופציונלי בגוף ה-HTML אם יש לכם תמונות מוטמעות באימייל |
inline | Object | אובייקט JavaScript שמכיל מיפוי ממפתח התמונה
(String) לנתוני התמונה (Blob). ההנחה היא שהפרמטר html נמצא בשימוש ומכיל הפניות לתמונות האלה בפורמט <img src="cid:imageKey" /> |
name | String | השם של שולח האימייל (ברירת מחדל: השם של המשתמש) |
reply | String | כתובת אימייל שתשמש ככתובת ברירת המחדל לתשובה (ברירת מחדל: כתובת האימייל של המשתמש) |
subject | String | שורת נושא חדשה לאימייל, עד 250 תווים. |
חזרה
GmailDraft – טיוטת ההודעה שנוצרה.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
createDraftReplyAll(body)
יוצר טיוטה של תשובה לשולח באמצעות כתובת התשובה ולכל הנמענים של ההודעה הזו. הגודל של האימייל (כולל הכותרות) הוא quota limited.
// 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 – טיוטת ההודעה שנוצרה.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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. 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 | Blob | מערך של קבצים לשליחה עם האימייל |
bcc | String | רשימה של כתובות אימייל שמופרדות בפסיקים, להוספה לעותק מוסתר |
cc | String | רשימה של כתובות אימייל שמופרדות בפסיקים לשליחת עותק |
from | String | הכתובת שממנה צריך לשלוח את האימייל, שחייבת להיות אחת מהכתובות שמוחזרות על ידי Gmail |
html | String | אם ההגדרה הזו מוגדרת, מכשירים שיכולים להציג HTML משתמשים בה במקום בארגומנט body הנדרש. אפשר להוסיף שדה inline אופציונלי בגוף ה-HTML אם יש לכם תמונות מוטמעות באימייל |
inline | Object | אובייקט JavaScript שמכיל מיפוי ממפתח התמונה
(String) לנתוני התמונה (Blob). ההנחה היא שהפרמטר html נמצא בשימוש ומכיל הפניות לתמונות האלה בפורמט <img src="cid:imageKey" /> |
name | String | השם של שולח האימייל (ברירת מחדל: השם של המשתמש) |
reply | String | כתובת אימייל שתשמש ככתובת ברירת המחדל לתשובה (ברירת מחדל: כתובת האימייל של המשתמש) |
subject | String | שורת נושא חדשה לאימייל, עד 250 תווים. |
חזרה
GmailDraft – טיוטת ההודעה שנוצרה.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
forward(recipient)
ההודעה תועבר לנמענים חדשים. הגודל של האימייל (כולל הכותרות) הוא quota limited.
// 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 — ההודעה הזו, שימושית לשרשור.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
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 | Blob | מערך של קבצים לשליחה עם האימייל |
bcc | String | רשימה של כתובות אימייל שמופרדות בפסיקים, להוספה לעותק מוסתר |
cc | String | רשימה של כתובות אימייל שמופרדות בפסיקים לשליחת עותק |
from | String | הכתובת שממנה צריך לשלוח את האימייל, שחייבת להיות אחת מהכתובות שמוחזרות על ידי Gmail |
html | String | אם ההגדרה מוגדרת, מכשירים שיכולים להציג HTML משתמשים בה במקום בארגומנט body הנדרש. אפשר להוסיף שדה inline אופציונלי בגוף ה-HTML אם יש לכם תמונות מוטמעות באימייל |
inline | Object | אובייקט JavaScript שמכיל מיפוי ממפתח התמונה
(String) לנתוני התמונה (Blob). ההנחה היא שהפרמטר html נמצא בשימוש ומכיל הפניות לתמונות האלה בפורמט <img src="cid:imageKey" /> |
name | String | השם של שולח האימייל (ברירת מחדל: השם של המשתמש) |
no | Boolean | true אם האימייל צריך להישלח מכתובת אימייל כללית מסוג no-reply כדי למנוע מהנמענים להשיב לאימיילים. האפשרות הזו זמינה רק לחשבונות Google Workspace, ולא למשתמשי Gmail. |
reply | String | כתובת אימייל שתשמש ככתובת ברירת המחדל לתשובה (ברירת מחדל: כתובת האימייל של המשתמש) |
subject | String | שורת נושא חדשה לאימייל, עד 250 תווים. |
חזרה
GmailMessage — ההודעה הזו, שימושית לשרשור.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
getAttachments()
מקבל את כל הקבצים המצורפים להודעה הזו.
חזרה
GmailAttachment[] — מערך של קבצים מצורפים מסוג Blob להודעה הזו.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
getAttachments(options)
מקבל את כל הקבצים המצורפים להודעה הזו.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
options | Object | אובייקט JavaScript שמציין פרמטרים מתקדמים, כמו אלה שמופיעים בהמשך. |
פרמטרים מתקדמים
| שם | סוג | תיאור |
|---|---|---|
include | Boolean | true אם המערך המוחזר של קבצים מצורפים מסוג Blob צריך לכלול תמונות בתוך השורה (ברירת המחדל היא true). |
include | Boolean | true אם המערך שמוחזר של קבצים מצורפים מסוג Blob צריך לכלול קבצים מצורפים רגילים (לא מוטבעים) (ברירת המחדל היא true). |
חזרה
GmailAttachment[] — מערך של קבצים מצורפים מסוג Blob להודעה הזו.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
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 — הנמענים שנוספו לעותק מוסתר בהודעה הזו, מופרדים באמצעות פסיקים.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
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 — תוכן גוף ההודעה.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
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 – הנמענים שקיבלו עותק של ההודעה הזו, מופרדים באמצעות פסיקים.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
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 — התאריך והשעה של ההודעה.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
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 — כתובת האימייל של שולח ההודעה.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
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 – הערך של הכותרת, או מחרוזת ריקה אם הכותרת לא קיימת בהודעה.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
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 — תוכן גוף ההודעה בטקסט פשוט.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
getRawContent()
מקבל את התוכן הגולמי של ההודעה. הפעולה הזו מקבילה ללחיצה על 'הצגת המקור' בממשק המשתמש של Gmail.
חזרה
String — התוכן הגולמי של ההודעה.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
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 — כתובת האימייל לשליחת תשובות.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
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 – נושא ההודעה.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
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 — ה-GmailThread שמכיל את ההודעה הזו.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
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 – הנמענים של ההודעה הזו, מופרדים באמצעות פסיקים.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
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 – האם ההודעה הזו היא טיוטה.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
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()
מחזירה אם ההודעה נמצאת בתיבת הדואר הנכנס.
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 — האם ההודעה הזו נמצאת בתיבת הדואר הנכנס.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
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 — האם ההודעה הזו נמצאת בתיבת הדואר הנכנס הממוינת.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
isInTrash()
מחזירה אם ההודעה הזו נמצאת באשפה.
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 — הסטטוס של ההודעה הזו הוא 'עוד לא קראתי'.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
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 — הודעת Gmail, שימושי לשרשור.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
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 — הודעת Gmail, שימושי לשרשור.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
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 — הודעת Gmail, שימושי לשרשור.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
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 — This message for chaining.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
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 — ההודעה הזו, שימושית לשרשור.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
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 | Blob | מערך של קבצים לשליחה עם האימייל |
bcc | String | רשימה של כתובות אימייל שמופרדות בפסיקים, להוספה לעותק מוסתר |
cc | String | רשימה של כתובות אימייל שמופרדות בפסיקים לשליחת עותק |
from | String | הכתובת שממנה צריך לשלוח את האימייל, שחייבת להיות אחת מהכתובות שמוחזרות על ידי Gmail |
html | String | אם ההגדרה מוגדרת, מכשירים שיכולים להציג HTML משתמשים בה במקום בארגומנט body הנדרש. אפשר להוסיף שדה inline אופציונלי בגוף ה-HTML אם יש לכם תמונות מוטמעות באימייל |
inline | Object | אובייקט JavaScript שמכיל מיפוי ממפתח התמונה
(String) לנתוני התמונה (Blob). ההנחה היא שהפרמטר html נמצא בשימוש ומכיל הפניות לתמונות האלה בפורמט <img src="cid:imageKey" /> |
name | String | השם של שולח האימייל (ברירת מחדל: השם של המשתמש) |
no | Boolean | true אם האימייל צריך להישלח מכתובת אימייל כללית מסוג no-reply כדי למנוע מהנמענים להשיב לאימיילים. האפשרות הזו זמינה רק לחשבונות Google Workspace, ולא למשתמשי Gmail. |
reply | String | כתובת אימייל שתשמש ככתובת ברירת המחדל לתשובה (ברירת מחדל: כתובת האימייל של המשתמש) |
subject | String | שורת נושא חדשה לאימייל, עד 250 תווים. |
חזרה
GmailMessage — ההודעה הזו, שימושית לשרשור.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
replyAll(body)
התשובות יישלחו לשולח באמצעות כתובת התשובה ולכל הנמענים של ההודעה. הגודל של האימייל (כולל הכותרות) הוא quota limited.
// 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 — ההודעה הזו,שימושית לשרשור.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
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 | Blob | מערך של קבצים לשליחה עם האימייל |
bcc | String | רשימה של כתובות אימייל שמופרדות בפסיקים, להוספה לעותק מוסתר |
cc | String | רשימה של כתובות אימייל שמופרדות בפסיקים לשליחת עותק |
from | String | הכתובת שממנה צריך לשלוח את האימייל, שחייבת להיות אחת מהכתובות שמוחזרות על ידי Gmail |
html | String | אם ההגדרה מוגדרת, מכשירים שיכולים להציג HTML משתמשים בה במקום בארגומנט body הנדרש. אפשר להוסיף שדה inline אופציונלי בגוף ה-HTML אם יש לכם תמונות מוטמעות באימייל |
inline | Object | אובייקט JavaScript שמכיל מיפוי ממפתח התמונה
(String) לנתוני התמונה (Blob). ההנחה היא שהפרמטר html נמצא בשימוש ומכיל הפניות לתמונות האלה בפורמט <img src="cid:imageKey" /> |
name | String | השם של שולח האימייל (ברירת מחדל: השם של המשתמש) |
no | Boolean | true אם האימייל צריך להישלח מכתובת אימייל כללית מסוג no-reply כדי למנוע מהנמענים להשיב לאימיילים. האפשרות הזו זמינה רק לחשבונות Google Workspace, ולא למשתמשי Gmail. |
reply | String | כתובת אימייל שתשמש ככתובת ברירת המחדל לתשובה (ברירת מחדל: כתובת האימייל של המשתמש) |
subject | String | שורת נושא חדשה לאימייל, עד 250 תווים. |
חזרה
GmailMessage — ההודעה הזו, שימושית לשרשור.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
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 — הודעת Gmail, שימושי לשרשור.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/
ראה גם
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 — הודעת Gmail, שימושי לשרשור.
אישור
סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:
-
https://mail.google.com/