תווית שנוצרה על ידי המשתמש בחשבון Gmail של משתמש.
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
addToThread(thread) | GmailLabel | מוסיף את התווית הזו לשרשור הנתון ומאלץ את השרשור לרענן (GmailThread.refresh() ). |
addToThreads(threads) | GmailLabel | מוסיף את התווית הזו לשרשורים הנתונים ומאלץ את השרשורים לרענן. |
deleteLabel() | void | מחיקת התווית הזו. |
getName() | String | הפונקציה מקבלת את השם של התווית הזו. |
getThreads() | GmailThread[] | מאחזר את השרשורים שמסומנים בתווית הזו. |
getThreads(start, max) | GmailThread[] | הפונקציה מקבלת טווח של שרשורים שמסומנים בתווית הזו. |
getUnreadCount() | Integer | קבלת מספר השרשורים שלא נקראו שמתויגים בתווית הזו. |
removeFromThread(thread) | GmailLabel | מסיר את התווית הזו מהשרשור הנתון ומאלץ את השרשור לרענן. |
removeFromThreads(threads) | GmailLabel | מסיר את התווית הזו מהשרשורים הנתונים ומאלץ את השרשורים לרענן. |
תיעוד מפורט
addToThread(thread)
מוסיף את התווית הזו לשרשור הנתון ומאלץ את השרשור לרענן (GmailThread.refresh()
).
// label the first thread in the inbox with the label MyLabel var label = GmailApp.getUserLabelByName("MyLabel"); var firstThread = GmailApp.getInboxThreads(0,1)[0]; label.addToThread(firstThread);
פרמטרים
שם | תיאור | התיאור |
---|---|---|
thread | GmailThread | השרשור שצריך להוסיף לו תווית. |
החזרות
GmailLabel
– התווית הזו לשרשור.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה עם אחד או יותר מההיקפים הבאים או עם ההיקפים המתאימים מ-API ל-REST הקשור:
-
https://mail.google.com/
כדאי לעיין גם בפרטים הבאים
addToThreads(threads)
מוסיף את התווית הזו לשרשורים הנתונים ומאלץ את השרשורים לרענן. אפשר להוסיף תוויות עד 100 שרשורים לכל קבוצה.
// label the first three threads in the inbox with the label MyLabel var label = GmailApp.getUserLabelByName("MyLabel"); var threads = GmailApp.getInboxThreads(0,3); label.addToThreads(threads);
פרמטרים
שם | תיאור | התיאור |
---|---|---|
threads | GmailThread[] | מערך של שרשורים לתיוג. |
החזרות
GmailLabel
– התווית הזו לשרשור.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה עם אחד או יותר מההיקפים הבאים או עם ההיקפים המתאימים מ-API ל-REST הקשור:
-
https://mail.google.com/
כדאי לעיין גם בפרטים הבאים
deleteLabel()
מחיקת התווית הזו.
var label = GmailApp.getUserLabelByName("MyLabel"); label.deleteLabel();
קליעות
Error
— אם לא ניתן למחוק את התווית
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה עם אחד או יותר מההיקפים הבאים או עם ההיקפים המתאימים מ-API ל-REST הקשור:
-
https://mail.google.com/
כדאי לעיין גם בפרטים הבאים
getName()
הפונקציה מקבלת את השם של התווית הזו.
var label = GmailApp.getUserLabelByName("MyLabel"); Logger.log(label.getName()); //logs MyLabel
החזרות
String
– שם התווית.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה עם אחד או יותר מההיקפים הבאים או עם ההיקפים המתאימים מ-API ל-REST הקשור:
-
https://mail.google.com/
getThreads()
מאחזר את השרשורים שמסומנים בתווית הזו.
הקריאות האלה נכשלות כשכל השרשורים גדולים מדי למערכת ולא יכולים לטפל בהם. כאשר גודל השרשור לא ידוע ועשוי להיות גדול מאוד, יש להשתמש ב-getThreads(start, max)
ולציין את הטווחים של השרשורים לאחזר בכל שיחה.
// Log the subject lines of the threads labeled with MyLabel var label = GmailApp.getUserLabelByName("MyLabel"); var threads = label.getThreads(); for (var i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); }
החזרות
GmailThread[]
– מערך של שרשורים המסומנים בתווית הזו.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה עם אחד או יותר מההיקפים הבאים או עם ההיקפים המתאימים מ-API ל-REST הקשור:
-
https://mail.google.com/
getThreads(start, max)
הפונקציה מקבלת טווח של שרשורים שמסומנים בתווית הזו.
// log the subject lines of up to the first 30 threads with the label MyLabel var label = GmailApp.getUserLabelByName("MyLabel"); var threads = label.getThreads(0, 30); for (var i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); }
פרמטרים
שם | תיאור | התיאור |
---|---|---|
start | Integer | האינדקס של שרשור הפתיחה. |
max | Integer | המספר המקסימלי של שרשורים להחזרה. |
החזרות
GmailThread[]
– מערך של שרשורים המסומנים בתווית הזו.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה עם אחד או יותר מההיקפים הבאים או עם ההיקפים המתאימים מ-API ל-REST הקשור:
-
https://mail.google.com/
getUnreadCount()
קבלת מספר השרשורים שלא נקראו שמתויגים בתווית הזו.
// log the number of unread threads labeled with MyLabel var label = GmailApp.getUserLabelByName("MyLabel"); Logger.log(label.getUnreadCount());
החזרות
Integer
– מספר השרשורים עם התוויות שלא נקראו.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה עם אחד או יותר מההיקפים הבאים או עם ההיקפים המתאימים מ-API ל-REST הקשור:
-
https://mail.google.com/
removeFromThread(thread)
מסיר את התווית הזו מהשרשור הנתון ומאלץ את השרשור לרענן.
// remove the label MyLabel from the first thread in the inbox var label = GmailApp.getUserLabelByName("MyLabel"); var firstThread = GmailApp.getInboxThreads(0,1)[0]; label.removeFromThread(firstThread);
פרמטרים
שם | תיאור | התיאור |
---|---|---|
thread | GmailThread | התיוג של השרשור יבוטל. |
החזרות
GmailLabel
– התווית הזו לשרשור.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה עם אחד או יותר מההיקפים הבאים או עם ההיקפים המתאימים מ-API ל-REST הקשור:
-
https://mail.google.com/
כדאי לעיין גם בפרטים הבאים
removeFromThreads(threads)
מסיר את התווית הזו מהשרשורים הנתונים ומאלץ את השרשורים לרענן. אפשר להסיר תוויות של עד 100 שרשורים לכל קבוצה.
// remove the label MyLabel from the first three threads in the inbox var label = GmailApp.getUserLabelByName("MyLabel"); var threads = GmailApp.getInboxThreads(0,3); label.removeFromThreads(threads);
פרמטרים
שם | תיאור | התיאור |
---|---|---|
threads | GmailThread[] | מערך של שרשורים שצריך לבטל את הסימון שלהם. |
החזרות
GmailLabel
– התווית הזו לשרשור.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה עם אחד או יותר מההיקפים הבאים או עם ההיקפים המתאימים מ-API ל-REST הקשור:
-
https://mail.google.com/