این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Class GmailLabel

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

روش ها

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

مستندات دقیق

`add To Thread(thread)`

این برچسب را به رشته داده شده اضافه می کند و رشته را مجبور می کند تا به روز شود ( Gmail Thread.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`	موضوعی که باید برچسب گذاری شود.

بازگشت

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

مجوز

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

https://mail.google.com/

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

remove From Thread(thread)

`add To Threads(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`	`Gmail Thread[]`	آرایه ای از رشته ها که باید برچسب گذاری شوند.

بازگشت

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

مجوز

https://mail.google.com/

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

remove From Threads(threads)

`delete Label()`

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

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

پرتاب می کند

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

مجوز

https://mail.google.com/

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

get Name()

`get Name()`

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

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

بازگشت

String - نام برچسب.

مجوز

https://mail.google.com/

`get Threads()`

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

این فراخوانی زمانی انجام نمی شود که اندازه همه رشته ها برای سیستم بسیار بزرگ باشد. در جایی که اندازه رشته ناشناخته است، و احتمالاً بسیار بزرگ است، لطفاً از get Threads(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());
}

بازگشت

Gmail Thread[] - آرایه‌ای از رشته‌هایی که با این برچسب مشخص شده‌اند.

مجوز

https://mail.google.com/

`get Threads(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`	حداکثر تعداد موضوعات برای بازگشت.

بازگشت

Gmail Thread[] - آرایه‌ای از رشته‌هایی که با این برچسب مشخص شده‌اند.

مجوز

https://mail.google.com/

`get Unread Count()`

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

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

بازگشت

Integer - تعداد رشته های برچسب دار خوانده نشده.

مجوز

https://mail.google.com/

`remove From Thread(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`	`Gmail Thread`	موضوع بدون برچسب باشد.

بازگشت

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

مجوز

https://mail.google.com/

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

add To Thread(thread)

`remove From Threads(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`	`Gmail Thread[]`	آرایه‌ای از رشته‌ها که باید برچسب‌گذاری نشده باشند.

بازگشت

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

مجوز

https://mail.google.com/

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

add To Threads(threads)