Class GmailApp

GmailApp

מספקת גישה לשרשורים, להודעות ולתוויות ב-Gmail.

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
createDraft(recipient, subject, body)	GmailDraft	יצירת טיוטה של הודעת אימייל.
createDraft(recipient, subject, body, options)	GmailDraft	יוצרת טיוטה של הודעת אימייל עם ארגומנטים אופציונליים.
createLabel(name)	GmailLabel	יצירת תווית משתמש חדשה של השם הנתון.
deleteLabel(label)	GmailApp	מחיקת התווית שצוינה.
getAliases()	String[]	הפונקציה מקבלת רשימה של כתובות האימייל שמוגדרות ככתובות אימייל חלופיות בחשבון הזה ב-Gmail.
getDraft(draftId)	GmailDraft	אחזור טיוטה של הודעת אימייל לפי מזהה.
getDraftMessages()	GmailMessage[]	מאחזר את כל טיוטות ההודעות.
getDrafts()	GmailDraft[]	קבלת כל הודעות הטיוטה של Gmail.
getInboxThreads()	GmailThread[]	מאחזר את כל השרשורים של תיבת הדואר הנכנס, ללא קשר לתוויות.
getInboxThreads(start, max)	GmailThread[]	מאחזר מגוון של שרשורים ב-Inbox, ללא קשר לתוויות.
getInboxUnreadCount()	Integer	קבלת מספר השרשורים שלא נקראו בתיבת הדואר הנכנס.
getMessageById(id)	GmailMessage	קבלת הודעה לפי מזהה.
getMessagesForThread(thread)	GmailMessage[]	אחזור כל ההודעות בשרשור שצוין.
getMessagesForThreads(threads)	GmailMessage[][]	אחזור כל ההודעות בשרשורים שצוינו.
getPriorityInboxThreads()	GmailThread[]	מאחזר את כל השרשורים של 'דואר ממוין' ללא קשר לתוויות.
getPriorityInboxThreads(start, max)	GmailThread[]	אחזור של טווח שרשורים של דואר ממוין, ללא קשר לתוויות.
getPriorityInboxUnreadCount()	Integer	קבלת מספר השרשורים שלא נקראו בתיבת הדואר הנכנס.
getSpamThreads()	GmailThread[]	אחזור של כל שרשורי הספאם ללא קשר לתוויות.
getSpamThreads(start, max)	GmailThread[]	מאחזר מגוון של שרשורי ספאם, ללא קשר לתוויות.
getSpamUnreadCount()	Integer	קבלת מספר השרשורים שלא נקראו שהם ספאם.
getStarredThreads()	GmailThread[]	מאחזר את כל השרשורים שמסומנים בכוכב, ללא קשר לתוויות.
getStarredThreads(start, max)	GmailThread[]	מאחזר טווח של שרשורים מסומנים בכוכב, ללא קשר לתוויות.
getStarredUnreadCount()	Integer	קבלת מספר השרשורים שלא נקראו שסומנו בכוכב.
getThreadById(id)	GmailThread	הפונקציה מקבלת שרשור לפי מזהה.
getTrashThreads()	GmailThread[]	אחזור של כל שרשורי האשפה ללא קשר לתוויות.
getTrashThreads(start, max)	GmailThread[]	מאחזר מגוון של שרשורי אשפה, ללא קשר לתוויות.
getUserLabelByName(name)	GmailLabel	מאחזר תווית לפי שם התווית.
getUserLabels()	GmailLabel[]	מאחזר רשימה של תוויות שנוצרו על ידי המשתמשים.
markMessageRead(message)	GmailApp	מסמן הודעה זו כ'נקראה' ומאלץ את הרענון של ההודעה.
markMessageUnread(message)	GmailApp	מסמן את ההודעה הזו כלא נקראה ומאלץ את הרענון של ההודעה.
markMessagesRead(messages)	GmailApp	מסמן את ההודעות האלה כהודעות שנקראו ומאלץ את ההודעות לרענן אותן.
markMessagesUnread(messages)	GmailApp	מסמן הודעות אלה כהודעות שלא נקראו ומאלץ את ההודעות לרענן.
markThreadImportant(thread)	GmailApp	מסמן את השרשור הזה כחשוב ומאלץ את השרשור לרענן.
markThreadRead(thread)	GmailApp	השרשור הזה מסמן כנקרא ומאלץ את השרשור לרענן.
markThreadUnimportant(thread)	GmailApp	מסמן את השרשור הזה כלא חשוב ומאלץ את השרשור לרענן.
markThreadUnread(thread)	GmailApp	מסמן את השרשור הזה כ'לא נקרא' ומאלץ את השרשור לרענן.
markThreadsImportant(threads)	GmailApp	השרשורים האלה מסומנים כחשובים ומאלצים את הרענון של השרשורים.
markThreadsRead(threads)	GmailApp	השרשורים האלה מסומנים כ'נקראו' ומאלצים את הרענון של השרשורים.
markThreadsUnimportant(threads)	GmailApp	השרשורים מסומנים כלא חשובים ומאלצים את הרענון של השרשורים.
markThreadsUnread(threads)	GmailApp	מסמן את השרשורים האלה כ'לא נקראו' ומאלץ את השרשורים לרענן.
moveMessageToTrash(message)	GmailApp	מעביר את ההודעה לאשפה ומאלץ את הרענון של ההודעה.
moveMessagesToTrash(messages)	GmailApp	מעביר את ההודעות שצוינו לאשפה ומאלץ את ההודעות לרענן.
moveThreadToArchive(thread)	GmailApp	מעביר את השרשור הזה לארכיון ומאלץ את השרשור לרענן.
moveThreadToInbox(thread)	GmailApp	מעביר את השרשור הזה לתיבת הדואר הנכנס ומאלץ לרענן את השרשור.
moveThreadToSpam(thread)	GmailApp	מעביר את השרשור הזה לספאם ומאלץ לרענן את השרשור.
moveThreadToTrash(thread)	GmailApp	מעביר את השרשור הזה לאשפה ומאלץ את השרשור לרענן.
moveThreadsToArchive(threads)	GmailApp	מעביר את השרשורים האלה לארכיון ומאלץ את השרשורים לרענן.
moveThreadsToInbox(threads)	GmailApp	מעביר את השרשורים האלה לתיבת הדואר הנכנס ומאלץ את השרשורים לרענן.
moveThreadsToSpam(threads)	GmailApp	מעביר את השרשורים האלה לספאם ומאלץ לרענן את השרשורים.
moveThreadsToTrash(threads)	GmailApp	מעביר את השרשורים האלה לאשפה ומאלץ את השרשורים לרענן.
refreshMessage(message)	GmailApp	טוען מחדש את ההודעה ואת המצב המשויך מ-Gmail (שימושי למקרה שהתוויות, מצב הקריאה וכו' השתנו).
refreshMessages(messages)	GmailApp	טוען מחדש את ההודעות ואת המצב המשויך מ-Gmail (שימושי למקרה שהתוויות, מצב הקריאה וכו' השתנו).
refreshThread(thread)	GmailApp	טוען מחדש את השרשור ואת המצב המשויך מ-Gmail (שימושי למקרה שהתוויות, מצב הקריאה וכו' השתנו).
refreshThreads(threads)	GmailApp	טוען מחדש את השרשורים ואת המצב המשויך מ-Gmail (שימושי למקרה שהתוויות, מצב הקריאה וכו' השתנו).
search(query)	GmailThread[]	מחפשים ב-Gmail באמצעות השאילתה הנתונה.
search(query, start, max)	GmailThread[]	מחפשים ב-Gmail באמצעות השאילתה הנתונה.
sendEmail(recipient, subject, body)	GmailApp	תישלח הודעת אימייל.
sendEmail(recipient, subject, body, options)	GmailApp	נשלחת הודעת אימייל עם ארגומנטים אופציונליים.
setCurrentMessageAccessToken(accessToken)	void	המדיניות הזו מגדירה את אסימון הגישה הנוכחי להודעה שמאפשר לסקריפט לגשת לנכסי GmailMessage הנוכחיים.
starMessage(message)	GmailApp	מוסיף כוכב להודעה הזו ומאלץ את הרענון של ההודעה.
starMessages(messages)	GmailApp	מוסיף כוכבים להודעות האלה ומאלץ את ההודעות לרענן.
unstarMessage(message)	GmailApp	מסיר כוכב מההודעה הזו ומאלץ את הרענון של ההודעה.
unstarMessages(messages)	GmailApp	מסיר כוכבים מההודעות ומאלץ לרענן את ההודעות.

שיטות שהוצאו משימוש

שיטה	סוג הערך שמוחזר	תיאור קצר
getChatThreads()	GmailThread[]	מקבלים את כל השרשורים של הגרסה הקלאסית של Google Hangouts ואת השרשורים של Google Chat עד ש-Google תעביר את כל המשתמשים בגרסה הקלאסית של Hangouts ל-Chat בהמשך השנה.
getChatThreads(start, max)	GmailThread[]	מקבלים מגוון שרשורים בגרסה הקלאסית של Google Hangouts ושרשורים ב-Google Chat, עד ש-Google תעביר את כל המשתמשים בגרסה הקלאסית של Hangouts ל-Chat בהמשך השנה.

תיעוד מפורט

createDraft(recipient, subject, body)

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

// The code below creates a draft email with the current date and time.
var now = new Date();
GmailApp.createDraft("[e-mail]", "current time", "The time is: " + now.toString());

פרמטרים

שם	תיאור	התיאור
recipient	String	רשימת כתובות אימייל מופרדות בפסיקים
subject	String	נושא האימייל
body	String	גוף האימייל

החזרות

GmailDraft - הטיוטה החדשה של Gmail

הרשאות

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

• https://mail.google.com/

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

• createDraft(recipient, subject, body, options)

---

createDraft(recipient, subject, body, options)

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

// Create a draft email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft('[e-mail]', 'Attachment example', 'Please see attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

פרמטרים

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

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

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

החזרות

GmailDraft - הטיוטה החדשה של Gmail

הרשאות

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

• https://mail.google.com/

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

• createDraft(recipient, subject, body)

---

createLabel(name)

יצירת תווית משתמש חדשה של השם הנתון.

// Creates the label @FOO and logs label: FOO
Logger.log("label: " + GmailApp.createLabel("FOO"));

פרמטרים

שם	תיאור	התיאור
name	String	השם של התווית החדשה

החזרות

GmailLabel – התווית החדשה שנוצרה

הרשאות

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

• https://mail.google.com/

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

• deleteLabel(label)

---

deleteLabel(label)

מחיקת התווית שצוינה.

// Have to get the label by name first
var label = GmailApp.getUserLabelByName("FOO");
GmailApp.deleteLabel(label);

פרמטרים

שם	תיאור	התיאור
label	GmailLabel	התווית למחיקה

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• createLabel(name)

---

getAliases()

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

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

// Log the aliases for this Gmail account and send an email as the first one.
var me = Session.getActiveUser().getEmail();
var aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {'from': aliases[0]});
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

החזרות

String[] – מערך של כינויים לחשבון הזה

הרשאות

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

• https://mail.google.com/

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

• sendEmail(recipient, subject, body, options)

---

getDraft(draftId)

אחזור טיוטה של הודעת אימייל לפי מזהה.

אפשר להשתמש בה בשילוב עם getId() בטיוטות של Gmail.

// Get the first draft message in your drafts folder
var draft = GmailApp.getDrafts()[0];
// Get its ID
var draftId = draft.getId();
// Now fetch the same draft using that ID.
var draftById = GmailApp.getDraft(draftId);
// Should always log true as they should be the same message
Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());

פרמטרים

שם	תיאור	התיאור
draftId	String	המזהה של הטיוטה שצריך לאחזר

החזרות

GmailDraft – הטיוטה עם המזהה הנתון

קליעות

Error – אם לא נמצאה טיוטה עם המזהה הנתון

הרשאות

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

• https://mail.google.com/

---

getDraftMessages()

מאחזר את כל טיוטות ההודעות.

// Logs the number of draft messages
var drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

החזרות

GmailMessage[] – מערך של טיוטות הודעות Gmail

הרשאות

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

• https://mail.google.com/

---

getDrafts()

קבלת כל הודעות הטיוטה של Gmail.

var drafts = GmailApp.getDrafts();
for (var i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

החזרות

GmailDraft[] – מערך של הודעות טיוטה ב-Gmail

הרשאות

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

• https://mail.google.com/

---

getInboxThreads()

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

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

// Log the subject lines of your Inbox
var threads = GmailApp.getInboxThreads();
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

החזרות

GmailThread[] – מערך של שרשורי Gmail בתיבת הדואר הנכנס

הרשאות

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

• https://mail.google.com/

---

getInboxThreads(start, max)

מאחזר מגוון של שרשורים ב-Inbox, ללא קשר לתוויות.

// Log the subject lines of up to the first 50 emails in your Inbox
var threads = GmailApp.getInboxThreads(0, 50);
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

פרמטרים

שם	תיאור	התיאור
start	Integer	האינדקס של השרשור הראשון שצריך לאחזר
max	Integer	המספר המקסימלי של שרשורים שצריך לאחזר

החזרות

GmailThread[] – מערך של שרשורי Gmail בתיבת הדואר הנכנס

הרשאות

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

• https://mail.google.com/

---

getInboxUnreadCount()

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

Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());

החזרות

Integer – מספר השרשורים בתיבת הדואר הנכנס שיש בהם הודעות שלא נקראו

הרשאות

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

• https://mail.google.com/

---

getMessageById(id)

קבלת הודעה לפי מזהה.

אפשר להשתמש בה בשילוב עם getId() בהודעות Gmail.

// Get the first message in the first thread of your inbox
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
var messageId = message.getId();
// Now fetch the same message using that ID.
var messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() == messageById.getSubject());

פרמטרים

שם	תיאור	התיאור
id	String	המזהה של ההודעה שיש לאחזר

החזרות

GmailMessage – ההודעה עם המזהה הנתון

קליעות

Error – אם לא נמצאה הודעה עם המזהה הנתון

הרשאות

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

• https://mail.google.com/

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

• getThreadById(id)

---

getMessagesForThread(thread)

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

// Log all the subject lines in the first thread of your inbox
var thread = GmailApp.getInboxThreads(0, 1)[0];
var messages = GmailApp.getMessagesForThread(thread);
for (var i = 0 ; i < messages.length; i++) {
  Logger.log("subject: " + messages[i].getSubject());
}

פרמטרים

שם	תיאור	התיאור
thread	GmailThread	שרשור ההודעות שצריך לאחזר

החזרות

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

הרשאות

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

• https://mail.google.com/

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

• getMessagesForThreads(threads)

---

getMessagesForThreads(threads)

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

// Log the subject lines of all messages in the first two threads of your inbox
var thread = GmailApp.getInboxThreads(0, 2);
var messages = GmailApp.getMessagesForThreads(thread);
for (var i = 0 ; i < messages.length; i++) {
  for (var j = 0; j < messages[i].length; j++) {
    Logger.log("subject: " + messages[i][j].getSubject());
  }
}

פרמטרים

שם	תיאור	התיאור
threads	GmailThread[]	את השרשורים של הודעות שצריך לאחזר

החזרות

GmailMessage[][] - מערך של מערכים של הודעות, שבו כל פריט במערך החיצוני תואם ל-thread והמערך הפנימי מכיל את ההודעות בשרשור הזה

הרשאות

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

• https://mail.google.com/

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

• getMessagesForThread(thread)

---

getPriorityInboxThreads()

מאחזר את כל השרשורים של 'דואר ממוין' ללא קשר לתוויות.

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

Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads().length);

