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

المَعلمات

الاسمTypeالوصف
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);

المَعلمات

الاسمTypeالوصف
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());
}

المَعلمات

الاسمTypeالوصف
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);

المَعلمات

الاسمTypeالوصف
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);

المَعلمات

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

استرجاع الكرة

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

التفويض

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

  • https://mail.google.com/

يمكن أيضًا مراجعة