Class GmailLabel

GmailLabel

תווית שנוצרה על ידי משתמש בחשבון Gmail שלו.

Methods

שיטהסוג הערך המוחזרתיאור קצר
addToThread(thread)GmailLabelהוספת התווית הזו לשרשור הנתון ואילץ את השרשור להתעדכן (GmailThread.refresh()).
addToThreads(threads)GmailLabelהוספת התווית הזו לשרשור הנתון ואילץ את השרשור להתעדכן.
deleteLabel()voidמחיקה של התווית הזו.
getId()Stringהפונקציה מקבלת את המזהה של התווית הזו.
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
const label = GmailApp.getUserLabelByName('MyLabel');
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
label.addToThread(firstThread);

פרמטרים

שםסוגתיאור
threadGmailThreadהשרשור שרוצים לתייג.

חזרה

GmailLabel — התווית הזו, לשרשור.

אישור

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

  • https://mail.google.com/

ראה גם

addToThreads(threads)

הוספת התווית הזו לשרשור הנתון ואילץ את השרשור להתעדכן. אפשר להוסיף תוויות ל-100 שרשורים לכל היותר בכל קבוצה. 

// label the first three threads in the inbox with the label MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = GmailApp.getInboxThreads(0, 3);
label.addToThreads(threads);

פרמטרים

שםסוגתיאור
threadsGmailThread[]מערך של שרשורים שרוצים לתייג.

חזרה

GmailLabel — התווית הזו, לשרשור.

אישור

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

  • https://mail.google.com/

ראה גם

deleteLabel()

מחיקה של התווית הזו. 

const label = GmailApp.getUserLabelByName('MyLabel');
label.deleteLabel();

זריקות

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

אישור

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

  • https://mail.google.com/

ראה גם

getId()

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

const label = GmailApp.getUserLabelByName('MyLabel');
console.log(label.getId());

חזרה

String – המזהה של התווית.

אישור

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

  • https://mail.google.com/

getName()

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

const label = GmailApp.getUserLabelByName('MyLabel');
Logger.log(label.getName());  // logs MyLabel

חזרה

String – השם של התווית.

אישור

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

  • https://mail.google.com/

getThreads()

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

הקריאות האלה נכשלות כשהגודל של כל ה-threads גדול מדי והמערכת לא יכולה לטפל בהם. אם גודל השרשור לא ידוע, ויכול להיות שהוא גדול מאוד, צריך להשתמש ב-getThreads(start, max) ולציין טווחים של השרשורים שרוצים לאחזר בכל קריאה. 

// Log the subject lines of the threads labeled with MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = label.getThreads();
for (let 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
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = label.getThreads(0, 30);
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

פרמטרים

שםסוגתיאור
startIntegerהאינדקס של השרשור ההתחלתי.
maxIntegerהמספר המקסימלי של השרשור שיש להחזיר.

חזרה

GmailThread[] — מערך של שרשורים שמסומנים בתווית הזו.

אישור

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

  • https://mail.google.com/

getUnreadCount()

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

// log the number of unread threads labeled with MyLabel
const 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
const label = GmailApp.getUserLabelByName('MyLabel');
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
label.removeFromThread(firstThread);

פרמטרים

שםסוגתיאור
threadGmailThreadהשרשור לא יסומן.

חזרה

GmailLabel — התווית הזו, לשרשור.

אישור

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

  • https://mail.google.com/

ראה גם

removeFromThreads(threads)

הסרת התווית הזו מהשרשורים הנתונים ואילץ את השרשור לרענן. אפשר להסיר תוויות מעד 100 שרשורים בכל קבוצה. 

// remove the label MyLabel from the first three threads in the inbox
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = GmailApp.getInboxThreads(0, 3);
label.removeFromThreads(threads);

פרמטרים

שםסוגתיאור
threadsGmailThread[]מערך של שרשורים שרוצים להסיר מהם את התווית.

חזרה

GmailLabel — התווית הזו, לשרשור.

אישור

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

  • https://mail.google.com/

ראה גם