החזרות

GmailThread[] - מערך של שרשורי Gmail בתיבת הדואר הנכנס הממוין

הרשאות

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

• https://mail.google.com/

---

getPriorityInboxThreads(start, max)

אחזור של טווח שרשורים של דואר ממוין, ללא קשר לתוויות.

// Will log some number 2 or less
Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads(0, 2).length);

פרמטרים

שם	תיאור	התיאור
start	Integer	האינדקס של השרשור הראשון שצריך לאחזר
max	Integer	המספר המקסימלי של שרשורים שצריך לאחזר

החזרות

GmailThread[] - מערך של שרשורי Gmail בתיבת הדואר הנכנס הממוין

הרשאות

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

• https://mail.google.com/

---

getPriorityInboxUnreadCount()

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

Logger.log("Number of unread emails in your Priority Inbox : " +
           GmailApp.getPriorityInboxUnreadCount());

החזרות

Integer – מספר השרשורים בתיבת הדואר הממוין שיש בהם הודעות שלא נקראו

הרשאות

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

• https://mail.google.com/

---

getSpamThreads()

אחזור של כל שרשורי הספאם ללא קשר לתוויות.

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

Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);

החזרות

GmailThread[] – מערך של שרשורי Gmail בתיקיית הספאם

הרשאות

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

