Class GmailThread

GmailThread

שרשור בחשבון Gmail של משתמש.

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
addLabel(label)	GmailThread	הוספת התווית הזו לשרשור.
createDraftReply(body)	GmailDraft	נוצרת טיוטה של הודעת תגובה לשולח של ההודעה האחרונה בשרשור הזה באמצעות הכתובת לתשובה.
createDraftReply(body, options)	GmailDraft	יצירת טיוטה של הודעה המשיבת לשולח ההודעה האחרונה בשרשור הזה באמצעות הכתובת לתשובה, עם ארגומנטים אופציונליים.
createDraftReplyAll(body)	GmailDraft	יצירת טיוטה של הודעת טיוטה כדי להשיב לשולח של ההודעה האחרונה בשרשור הזה, באמצעות הכתובת לתשובה וכל הנמענים של ההודעה.
createDraftReplyAll(body, options)	GmailDraft	יצירת טיוטה של הודעה המשיבת לשולח של ההודעה האחרונה בשרשור הזה, באמצעות הכתובת לתשובה וכל הנמענים, עם ארגומנטים אופציונליים.
getFirstMessageSubject()	String	מקבל את הנושא של ההודעה הראשונה בשרשור.
getId()	String	הפונקציה מקבלת את המזהה של השרשור הזה.
getLabels()	GmailLabel[]	מחזירה את התוויות שנוצרו על ידי המשתמש בשרשור הזה.
getLastMessageDate()	Date	הפונקציה מקבלת את תאריך ההודעה האחרונה בשרשור הזה.
getMessageCount()	Integer	מחזירה את מספר ההודעות בשרשור.
getMessages()	GmailMessage[]	מקבל את ההודעות בשרשור הזה.
getPermalink()	String	מקבל קישור קבוע לשרשור הזה.
hasStarredMessages()	Boolean	מראה אם בשרשור יש הודעות שמסומנות בכוכב.
isImportant()	Boolean	מחזירה אם השרשור מסומן כחשוב.
isInChats()	Boolean	פונקציה זו מחזירה את הסימון אם השרשור מסומן כצ'אט.
isInInbox()	Boolean	מחזירה אם השרשור נמצא בתיבת הדואר הנכנס.
isInPriorityInbox()	Boolean	הפונקציה מחזירה את הערך True אם השרשור הזה נמצא בתיבת הדואר הנכנס בעדיפות גבוהה. אחרת, היא מחזירה את הערך false.
isInSpam()	Boolean	מראה אם השרשור מסומן כספאם.
isInTrash()	Boolean	מראה אם השרשור נמצא באשפה.
isUnread()	Boolean	מחזירה אם יש בשרשור הודעות שלא נקראו.
markImportant()	GmailThread	סימון השרשור הזה כחשוב.
markRead()	GmailThread	סימון השרשור הזה כנקרא.
markUnimportant()	GmailThread	השרשור הזה יסומן כלא חשוב.
markUnread()	GmailThread	השרשור יסומן כ'עוד לא קראתי'.
moveToArchive()	GmailThread	העברת השרשור הזה לארכיון.
moveToInbox()	GmailThread	מעביר את השרשור הזה לתיבת הדואר הנכנס.
moveToSpam()	GmailThread	השרשור הזה מועבר לספאם.
moveToTrash()	GmailThread	השרשור הזה יועבר לאשפה.
refresh()	GmailThread	טוען מחדש את השרשור הזה ואת המצב המשויך אליו מ-Gmail (שימושי למקרה שהתוויות, מצב הקריאה וכו' השתנו).
removeLabel(label)	GmailThread	הסרת התווית הזו מהשרשור.
reply(body)	GmailThread	להשיב לשולח של ההודעה האחרונה בשרשור הזה באמצעות הכתובת לתשובה.
reply(body, options)	GmailThread	להשיב לשולח של ההודעה האחרונה בשרשור הזה באמצעות הכתובת responseTo, עם ארגומנטים אופציונליים.
replyAll(body)	GmailThread	שליחת תשובה לשולח (באמצעות הכתובת לתשובה) ולכל הנמענים של ההודעה האחרונה בשרשור הזה.
replyAll(body, options)	GmailThread	כתיבת תשובה לשולח (באמצעות הכתובת replyTo) ולכל הנמענים של ההודעה האחרונה בשרשור, עם ארגומנטים אופציונליים.

תיעוד מפורט

addLabel(label)

הוספת התווית הזו לשרשור.

// Add label MyLabel to the first thread in the inbox
var label = GmailApp.getUserLabelByName("MyLabel");
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.addLabel(label);

פרמטרים

שם	תיאור	התיאור
label	GmailLabel	התווית שצריך להוסיף לשרשור הזה

החזרות

GmailThread – השרשור הזה, שימושי לשרשור

הרשאות

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

• https://mail.google.com/

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

• removeLabel(label)

---

createDraftReply(body)

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

// Create a draft reply to the message author with an acknowledgement.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.createDraftReply("Got your message");

פרמטרים

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

החזרות

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

הרשאות

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

• https://mail.google.com/

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

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

---

createDraftReply(body, options)

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

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

// Create a draft response with an HTML text body.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.createDraftReply("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "[e-mail]"
});

