Class GmailLabel

GmailLabel

تصنيف أنشأه المستخدم في حساب مستخدم على Gmail.

الطُرق

الطريقةنوع الإرجاعوصف قصير
addToThread(thread)GmailLabelيضيف هذا التصنيف إلى سلسلة المحادثات المحدَّدة وفرض إعادة تحميل سلسلة المحادثات (GmailThread.refresh()).
addToThreads(threads)GmailLabelيؤدي هذا الإجراء إلى إضافة هذا التصنيف إلى سلاسل المحادثات المحدّدة وفرض إعادة تحميل سلاسل المحادثات.
deleteLabel()voidيؤدي هذا الإجراء إلى حذف هذا التصنيف.
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
var label = GmailApp.getUserLabelByName("MyLabel");
var firstThread = GmailApp.getInboxThreads(0,1)[0];
label.addToThread(firstThread);

المعلمات

الاسمالنوعالوصف
threadGmailThreadسلسلة المحادثات المطلوب تصنيفها.

الإرجاع

GmailLabel — هذا التصنيف للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

انظر أيضًا


addToThreads(threads)

يؤدي هذا الإجراء إلى إضافة هذا التصنيف إلى سلاسل المحادثات المحدّدة وفرض إعادة تحميل سلاسل المحادثات. يمكنك إضافة تصنيفات ما يصل إلى 100 سلسلة محادثات لكل دُفعة.

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

المعلمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات المطلوب تصنيفها.

الإرجاع

GmailLabel — هذا التصنيف للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

انظر أيضًا


deleteLabel()

يؤدي هذا الإجراء إلى حذف هذا التصنيف.

var label = GmailApp.getUserLabelByName("MyLabel");
label.deleteLabel();

الرميات

Error: إذا تعذّر حذف التصنيف

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

انظر أيضًا


getName()

يحصل على اسم هذا التصنيف.

var label = GmailApp.getUserLabelByName("MyLabel");
Logger.log(label.getName()); //logs MyLabel

الإرجاع

String — اسم التصنيف.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

getThreads()

جلب سلاسل المحادثات التي تم وضع علامة هذا التصنيف عليها

يتعذّر على النظام معالجة هذه الطلبات عندما يكون حجم جميع سلاسل المحادثات كبيرًا جدًا. أين حجم سلسلة المحادثات غير معروف، وربما يكون كبيرًا جدًا، يُرجى استخدام getThreads(start, max) وتحديد نطاقات سلاسل المحادثات المطلوب استردادها في كل استدعاء.

// Log the subject lines of the threads labeled with MyLabel
var label = GmailApp.getUserLabelByName("MyLabel");
var threads = label.getThreads();
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

الإرجاع

GmailThread[] — مصفوفة من سلاسل المحادثات التي تم وضع علامة هذا التصنيف عليها.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

getThreads(start, max)

الحصول على مجموعة من سلاسل المحادثات التي تم وضع علامة هذا التصنيف عليها

// log the subject lines of up to the first 30 threads with the label MyLabel
var label = GmailApp.getUserLabelByName("MyLabel");
var threads = label.getThreads(0, 30);
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

المعلمات

الاسمالنوعالوصف
startIntegerفهرس سلسلة التعليمات الأولى
maxIntegerالحد الأقصى لعدد سلاسل المحادثات المطلوب عرضها.

الإرجاع

GmailThread[] — مصفوفة من سلاسل المحادثات التي تم وضع علامة هذا التصنيف عليها.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

getUnreadCount()

الحصول على عدد سلاسل المحادثات غير المقروءة التي تم وضع علامة عليها باستخدام هذا التصنيف

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

الإرجاع

Integer — عدد سلاسل المحادثات المصنّفة غير المقروءة

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

removeFromThread(thread)

يؤدي هذا الإجراء إلى إزالة هذا التصنيف من سلسلة المحادثات المحدّدة وفرض إعادة تحميل سلسلة المحادثات.

// remove the label MyLabel from the first thread in the inbox
var label = GmailApp.getUserLabelByName("MyLabel");
var firstThread = GmailApp.getInboxThreads(0,1)[0];
label.removeFromThread(firstThread);

المعلمات

الاسمالنوعالوصف
threadGmailThreadستكون سلسلة المحادثات غير مُصنَّفة.

الإرجاع

GmailLabel — هذا التصنيف للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

انظر أيضًا


removeFromThreads(threads)

يؤدي هذا الإجراء إلى إزالة هذا التصنيف من سلاسل المحادثات المحدّدة وفرض إعادة تحميل سلاسل المحادثات. يمكنك إزالة ما يصل إلى 100 سلسلة محادثات لكل مجموعة.

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

المعلمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات المطلوب إلغاء تصنيفها.

الإرجاع

GmailLabel — هذا التصنيف للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

انظر أيضًا