• https://mail.google.com/

---

getSpamThreads(start, max)

מאחזר מגוון של שרשורי ספאם, ללא קשר לתוויות.

// Will log a number at most 5
Logger.log("# of total spam threads: " + GmailApp.getSpamThreads(0, 5).length);

פרמטרים

שם	תיאור	התיאור
start	Integer	האינדקס של השרשור הראשון שצריך לאחזר
max	Integer	המספר המקסימלי של שרשורים שצריך לאחזר

החזרות

GmailThread[] – מערך של שרשורי Gmail בתיקיית הספאם

הרשאות

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

• https://mail.google.com/

---

getSpamUnreadCount()

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

// Unless you actually read stuff in your spam folder, this should be the same as
// the number of messages in your spam folder.
Logger.log("# unread threads that are spam: " + GmailApp.getSpamUnreadCount());

החזרות

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

הרשאות

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

• https://mail.google.com/

---

getStarredThreads()

מאחזר את כל השרשורים שמסומנים בכוכב, ללא קשר לתוויות.

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

// Logs the number of starred threads
Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);

החזרות

GmailThread[] – מערך של שרשורי Gmail המסומנים בכוכב

הרשאות

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

• https://mail.google.com/

---

getStarredThreads(start, max)

מאחזר טווח של שרשורים מסומנים בכוכב, ללא קשר לתוויות.

