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[]	אחזור טווח של שרשורים מתיבת הדואר הנכנס, ללא קשר לתוויות.
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 – הגרסה החדשה של GmailDraft שנוצרה

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-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 – הגרסה החדשה של GmailDraft שנוצרה

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-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.

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

// 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)

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

// 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	האינדקס של ה-thread הראשון לאחזור
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	האינדקס של ה-thread הראשון לאחזור
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	האינדקס של ה-thread הראשון לאחזור
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	האינדקס של ה-thread הראשון לאחזור
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	האינדקס של ה-thread הראשון לאחזור
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

הקריאה הזו נכשלת כשכל ה-threads גדולים מדי והמערכת לא יכולה לטפל בהם. איפה גודל השרשור לא ידוע, וייתכן שהוא גדול מאוד. אפשר להשתמש בעמודה '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	האינדקס של ה-thread הראשון לאחזור
max	Integer	את המספר המקסימלי של שרשורים לאחזור

חזרה

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

אישור

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

• https://mail.google.com/