פרמטרים

שם	תיאור	התיאור
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 reply to all recipients (except those bcc'd) of the last email in this
// thread.
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 reply, using an HTML text body, to all recipients (except those bcc'd) of
// the last email of in this thread.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.createDraftReplyAll("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "[e-mail]"
});

פרמטרים

שם	תיאור	התיאור
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)

---

getFirstMessageSubject()

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

// Log the subject of the first message in the first thread in the inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log(firstThread.getFirstMessageSubject());

החזרות

String - נושא ההודעה הראשונה בשרשור

הרשאות

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

• https://mail.google.com/

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

• getLastMessageDate()

---

getId()

הפונקציה מקבלת את המזהה של השרשור הזה. המזהה של שרשור משתנה בהתאם להודעות שהוא מכיל. אם זהו מזהה עקבי להודעה מסוימת בשרשור, צריך לקרוא במקום זאת getMessages()[0].getId().

// Log the subject of the first message in the first thread in the inbox.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var id = firstThread.getId();
// Get same thread by its ID.
var thread = GmailApp.getThreadById(id);
Logger.log(thread.getFirstMessageSubject() == firstThread.getFirstMessageSubject()); // True

החזרות

String – המזהה של השרשור הזה

---

getLabels()

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

// Log the names of the labels attached to the first thread in the inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var labels = firstThread.getLabels();
for (var i = 0; i < labels.length; i++) {
  Logger.log(labels[i].getName());
}

החזרות

GmailLabel[] – מערך תוויות לשרשור הזה

הרשאות

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

• https://mail.google.com/

---

getLastMessageDate()

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

// Log the date of the most recent message on the first thread in the inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log(firstThread.getLastMessageDate());

החזרות

Date – התאריך של ההודעה האחרונה בשרשור

הרשאות

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

• https://mail.google.com/

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

• getFirstMessageSubject()

---

getMessageCount()

מחזירה את מספר ההודעות בשרשור.

// Log the number of messages in the thread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log(firstThread.getMessageCount());

החזרות

Integer – מספר ההודעות בשרשור

הרשאות

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

• https://mail.google.com/

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

• getMessages()

---

getMessages()

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

// Log the subjects of the messages in the thread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var messages = firstThread.getMessages();
for (var i = 0; i < messages.length; i++) {
  Logger.log(messages[i].getSubject());
}

החזרות

GmailMessage[] – מערך של הודעות Gmail בשרשור הזה

הרשאות

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

• https://mail.google.com/

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

• getMessageCount()

---

getPermalink()

מקבל קישור קבוע לשרשור הזה.

שימו לב שאפשרות זו פועלת רק בממשק הקלאסי של Gmail, ולא ב-Inbox.

// Logs the permalink for the first thread in the inbox
var thread = GmailApp.getInboxThreads(0,1)[0];
Logger.log(thread.getPermalink());

החזרות

String - הקישור הקבוע לשרשור זה

---

hasStarredMessages()

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

// Log if this thread has starred messages
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('has starred : ' + firstThread.hasStarredMessages());

החזרות

Boolean — True אם יש בשרשור הודעות שמסומנות בכוכב

הרשאות

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

• https://mail.google.com/

---

isImportant()

מחזירה אם השרשור מסומן כחשוב.

// Log if this thread is marked as important
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('Important? : ' + firstThread.isImportant());

החזרות

Boolean – האם השרשור מסומן כחשוב.

הרשאות

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

• https://mail.google.com/

---

isInChats()

פונקציה זו מחזירה את הסימון אם השרשור מסומן כצ'אט.

// Log if this thread is a chat
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('is in chats? : ' + firstThread.isInChats());

החזרות

Boolean — TRUE אם השרשור מתויג כצ'אט

הרשאות

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

• https://mail.google.com/

---

isInInbox()

מחזירה אם השרשור נמצא בתיבת הדואר הנכנס.

// Log if this thread is in the inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('is in the inbox? : ' + firstThread.isInInbox());

החזרות

Boolean — True אם השרשור נמצא בתיבת הדואר הנכנס

הרשאות

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

• https://mail.google.com/

---

isInPriorityInbox()

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

