Class GmailLabel

GmailLabel

تصنيف أنشأه المستخدم في حساب 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);

المَعلمات

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

الإرجاع

GmailLabel — هذا التصنيف، من أجل الربط

التفويض

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

• https://mail.google.com/

انظر أيضًا

• removeFromThread(thread)

---

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

المَعلمات

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

الإرجاع

GmailLabel — هذا التصنيف، من أجل الربط

التفويض

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

• https://mail.google.com/

انظر أيضًا

• removeFromThreads(threads)

---

deleteLabel()

تحذف هذه الطريقة هذا التصنيف.

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

عمليات الطرح

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

التفويض

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

• https://mail.google.com/

انظر أيضًا

• getName()

---

getId()

تحصل هذه الطريقة على رقم تعريف هذا التصنيف.

const label = GmailApp.getUserLabelByName('MyLabel');
console.log(label.getId());

الإرجاع

String — رقم تعريف التصنيف

التفويض

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

• https://mail.google.com/

---

getName()

تحصل هذه الطريقة على اسم هذا التصنيف.

const label = GmailApp.getUserLabelByName('MyLabel');
Logger.log(label.getName());  // logs MyLabel

الإرجاع

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

التفويض

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

التفويض

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

المَعلمات

الاسم	النوع	الوصف
start	Integer	فهرس سلسلة المحادثات الأولية
max	Integer	الحد الأقصى لعدد سلاسل المحادثات المطلوب عرضها

الإرجاع

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

التفويض

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

التفويض

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

المَعلمات

الاسم	النوع	الوصف
thread	GmailThread	سلسلة المحادثات المطلوب إزالة التصنيف منها

الإرجاع

GmailLabel — هذا التصنيف، من أجل الربط

التفويض

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

• https://mail.google.com/

انظر أيضًا

• addToThread(thread)

---

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

المَعلمات

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

الإرجاع

GmailLabel — هذا التصنيف، من أجل الربط

التفويض

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

• https://mail.google.com/

انظر أيضًا

• addToThreads(threads)