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 — في حال تعذُّر حذف التصنيف&#39،

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات 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/

راجع أيضًا