// Logs the number of starred threads to a maximum of 5
Logger.log("# Starred threads: " + GmailApp.getStarredThreads(0, 5).length);

פרמטרים

שם	תיאור	התיאור
start	Integer	האינדקס של השרשור הראשון שצריך לאחזר
max	Integer	המספר המקסימלי של שרשורים שצריך לאחזר

החזרות

GmailThread[] – מערך של שרשורי Gmail המסומנים בכוכב

הרשאות

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

• https://mail.google.com/

---

getStarredUnreadCount()

קבלת מספר השרשורים שלא נקראו שסומנו בכוכב.

Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());

החזרות

Integer – מספר השרשורים המסומנים בכוכב שיש בהם הודעות שלא נקראו

הרשאות

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

• https://mail.google.com/

---

getThreadById(id)

הפונקציה מקבלת שרשור לפי מזהה.

אפשר להשתמש בה בשילוב עם getId() בשרשורים של Gmail.

// Gets the first inbox thread.
const firstThread = GmailApp.getInboxThreads(0,1)[0];
// Gets the same thread by ID.
const threadById = GmailApp.getThreadById(firstThread.getId());
// Verifies that they are the same.
console.log(firstThread.getFirstMessageSubject() === threadById.getFirstMessageSubject());

פרמטרים

שם	תיאור	התיאור
id	String	מזהה השרשור שצריך לאחזר.

