דף זה תורגם על ידי Cloud Translation API.

Class GmailLabel

תווית שנוצרה על ידי משתמש בחשבון 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/

ראה גם

removeFromThread(thread)

`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 – התווית הזו, לשרשור.

אישור

https://mail.google.com/

ראה גם

removeFromThreads(threads)

`deleteLabel()`

מוחק את התווית הזו.

var label = GmailApp.getUserLabelByName("MyLabel");
label.deleteLabel();

קליעות

Error – אם אי אפשר למחוק את התווית

אישור

https://mail.google.com/

ראה גם

getName()

`getName()`

מקבל את השם של התווית הזו.

var label = GmailApp.getUserLabelByName("MyLabel");
Logger.log(label.getName()); //logs MyLabel

חזרה

String – שם התווית.

אישור

https://mail.google.com/

`getThreads()`

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

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

אישור

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[] – מערך שרשורים שסומנו בתווית הזו.

אישור

https://mail.google.com/

`getUnreadCount()`

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

// log the number of unread threads labeled with MyLabel
var label = GmailApp.getUserLabelByName("MyLabel");
Logger.log(label.getUnreadCount());

חזרה

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

אישור

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 – התווית הזו, לשרשור.

אישור

https://mail.google.com/

ראה גם

addToThread(thread)

`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 – התווית הזו, לשרשור.

אישור

https://mail.google.com/

ראה גם

addToThreads(threads)