// Log if this thread is in the priority inbox
var firstThread = GmailApp.getPriorityInboxThreads(0,1)[0];
Logger.log("is in priority inbox? " + firstThread.isInPriorityInbox());

החזרות

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

הרשאות

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

• https://mail.google.com/

---

isInSpam()

מראה אם השרשור מסומן כספאם.

// Log if this thread is in the spam folder
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('Spam? ' + firstThread.isInSpam());

החזרות

Boolean – סימון השרשור הזה כספאם.

הרשאות

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

• https://mail.google.com/

---

isInTrash()

מראה אם השרשור נמצא באשפה.

// Log if this thread is in the trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('Trashed? ' + firstThread.isInTrash());

החזרות

Boolean – True אם השרשור נמצא באשפה

הרשאות

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

• https://mail.google.com/

---

isUnread()

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

// Log if this thread is unread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('Unread? ' + firstThread.isUnread());

החזרות

Boolean – True אם יש הודעות שלא נקראו

הרשאות

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

• https://mail.google.com/

---

markImportant()

סימון השרשור הזה כחשוב.

// Mark first inbox thread as important
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.markImportant();

החזרות

GmailThread – השרשור הזה, שימושי לשרשור

הרשאות

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

• https://mail.google.com/

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

• markUnimportant()

---

markRead()

סימון השרשור הזה כנקרא.

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

החזרות

GmailThread – השרשור הזה, שימושי לשרשור

הרשאות

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

• https://mail.google.com/

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

• markUnread()

---

markUnimportant()

השרשור הזה יסומן כלא חשוב.

// Mark first inbox thread as unimportant
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.markUnimportant();

החזרות

GmailThread – השרשור הזה, שימושי לשרשור

הרשאות

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

• https://mail.google.com/

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

• markImportant()

---

markUnread()

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

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

החזרות

GmailThread – השרשור הזה, שימושי לשרשור

הרשאות

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

• https://mail.google.com/

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

• markRead()

---

moveToArchive()

העברת השרשור הזה לארכיון.

// Archive first inbox thread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.moveToArchive();

החזרות

GmailThread – השרשור הזה, שימושי לשרשור

הרשאות

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

• https://mail.google.com/

---

moveToInbox()

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

// Move first non-inbox thread to inbox
var firstThread = GmailApp.search("-in:inbox")[0];
firstThread.moveToInbox();

החזרות

GmailThread – השרשור הזה, שימושי לשרשור

הרשאות

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

• https://mail.google.com/

---

moveToSpam()

השרשור הזה מועבר לספאם.

// Move first inbox thread to spam
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.moveToSpam();

החזרות

GmailThread – השרשור הזה, שימושי לשרשור

הרשאות

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

• https://mail.google.com/

---

moveToTrash()

השרשור הזה יועבר לאשפה.

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

החזרות

GmailThread – השרשור הזה, שימושי לשרשור

הרשאות

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

• https://mail.google.com/

---

refresh()

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

var firstThread = GmailApp.getInboxThreads(0,1)[0];
// ...Do something that may take a while here....
firstThread.refresh(); // Make sure it's up-to-date
// ...Do more stuff with firstThread ...

החזרות

GmailThread – השרשור הזה, שימושי לשרשור

הרשאות

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

• https://mail.google.com/

---

removeLabel(label)

הסרת התווית הזו מהשרשור.

var myLabel = GmailApp.getUserLabelByName('<your label>');
var threads = myLabel.getThreads();
for (var x in threads) {
  var thread = threads[x];
  thread.removeLabel(myLabel);
}

פרמטרים

שם	תיאור	התיאור
label	GmailLabel	התווית להסרה מהשרשור הזה

החזרות

GmailThread – השרשור הזה, שימושי לשרשור

הרשאות

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

• https://mail.google.com/

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

• addLabel(label)

---

reply(body)

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

חשוב לזכור שהגודל הכולל של הודעת האימייל (כולל כל הכותרות) לא יכול לחרוג מ-20KB.

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

פרמטרים

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

החזרות

GmailThread – השרשור הזה, שימושי לשרשור

הרשאות

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

• https://mail.google.com/

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

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

---

reply(body, options)

להשיב לשולח של ההודעה האחרונה בשרשור הזה באמצעות הכתובת responseTo, עם ארגומנטים אופציונליים. האימייל יכול להכיל גם טקסט פשוט וגם גוף HTML. חשוב לזכור שהגודל הכולל של האימייל (כולל כל הכותרות, אבל לא כולל קבצים מצורפים) לא יכול לחרוג מ-20KB.

// Respond with HTML body text.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.reply("incapable of HTML", {
  htmlBody: "some HTML body text",
  noReply: true
});

פרמטרים

שם	תיאור	התיאור
body	String	גוף האימייל
options	Object	אובייקט JavaScript המציין פרמטרים מתקדמים, כפי שמתואר בהמשך

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