החזרות

GmailThread – השרשור עם המזהה הנתון או null אם לא נמצא.

הרשאות

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

• https://mail.google.com/

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

• getMessageById(id)

---

getTrashThreads()

אחזור של כל שרשורי האשפה ללא קשר לתוויות.

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

Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);

החזרות

GmailThread[] – מערך של שרשורי Gmail באשפה

הרשאות

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

• https://mail.google.com/

---

getTrashThreads(start, max)

מאחזר מגוון של שרשורי אשפה, ללא קשר לתוויות.

// Will log a number at most 5
Logger.log("# of total trash threads: " + GmailApp.getTrashThreads(0, 5).length);

פרמטרים

שם	תיאור	התיאור
start	Integer	האינדקס של השרשור הראשון שצריך לאחזר
max	Integer	המספר המקסימלי של שרשורים שצריך לאחזר

החזרות

GmailThread[] – מערך של שרשורי Gmail באשפה

הרשאות

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

• https://mail.google.com/

---

getUserLabelByName(name)

מאחזר תווית לפי שם התווית.

var labelObject = GmailApp.getUserLabelByName("myLabel");

פרמטרים

שם	תיאור	התיאור
name	String	שם התווית שצריך לאחזר

החזרות

GmailLabel - התווית ב-Gmail עם השם הנתון

הרשאות

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

• https://mail.google.com/

---

getUserLabels()

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

// Logs all of the names of your labels
var labels = GmailApp.getUserLabels();
for (var i = 0; i < labels.length; i++) {
  Logger.log("label: " + labels[i].getName());
}

החזרות

GmailLabel[] – מערך תוויות שנוצרו על ידי המשתמש

הרשאות

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

• https://mail.google.com/

---

markMessageRead(message)

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

// Mark the first message in the first thread of your inbox as read
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageRead(message);

פרמטרים

שם	תיאור	התיאור
message	GmailMessage	ההודעה לסימון כהודעה שנקראה

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• markMessageUnread(message)

---

markMessageUnread(message)

מסמן את ההודעה הזו כלא נקראה ומאלץ את הרענון של ההודעה.

// Mark the first message in the first thread of your inbox as unread
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

פרמטרים

שם	תיאור	התיאור
message	GmailMessage	ההודעה לסימון כהודעה שלא נקראה

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• markMessageRead(message)

---

markMessagesRead(messages)

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

// Mark first three messages in the first inbox thread as read.
// Assumes that the first inbox thread has 3 messages in it.
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(thread.getMessages());

פרמטרים

שם	תיאור	התיאור
messages	GmailMessage[]	מערך של הודעות לסימון כהודעות שנקראו

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• markMessagesUnread(messages)

---

markMessagesUnread(messages)

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

// Mark first three messages in the first inbox thread as unread.
// Assumes that the first inbox thread has 3 messages in it
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(thread.getMessages());

פרמטרים

