Class GmailLabel

GmailLabel

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

روش ها

روش نوع برگشت شرح مختصر
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);

پارامترها

نام تایپ کنید توضیحات
thread GmailThread موضوعی که باید برچسب گذاری شود.

بازگشت

GmailLabel - این برچسب برای زنجیر کردن.

مجوز

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

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

پارامترها

نام تایپ کنید توضیحات
threads GmailThread[] آرایه ای از رشته ها که باید برچسب گذاری شوند.

بازگشت

GmailLabel - این برچسب برای زنجیر کردن.

مجوز

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

  • https://mail.google.com/

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

deleteLabel()

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

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

پرتاب می کند

Error - اگر برچسب را نمی توان حذف کرد

مجوز

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

  • https://mail.google.com/

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

getId()

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

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)

این برچسب را از رشته داده شده حذف می کند و موضوع را مجبور به تازه کردن می کند.

// 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 GmailThread موضوع بدون برچسب باشد.

بازگشت

GmailLabel - این برچسب برای زنجیر کردن.

مجوز

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

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

پارامترها

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

بازگشت

GmailLabel - این برچسب برای زنجیر کردن.

مجوز

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

  • https://mail.google.com/

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