Class GmailLabel

برچسب جیمیل

برچسبی که توسط کاربر در حساب جیمیل او ایجاد شده است.

روش‌ها

روش نوع بازگشتی شرح مختصر
add To Thread(thread) Gmail Label این برچسب را به رشته داده شده اضافه می‌کند و رشته را مجبور به رفرش (Refresh Gmail Thread.refresh() ) می‌کند.
add To Threads(threads) Gmail Label این برچسب را به رشته‌های داده شده اضافه می‌کند و رشته‌ها را مجبور به رفرش (refresh) می‌کند.
delete Label() void این برچسب را حذف می‌کند.
get Id() String شناسه (id) این برچسب را دریافت می‌کند.
get Name() String نام این برچسب را دریافت می‌کند.
get Threads() Gmail Thread[] رشته‌هایی را که با این برچسب علامت‌گذاری شده‌اند، برمی‌گرداند.
get Threads(start, max) Gmail Thread[] طیفی از رشته‌های مشخص‌شده با این برچسب را دریافت می‌کند.
get Unread Count() Integer تعداد تاپیک‌های خوانده نشده‌ای که با این برچسب برچسب‌گذاری شده‌اند را برمی‌گرداند.
remove From Thread(thread) Gmail Label این برچسب را از رشته داده شده حذف می‌کند و رشته را مجبور به رفرش (refresh) می‌کند.
remove From Threads(threads) Gmail Label این برچسب را از رشته‌های داده شده حذف می‌کند و رشته‌ها را مجبور به رفرش می‌کند.

مستندات دقیق

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

پارامترها

نام نوع توضیحات
thread Gmail Thread نخی که قرار است برچسب‌گذاری شود.

بازگشت

GmailLabel — این برچسب، برای زنجیره‌سازی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

  • https://mail.google.com/

همچنین ببینید


addToThreads(threads)

این برچسب را به رشته‌های داده شده اضافه می‌کند و رشته‌ها را مجبور به رفرش می‌کند. می‌توانید برای هر دسته تا ۱۰۰ رشته برچسب اضافه کنید.

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

پارامترها

نام نوع توضیحات
threads Gmail Thread[] آرایه‌ای از نخ‌ها که باید برچسب‌گذاری شوند.

بازگشت

GmailLabel — این برچسب، برای زنجیره‌سازی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

  • https://mail.google.com/

همچنین ببینید


deleteLabel()

این برچسب را حذف می‌کند.

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

پرتاب‌ها

Error — اگر برچسب قابل حذف نباشد

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

  • https://mail.google.com/

همچنین ببینید


getId()

شناسه (id) این برچسب را دریافت می‌کند.

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

بازگشت

String - شناسه برچسب.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

  • https://mail.google.com/

getName()

نام این برچسب را دریافت می‌کند.

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

بازگشت

String - نام برچسب.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

  • https://mail.google.com/

getThreads()

رشته‌هایی را که با این برچسب علامت‌گذاری شده‌اند، برمی‌گرداند.

این فراخوانی‌ها زمانی که اندازه همه نخ‌ها برای سیستم بسیار بزرگ باشد، با شکست مواجه می‌شوند. در جایی که اندازه نخ ناشناخته است و احتمالاً بسیار بزرگ است، لطفاً 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[] — آرایه‌ای از رشته‌های مشخص‌شده با این برچسب.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

  • 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());
}

پارامترها

نام نوع توضیحات
start Integer فهرست رشته‌ی آغازین.
max Integer حداکثر تعداد نخ‌هایی که باید برگردانده شوند.

بازگشت

GmailThread[] — آرایه‌ای از رشته‌های مشخص‌شده با این برچسب.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

  • https://mail.google.com/

getUnreadCount()

تعداد تاپیک‌های خوانده نشده‌ای که با این برچسب برچسب‌گذاری شده‌اند را برمی‌گرداند.

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

بازگشت

Integer — تعداد رشته‌های برچسب‌گذاری‌شده‌ی خوانده‌نشده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

  • https://mail.google.com/

removeFromThread(thread)

این برچسب را از رشته داده شده حذف می‌کند و رشته را مجبور به رفرش (refresh) می‌کند.

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

پارامترها

نام نوع توضیحات
thread Gmail Thread تاپیک بدون برچسب باشد.

بازگشت

GmailLabel — این برچسب، برای زنجیره‌سازی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

  • https://mail.google.com/

همچنین ببینید


removeFromThreads(threads)

این برچسب را از رشته‌های داده شده حذف می‌کند و رشته‌ها را مجبور به رفرش می‌کند. می‌توانید برچسب‌ها را تا سقف ۱۰۰ رشته در هر دسته حذف کنید.

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

پارامترها

نام نوع توضیحات
threads Gmail Thread[] آرایه‌ای از رشته‌ها که باید بدون برچسب باشند.

بازگشت

GmailLabel — این برچسب، برای زنجیره‌سازی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

  • https://mail.google.com/

همچنین ببینید