שם	תיאור	התיאור
messages	GmailMessage[]	מערך של הודעות לסימון כהודעות שלא נקראו

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• markMessagesRead(messages)

---

markThreadImportant(thread)

מסמן את השרשור הזה כחשוב ומאלץ את השרשור לרענן.

// Marks first inbox thread as important
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

פרמטרים

שם	תיאור	התיאור
thread	GmailThread	את השרשור לסימון כחשוב

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• markThreadUnimportant(thread)

---

markThreadRead(thread)

השרשור הזה מסמן כנקרא ומאלץ את השרשור לרענן.

// Marks first inbox thread as read
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadRead(thread);

פרמטרים

שם	תיאור	התיאור
thread	GmailThread	את השרשור לסימון כשרשור שנקרא

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• markThreadUnread(thread)

---

markThreadUnimportant(thread)

מסמן את השרשור הזה כלא חשוב ומאלץ את השרשור לרענן.

// Marks first inbox thread as unimportant
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnimportant(thread);

פרמטרים

שם	תיאור	התיאור
thread	GmailThread	השרשור שצריך לסמן כלא חשוב

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• markThreadImportant(thread)

---

markThreadUnread(thread)

מסמן את השרשור הזה כ'לא נקרא' ומאלץ את השרשור לרענן.

// Marks first inbox thread as unread
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnread(thread);

פרמטרים

שם	תיאור	התיאור
thread	GmailThread	את השרשור לסימון כשרשור שלא נקרא

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• markThreadRead(thread)

---

markThreadsImportant(threads)

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

// Marks first two threads in inbox as important
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

פרמטרים

שם	תיאור	התיאור
threads	GmailThread[]	מערך של שרשורים לסימון כחשובים

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• markThreadsUnimportant(threads)

---

markThreadsRead(threads)

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

// Marks first two threads in inbox as read
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsRead(threads);

פרמטרים

שם	תיאור	התיאור
threads	GmailThread[]	מערך של שרשורים לסימון כפריטים שנקראו

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• markThreadsUnread(threads)

---

markThreadsUnimportant(threads)

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

// Marks first two threads in inbox as unimportant
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnimportant(threads);

פרמטרים

שם	תיאור	התיאור
threads	GmailThread[]	מערך של שרשורים לסימון כלא חשובים

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• markThreadsImportant(threads)

---

markThreadsUnread(threads)

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

// Marks first two threads in inbox as unread
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnread(threads);

פרמטרים

שם	תיאור	התיאור
threads	GmailThread[]	מערך של שרשורים לסימון כ'לא נקרא'

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• markThreadsRead(threads)

---

moveMessageToTrash(message)

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

// Move the first message in your inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

פרמטרים

שם	תיאור	התיאור
message	GmailMessage	ההודעה להעברה לאשפה

החזרות

GmailApp - שירות Gmail (שימושי לשרשורים)

הרשאות

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

• https://mail.google.com/

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

• moveMessagesToTrash(messages)

---

moveMessagesToTrash(messages)

מעביר את ההודעות שצוינו לאשפה ומאלץ את ההודעות לרענן.

// Move first two messages in your inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var messages = firstThread.getMessages();
var toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

פרמטרים

שם	תיאור	התיאור
messages	GmailMessage[]	את ההודעות להעברה לאשפה

החזרות

GmailApp - שירות Gmail (שימושי לשרשורים)

הרשאות

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

• https://mail.google.com/

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

• moveMessageToTrash(message)

---

moveThreadToArchive(thread)

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

// Archive the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToArchive(firstThread);

פרמטרים

שם	תיאור	התיאור
thread	GmailThread	השרשור להעברה לארכיון

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToTrash(thread)

---

moveThreadToInbox(thread)

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

// Find a thread not already in your inbox
var thread = GmailApp.search("-in:inbox")[0]; // Get the first one
GmailApp.moveThreadToInbox(thread);

פרמטרים

