Class GmailLabel

Gmailالتصنيف

تصنيف أنشأه المستخدم في حساب 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
const label = GmailApp.getUserLabelByName('MyLabel');
const 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
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = GmailApp.getInboxThreads(0, 3);
label.addToThreads(threads);

المعلَمات

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

الإرجاع

GmailLabel: هذا التصنيف مخصّص لإنشاء سلاسل.

التفويض

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

  • https://mail.google.com/

انظر أيضًا

deleteLabel()

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

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

عمليات الرمي

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

التفويض

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

  • https://mail.google.com/

انظر أيضًا

getName()

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

const 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
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = label.getThreads();
for (let 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
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[]: مصفوفة من سلاسل المحادثات التي تم وضع هذا التصنيف عليها

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات 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: عدد سلاسل المحادثات المُصنَّفة وغير المقروءة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات 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: هذا التصنيف مخصّص لإنشاء سلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات 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: هذا التصنيف مخصّص لإنشاء سلاسل.

التفويض

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

  • https://mail.google.com/

انظر أيضًا