שם	תיאור	התיאור
cc	String	רשימה מופרדת בפסיקים של כתובות אימייל לעותק
bcc	String	רשימה מופרדת בפסיקים של כתובות אימייל לעותק מוסתר
htmlBody	String	אם המדיניות מוגדרת, מכשירים שמסוגלים לעבד HTML ישתמשו בו במקום בארגומנט הנדרש; אפשר להוסיף שדה inlineImages אופציונלי בגוף ה-HTML אם יש הודעות אימייל בתוך שורות
name	String	שם השולח של האימייל (ברירת המחדל: שם המשתמש)
from	String	הכתובת שממנה יש לשלוח את האימייל, והיא צריכה להיות אחד מהערכים שמוחזרים על ידי GmailApp.getAliases()
replyTo	String	כתובת אימייל שתשמש ככתובת ברירת המחדל לתשובה (ברירת המחדל: כתובת האימייל של המשתמש)
noReply	Boolean	true אם צריך לשלוח את האימייל מכתובת אימייל כללית ללא מענה, כדי למנוע מנמענים להשיב לאימיילים. האפשרות הזו זמינה רק לחשבונות Google Workspace ולא למשתמשי Gmail.
attachments	BlobSource[]	מערך של קבצים לשליחה עם כתובת האימייל
inlineImages	Object	אובייקט JavaScript שמכיל מיפוי ממפתח תמונה (String) לנתוני תמונה (BlobSource); ההנחה היא שהפרמטר htmlBody נמצא בשימוש ומכיל הפניות לתמונות האלה בפורמט <img src="cid:imageKey" />

החזרות

GmailThread – השרשור הזה, שימושי לשרשור

הרשאות

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

• https://mail.google.com/

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

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

---

replyAll(body)

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

חשוב לזכור שהגודל הכולל של הודעת האימייל (כולל כל הכותרות) לא יכול לחרוג מ-20KB.

// Respond to all with acknowledgment to the first thread in the inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.replyAll("Got your message");

פרמטרים

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

החזרות

GmailThread – השרשור הזה, שימושי לשרשור

הרשאות

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

• https://mail.google.com/

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

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

---

replyAll(body, options)

כתיבת תשובה לשולח (באמצעות הכתובת replyTo) ולכל הנמענים של ההודעה האחרונה בשרשור, עם ארגומנטים אופציונליים. הודעת האימייל יכולה להכיל גם טקסט פשוט וגם גוף HTML. חשוב לזכור שהגודל הכולל של האימייל (כולל כל הכותרות, אבל לא כולל קבצים מצורפים) לא יכול לחרוג מ-20KB.

// Respond with HTML body text.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.replyAll("incapable of HTML", {
  htmlBody: "some HTML body text",
  noReply: true
});

פרמטרים

שם	תיאור	התיאור
body	String	גוף האימייל
options	Object	אובייקט JavaScript המציין פרמטרים מתקדמים, כפי שמתואר בהמשך

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

שם	תיאור	התיאור
cc	String	רשימה מופרדת בפסיקים של כתובות אימייל לעותק
bcc	String	רשימה מופרדת בפסיקים של כתובות אימייל לעותק מוסתר
htmlBody	String	אם המדיניות מוגדרת, מכשירים שמסוגלים לעבד HTML ישתמשו בו במקום בארגומנט הנדרש; אפשר להוסיף שדה inlineImages אופציונלי בגוף ה-HTML אם יש הודעות אימייל בתוך שורות
name	String	שם השולח של האימייל (ברירת המחדל: שם המשתמש)
from	String	הכתובת שממנה יש לשלוח את האימייל, והיא צריכה להיות אחד מהערכים שמוחזרים על ידי GmailApp.getAliases()
replyTo	String	כתובת אימייל שתשמש ככתובת ברירת המחדל לתשובה (ברירת המחדל: כתובת האימייל של המשתמש)
noReply	Boolean	true אם צריך לשלוח את האימייל מכתובת אימייל כללית ללא מענה, כדי למנוע מנמענים להשיב לאימיילים. האפשרות הזו זמינה רק לחשבונות G Suite, ולא למשתמשי Gmail.
attachments	BlobSource[]	מערך של קבצים לשליחה עם כתובת האימייל
inlineImages	Object	אובייקט JavaScript שמכיל מיפוי ממפתח תמונה (String) לנתוני תמונה (BlobSource); ההנחה היא שהפרמטר htmlBody נמצא בשימוש ומכיל הפניות לתמונות האלה בפורמט <img src="cid:imageKey" />

החזרות

GmailThread – השרשור הזה, שימושי לשרשור

הרשאות

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

• https://mail.google.com/

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

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