שם	תיאור	התיאור
thread	GmailThread	השרשור שיועבר לתיבת הדואר הנכנס

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• moveThreadToTrash(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

---

moveThreadToSpam(thread)

מעביר את השרשור הזה לספאם ומאלץ לרענן את השרשור.

// Tag first thread in inbox as spam
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToSpam(firstThread);

פרמטרים

שם	תיאור	התיאור
thread	GmailThread	השרשור שיועבר לספאם

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• moveThreadToTrash(thread)
• moveThreadToInbox(thread)
• moveThreadToArchive(thread)

---

moveThreadToTrash(thread)

מעביר את השרשור הזה לאשפה ומאלץ את השרשור לרענן.

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

פרמטרים

שם	תיאור	התיאור
thread	GmailThread	השרשור להעברה לאשפה

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

---

moveThreadsToArchive(threads)

מעביר את השרשורים האלה לארכיון ומאלץ את השרשורים לרענן.

// Move first two threads in your inbox to the archive
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToArchive(firstTwoThreads);

פרמטרים

שם	תיאור	התיאור
threads	GmailThread[]	מערך של שרשורים להעברה לארכיון

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToTrash(threads)

---

moveThreadsToInbox(threads)

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

// Find two threads not already in your inbox
var firstTwoThreads = GmailApp.search("-in:inbox", 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

פרמטרים

שם	תיאור	התיאור
threads	GmailThread[]	מערך של שרשורים שיועברו לתיבת הדואר הנכנס

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• moveThreadsToTrash(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

---

moveThreadsToSpam(threads)

מעביר את השרשורים האלה לספאם ומאלץ לרענן את השרשורים.

// Move first two threads in your inbox to spam
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToSpam(firstTwoThreads);

פרמטרים

שם	תיאור	התיאור
threads	GmailThread[]	מערך של שרשורים שיועברו לספאם

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• moveThreadsToInbox(threads)
• moveThreadsToTrash(threads)
• moveThreadsToArchive(threads)

---

moveThreadsToTrash(threads)

מעביר את השרשורים האלה לאשפה ומאלץ את השרשורים לרענן.

// Move first two threads in your inbox to trash
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

פרמטרים

שם	תיאור	התיאור
threads	GmailThread[]	מערך של שרשורים להעברה לאשפה

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

---

refreshMessage(message)

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

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var firstMessage = firstThread.getMessages()[0];
// ...Do something that may take a while here....
GmailApp.refreshMessage(firstMessage);
// ...Do more stuff with firstMessage...

פרמטרים

שם	תיאור	התיאור
message	GmailMessage	ההודעה לרענון

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• refreshMessages(messages)

---

refreshMessages(messages)

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

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 2);
// ...Do something that may take a while here....
GmailApp.refreshMessages(coupleOfMessages);
// ...Do more stuff with coupleOfMessages...

פרמטרים

שם	תיאור	התיאור
messages	GmailMessage[]	אילו הודעות צריך לרענן

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• refreshMessage(message)

---

refreshThread(thread)

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

var firstThread = GmailApp.getInboxThreads(0,1)[0];
// ...Do something that may take a while here....
GmailApp.refreshThread(firstThread);
// ... Do more stuff with the thread ...

פרמטרים

שם	תיאור	התיאור
thread	GmailThread	השרשור לרענון

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• refreshThreads(threads)

---

refreshThreads(threads)

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

var threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

פרמטרים

שם	תיאור	התיאור
threads	GmailThread[]	השרשורים שרוצים לרענן

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• refreshThread(thread)

---

search(query)

מחפשים ב-Gmail באמצעות השאילתה הנתונה.

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

// Find starred messages with subject IMPORTANT
var threads = GmailApp.search('is:starred subject:"IMPORTANT"');

פרמטרים

שם	תיאור	התיאור
query	String	שאילתת החיפוש, כמו שמקלידים אותה ב-Gmail

החזרות

GmailThread[] – מערך של שרשורי Gmail שתואמים לשאילתה הזו

הרשאות

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

• https://mail.google.com/

---

search(query, start, max)

מחפשים ב-Gmail באמצעות השאילתה הנתונה.

// Find starred messages with subject IMPORTANT and return second batch of 10.
// Assumes there are at least 11 of them, otherwise this will return an empty array.
var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

פרמטרים

שם	תיאור	התיאור
query	String	שאילתת החיפוש, כמו שמקלידים אותה ב-Gmail
start	Integer	האינדקס של השרשור ההתחלתי
max	Integer	מספר השרשורים המקסימלי שצריך להחזיר

החזרות

GmailThread[] – מערך של שרשורי Gmail שתואמים לשאילתה הזו

הרשאות

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

• https://mail.google.com/

---

sendEmail(recipient, subject, body)

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

// The code below will send an email with the current date and time.
var now = new Date();
GmailApp.sendEmail("[e-mail]", "current time", "The time is: " + now.toString());

פרמטרים

שם	תיאור	התיאור
recipient	String	רשימת כתובות אימייל מופרדות בפסיקים
subject	String	נושא האימייל (250 תווים לכל היותר)
body	String	גוף האימייל

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• sendEmail(recipient, subject, body, options)

---

sendEmail(recipient, subject, body, options)

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

// Send an email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail('[e-mail]', 'Attachment example', 'Please see the attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

פרמטרים

שם	תיאור	התיאור
recipient	String	את הכתובות של הנמען
subject	String	שורת הנושא (250 תווים לכל היותר)
body	String	גוף האימייל
options	Object	אובייקט JavaScript המציין פרמטרים מתקדמים, כפי שמתואר בהמשך

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

שם	תיאור	התיאור
attachments	BlobSource[]	מערך של קבצים לשליחה עם כתובת האימייל
bcc	String	רשימה מופרדת בפסיקים של כתובות אימייל בשדה 'עותק מוסתר'
cc	String	רשימה של כתובות אימייל שמופרדות באמצעות פסיקים,
from	String	הכתובת שממנה יש לשלוח את האימייל, והיא צריכה להיות אחד מהערכים שמוחזרים על ידי 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	כתובת אימייל שתשמש ככתובת ברירת המחדל לתשובה (ברירת המחדל: כתובת האימייל של המשתמש)

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• sendEmail(recipient, subject, body)

---

setCurrentMessageAccessToken(accessToken)

המדיניות הזו מגדירה את אסימון הגישה הנוכחי להודעה שמאפשר לסקריפט לגשת לנכסי GmailMessage הנוכחיים.

השיטה הזו דרושה רק בפרויקטים של תוסף Google Workspace שמשתמשים בהיקפי ההודעות הנוכחיים ב-Gmail.

function handleAddonActionEvent(e) {
  var accessToken = e.messageMetadata.accessToken;
  var messageId = e.messageMetadata.messageId;
  GmailApp.setCurrentMessageAccessToken(accessToken);
  var mailMessage = GmailApp.getMessageById(messageId);
  // Do something with mailMessage
}

פרמטרים

שם	תיאור	התיאור
accessToken	String	אסימון הגישה הזמני שהתקבל מאובייקט אירוע של פעולה בתוסף ל-Gmail.

הרשאות

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

• https://mail.google.com/

---

starMessage(message)

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

// Stars the first message in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

פרמטרים

שם	תיאור	התיאור
message	GmailMessage	ההודעה שצריך לסמן בכוכב

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• starMessages(messages)

---

starMessages(messages)

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

// Stars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

פרמטרים

שם	תיאור	התיאור
messages	GmailMessage[]	מערך הודעות לסימון בכוכב

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• starMessage(message)

---

unstarMessage(message)

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

// Unstars the first message in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

פרמטרים

שם	תיאור	התיאור
message	GmailMessage	ההודעה שיש לבטל את הסימון שלה בכוכב

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• unstarMessages(messages)

---

unstarMessages(messages)

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

// Unstars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

פרמטרים

שם	תיאור	התיאור
messages	GmailMessage[]	מערך הודעות שיש לבטל את הסימון בכוכב

החזרות

GmailApp - שירות Gmail, שימושי לשרשורים

הרשאות

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

• https://mail.google.com/

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

• unstarMessage(message)

שיטות שהוצאו משימוש

getChatThreads()

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

מקבלים את כל השרשורים של הגרסה הקלאסית של Google Hangouts ואת השרשורים של Google Chat עד ש-Google תעביר את כל המשתמשים בגרסה הקלאסית של Hangouts ל-Chat בהמשך השנה. למידע נוסף, ראו מידע על המעבר מהגרסה הקלאסית של Hangouts ל-Google Chat.

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

var threads = GmailApp.getChatThreads();
Logger.log("# of chat threads: " + threads.length);

החזרות

GmailThread[] – מערך של שרשורי צ'אטים מ-Gmail.

הרשאות

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

• https://mail.google.com/

---

getChatThreads(start, max)

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

מקבלים מגוון שרשורים בגרסה הקלאסית של Google Hangouts ושרשורים ב-Google Chat, עד ש-Google תעביר את כל המשתמשים בגרסה הקלאסית של Hangouts ל-Chat בהמשך השנה. למידע נוסף, ראו מידע על המעבר מהגרסה הקלאסית של Hangouts ל-Google Chat.

// Get first 50 chat threads
var threads = GmailApp.getChatThreads(0,50);
// Will log no more than 50.0
Logger.log(threads.length);
Logger.log(threads[0].getFirstMessageSubject());

פרמטרים

שם	תיאור	התיאור
start	Integer	האינדקס של השרשור הראשון שצריך לאחזר
max	Integer	המספר המקסימלי של שרשורים שצריך לאחזר

החזרות

GmailThread[] – מערך של שרשורי צ'אט ב-Gmail

הרשאות

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

• https://mail.google.com/