Class GmailLabel

تصنيفGmail

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

الطُرق

الطريقةنوع القيمة التي يتم إرجاعهاوصف قصير
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);

المعلمات

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

الإرجاع

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

المعلمات

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

الإرجاع

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

المعلمات

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

الإرجاع

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

المعلمات

الاسمالنوعالوصف
threadGmailThreadسيتم إزالة التصنيف من سلسلة المحادثات.

الإرجاع

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

المعلمات

الاسمالنوعالوصف
threadsGmailThread[]صفيف من سلاسل المحادثات التي سيتم إزالة تصنيفها

الإرجاع

GmailLabel: هذا التصنيف مخصّص للربط.

التفويض

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

  • https://mail.google.com/

انظر أيضًا