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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 — התווית הזו, לשרשור.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

  • https://mail.google.com/

ראה גם


deleteLabel()

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

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

מקפיצה את הודעות השגיאה (Throws)

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

  • https://mail.google.com/

ראה גם


getId()

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

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

חזרה

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

  • https://mail.google.com/

getName()

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

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

חזרה

String – שם התווית.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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[] — מערך של שרשורים שסומנו בתווית הזו.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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[] — מערך של שרשורים שסומנו בתווית הזו.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 — מספר השרשורים עם התווית שלא נקראו.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 — התווית הזו, לשרשור.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 — התווית הזו, לשרשור.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

  • https://mail.google.com/

ראה גם