تتيح الوصول إلى سلاسل محادثات Gmail ورسائله وتصنيفاته.
الطُرق
| الطريقة | نوع القيمة التي تم إرجاعها | وصف قصير |
|---|---|---|
create | Gmail | تنشئ هذه الطريقة مسودة رسالة إلكترونية. |
create | Gmail | تنشئ هذه الطريقة مسودّة رسالة إلكترونية مع وسيطات اختيارية. |
create | Gmail | إنشاء تصنيف مستخدم جديد بالاسم المحدّد |
delete | Gmail | لحذف التصنيف المحدّد |
get | String[] | تعرض هذه الطريقة قائمة بعناوين البريد الإلكتروني التي تم إعدادها كعناوين بديلة لهذا الحساب في Gmail. |
get | Gmail | استرداد مسودة رسالة إلكترونية حسب رقم التعريف |
get | Gmail | تعرض هذه الطريقة جميع مسودات الرسائل. |
get | Gmail | تعرض هذه الطريقة جميع مسودات الرسائل في Gmail. |
get | Gmail | يستردّ جميع سلاسل المحادثات في "صندوق الوارد" بغض النظر عن التصنيفات. |
get | Gmail | يستردّ هذا الإجراء نطاقًا من سلاسل المحادثات في البريد الوارد بغض النظر عن التصنيفات. |
get | Integer | تعرض هذه الطريقة عدد سلاسل المحادثات غير المقروءة في البريد الوارد. |
get | Gmail | تعرض هذه الطريقة رسالة حسب رقم تعريفها. |
get | Gmail | استرداد جميع الرسائل في سلسلة المحادثات المحدّدة |
get | Gmail | استرداد جميع الرسائل في سلاسل المحادثات المحدّدة |
get | Gmail | يستردّ هذا الإجراء جميع سلاسل المحادثات في "البريد الوارد المهم" بغض النظر عن التصنيفات. |
get | Gmail | يسترد هذا الإجراء مجموعة من سلاسل المحادثات في "البريد الهام" بغض النظر عن التصنيفات. |
get | Integer | تعرض هذه الدالة عدد سلاسل المحادثات غير المقروءة في "البريد الوارد المهم". |
get | Gmail | يستردّ جميع سلاسل المحادثات غير المرغوب فيها بغض النظر عن التصنيفات. |
get | Gmail | تسترد هذه الطريقة نطاقًا من سلاسل المحادثات غير المرغوب فيها بغض النظر عن التصنيفات. |
get | Integer | تعرض هذه الطريقة عدد سلاسل المحادثات غير المقروءة التي تم تصنيفها كرسائل غير مرغوب فيها. |
get | Gmail | تعرض هذه الطريقة جميع سلاسل المحادثات المميزة بنجمة بغض النظر عن التصنيفات. |
get | Gmail | يستردّ نطاقًا من سلاسل المحادثات المميّزة بنجمة بغض النظر عن التصنيفات. |
get | Integer | تعرض هذه الطريقة عدد سلاسل المحادثات غير المقروءة التي تم وضع نجمة عليها. |
get | Gmail | تعرض هذه الطريقة سلسلة محادثات حسب رقم التعريف. |
get | Gmail | يستردّ جميع سلاسل المحادثات في المهملات بغض النظر عن التصنيفات. |
get | Gmail | يستردّ هذا الإجراء نطاقًا من سلاسل المحادثات في المهملات بغض النظر عن التصنيفات. |
get | Gmail | تعرض هذه الطريقة تصنيفًا معيّنًا حسب اسم التصنيف. |
get | Gmail | تعرض هذه الطريقة قائمة بالتصنيفات التي أنشأها المستخدم. |
mark | Gmail | يضع علامة على هذه الرسالة بأنّها مقروءة ويفرض إعادة تحميلها. |
mark | Gmail | يضع علامة على هذه الرسالة بأنّها غير مقروءة ويفرض إعادة تحميلها. |
mark | Gmail | يضع علامة على هذه الرسائل بأنّها مقروءة ويفرض إعادة تحميلها. |
mark | Gmail | يضع علامة "غير مقروءة" على هذه الرسائل ويفرض إعادة تحميلها. |
mark | Gmail | يضع علامة "مهمة" على سلسلة المحادثات هذه ويفرض إعادة تحميلها. |
mark | Gmail | يضع علامة "مقروءة" على سلسلة المحادثات هذه ويفرض إعادة تحميلها. |
mark | Gmail | يضع علامة "غير مهمة" على سلسلة المحادثات هذه ويفرض إعادة تحميلها. |
mark | Gmail | يضع علامة "غير مقروءة" على سلسلة المحادثات هذه ويفرض إعادة تحميلها. |
mark | Gmail | يضع علامة "مهمة" على سلاسل المحادثات هذه ويفرض إعادة تحميلها. |
mark | Gmail | يضع علامة "مقروءة" على سلاسل المحادثات هذه ويفرض إعادة تحميلها. |
mark | Gmail | يضع علامة "غير مهمة" على سلاسل المحادثات هذه ويفرض إعادة تحميلها. |
mark | Gmail | يضع علامة "غير مقروءة" على سلاسل المحادثات هذه ويفرض إعادة تحميلها. |
move | Gmail | ينقل الرسالة إلى المهملات ويفرض إعادة تحميلها. |
move | Gmail | ينقل الرسائل المحدّدة إلى المهملات ويفرض إعادة تحميل الرسائل. |
move | Gmail | ينقل سلسلة المحادثات هذه إلى الأرشيف ويفرض إعادة تحميلها. |
move | Gmail | ينقل سلسلة المحادثات هذه إلى البريد الوارد ويفرض إعادة تحميلها. |
move | Gmail | ينقل سلسلة المحادثات هذه إلى مجلد "المحادثات غير المرغوب فيها" ويفرض إعادة تحميلها. |
move | Gmail | ينقل سلسلة المحادثات هذه إلى المهملات ويفرض إعادة تحميلها. |
move | Gmail | ينقل سلاسل المحادثات هذه إلى الأرشيف ويفرض إعادة تحميلها. |
move | Gmail | ينقل سلاسل المحادثات هذه إلى البريد الوارد ويفرض إعادة تحميلها. |
move | Gmail | تنقل هذه السلاسل إلى مجلد الرسائل غير المرغوب فيها وتفرض إعادة تحميلها. |
move | Gmail | ينقل سلاسل المحادثات هذه إلى المهملات ويفرض إعادة تحميلها. |
refresh | Gmail | تعيد تحميل الرسالة والحالة المرتبطة بها من Gmail (مفيدة في حال تغيّر التصنيفات أو حالة القراءة أو غير ذلك). |
refresh | Gmail | تعيد تحميل الرسائل والحالة المرتبطة بها من Gmail (مفيدة في حال تغيّر التصنيفات أو حالة القراءة أو غير ذلك). |
refresh | Gmail | تعيد تحميل سلسلة المحادثات والحالة المرتبطة بها من Gmail (مفيدة في حال تغيّرت التصنيفات أو حالة القراءة أو غير ذلك). |
refresh | Gmail | إعادة تحميل سلاسل المحادثات والحالة المرتبطة بها من Gmail (مفيدة في حال تغيّر التصنيفات أو حالة القراءة أو غير ذلك). |
search(query) | Gmail | البحث في Gmail باستخدام طلب البحث المحدّد |
search(query, start, max) | Gmail | البحث في Gmail باستخدام طلب البحث المحدّد |
send | Gmail | يرسِل رسالة إلكترونية. |
send | Gmail | يرسل رسالة إلكترونية تتضمّن وسيطات اختيارية. |
set | void | تضبط رمز الدخول إلى الرسالة الحالية الذي يتيح للبرنامج النصي الوصول إلى خصائص Gmail الحالية. |
star | Gmail | يضيف نجمة إلى هذه الرسالة ويفرض إعادة تحميلها. |
star | Gmail | يضيف نجومًا إلى هذه الرسائل ويفرض إعادة تحميلها. |
unstar | Gmail | يزيل نجمة من هذه الرسالة ويفرض إعادة تحميلها. |
unstar | Gmail | تتم إزالة النجوم من هذه الرسائل وإعادة تحميلها. |
مستندات تفصيلية
createDraft(recipient, subject, body)
تنشئ هذه الطريقة مسودة رسالة إلكترونية. يتم تحديد الحصة لحجم الرسالة الإلكترونية (بما في ذلك العناوين).
// The code below creates a draft email with the current date and time. const now = new Date(); GmailApp.createDraft( 'mike@example.com', 'current time', `The time is: ${now.toString()}`, );
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
recipient | String | قائمة بعناوين البريد الإلكتروني مفصولة بفواصل |
subject | String | موضوع الرسالة الإلكترونية |
body | String | نص الرسالة الإلكترونية |
الإرجاع
GmailDraft: مسودة Gmail التي تم إنشاؤها حديثًا
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
createDraft(recipient, subject, body, options)
تنشئ هذه الطريقة مسودّة رسالة إلكترونية مع وسيطات اختيارية. يمكن أن تحتوي الرسالة الإلكترونية على نص عادي أو نص HTML. يخضع حجم الرسالة الإلكترونية (بما في ذلك العناوين، ولكن باستثناء المرفقات) لحد أقصى.
// Create a draft email with a file from Google Drive attached as a PDF. const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz'); GmailApp.createDraft( 'mike@example.com', 'Attachment example', 'Please see attached file.', { attachments: [file.getAs(MimeType.PDF)], name: 'Automatic Emailer Script', }, );
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
recipient | String | عناوين المستلِم |
subject | String | سطر الموضوع |
body | String | نص الرسالة الإلكترونية |
options | Object | كائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه |
المعلمات المتقدمة
| الاسم | النوع | الوصف |
|---|---|---|
attachments | Blob | مصفوفة من الملفات المراد إرسالها مع الرسالة الإلكترونية |
bcc | String | قائمة قيم مفصولة بفاصلة لعناوين البريد الإلكتروني التي سيتم إرسال نسخة مخفية الوجهة إليها |
cc | String | قائمة قيم مفصولة بفاصلة لعناوين البريد الإلكتروني التي يجب تضمينها في السطر "نسخة إلى" |
from | String | عنوان البريد الإلكتروني الذي يجب إرسال الرسالة منه، ويجب أن يكون إحدى القيم التي تعرضها الدالة get |
html | String | في حال ضبط هذا الحقل، ستستخدم الأجهزة التي يمكنها عرض HTML هذا الحقل بدلاً من وسيطة النص الأساسي المطلوبة. يمكنك إضافة حقل inline اختياري في النص الأساسي لـ HTML إذا كانت لديك صور مضمّنة في رسالتك الإلكترونية. |
inline | Object | كائن JavaScript يحتوي على ربط من مفتاح الصورة
(String) إلى بيانات الصورة (Blob)، وهذا يفترض أنّه يتم استخدام المَعلمة html وأنّها تحتوي على مراجع إلى هذه الصور بالتنسيق <img src="cid:imageKey" /> |
name | String | اسم مرسل الرسالة الإلكترونية (القيمة التلقائية: اسم المستخدم) |
reply | String | عنوان بريد إلكتروني لاستخدامه كعنوان الردّ التلقائي (القيمة التلقائية: عنوان البريد الإلكتروني للمستخدم) |
الإرجاع
GmailDraft: مسودة Gmail التي تم إنشاؤها حديثًا
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
createLabel(name)
إنشاء تصنيف مستخدم جديد بالاسم المحدّد
// Creates the label @FOO and logs label: FOO Logger.log(`label: ${GmailApp.createLabel('FOO')}`);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
name | String | اسم التصنيف الجديد |
الإرجاع
GmailLabel: التصنيف الذي تم إنشاؤه حديثًا
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
deleteLabel(label)
لحذف التصنيف المحدّد
// Have to get the label by name first const label = GmailApp.getUserLabelByName('FOO'); GmailApp.deleteLabel(label);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
label | Gmail | التصنيف المطلوب حذفه |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
getAliases()
تعرض هذه الطريقة قائمة بعناوين البريد الإلكتروني التي تم إعدادها كعناوين بديلة لهذا الحساب في Gmail.
يمكنك إرسال رسالة من أي من هذه الأسماء المستعارة باستخدام الوسيط الاختياري "من".
// Log the aliases for this Gmail account and send an email as the first one. const me = Session.getActiveUser().getEmail(); const aliases = GmailApp.getAliases(); Logger.log(aliases); if (aliases.length > 0) { GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', { from: aliases[0], }); } else { GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.'); }
الإرجاع
String[]: مصفوفة من الأسماء المستعارة لهذا الحساب
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
getDraft(draftId)
استرداد مسودة رسالة إلكترونية حسب رقم التعريف
استخدِم هذه الطريقة مع getId() في مسودات Gmail.
// Get the first draft message in your drafts folder const draft = GmailApp.getDrafts()[0]; // Get its ID const draftId = draft.getId(); // Now fetch the same draft using that ID. const draftById = GmailApp.getDraft(draftId); // Should always log true as they should be the same message Logger.log( draft.getMessage().getSubject() === draftById.getMessage().getSubject(), );
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
draft | String | معرّف المسودة المطلوب استردادها |
الإرجاع
GmailDraft: المسودة التي تحمل رقم التعريف المحدّد
عمليات الطرح
Error: في حال تعذّر العثور على مسودة بالمعرّف المحدّد
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getDraftMessages()
تعرض هذه الطريقة جميع مسودات الرسائل.
// Logs the number of draft messages const drafts = GmailApp.getDraftMessages(); Logger.log(drafts.length);
الإرجاع
GmailMessage[]: مصفوفة من مسودات رسائل Gmail
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getDrafts()
تعرض هذه الطريقة جميع مسودات الرسائل في Gmail.
const drafts = GmailApp.getDrafts(); for (let i = 0; i < drafts.length; i++) { Logger.log(drafts[i].getId()); }
الإرجاع
GmailDraft[]: مصفوفة من مسودات رسائل Gmail
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getInboxThreads()
يستردّ جميع سلاسل المحادثات في "صندوق الوارد" بغض النظر عن التصنيفات.
سيتعذّر تنفيذ هذه العملية عندما يكون حجم جميع سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام التعامل معه. في حال كان حجم سلسلة المحادثات غير معروف، ومن المحتمل أن يكون كبيرًا جدًا، يُرجى استخدام طلب "صفحات"، وتحديد نطاقات سلاسل المحادثات التي سيتم استردادها في كل طلب.
// Log the subject lines of your Inbox const threads = GmailApp.getInboxThreads(); for (let i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); }
الإرجاع
GmailThread[]: مصفوفة من سلاسل رسائل Gmail في البريد الوارد
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getInboxThreads(start, max)
يستردّ هذا الإجراء نطاقًا من سلاسل المحادثات في البريد الوارد بغض النظر عن التصنيفات.
// Log the subject lines of up to the first 50 emails in your Inbox const threads = GmailApp.getInboxThreads(0, 50); for (let i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); }
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
start | Integer | فهرس سلسلة المحادثات الأولى المطلوب استردادها |
max | Integer | الحد الأقصى لعدد سلاسل المحادثات المطلوب استردادها |
الإرجاع
GmailThread[]: مصفوفة من سلاسل رسائل Gmail في البريد الوارد
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getInboxUnreadCount()
تعرض هذه الطريقة عدد سلاسل المحادثات غير المقروءة في البريد الوارد.
Logger.log(`Messages unread in inbox: ${GmailApp.getInboxUnreadCount()}`);
الإرجاع
Integer: عدد سلاسل المحادثات في البريد الوارد التي تتضمّن رسائل غير مقروءة
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getMessageById(id)
تعرض هذه الطريقة رسالة حسب رقم تعريفها.
استخدِم هذه السمة مع getId() في رسائل Gmail.
// Get the first message in the first thread of your inbox const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; // Get its ID const messageId = message.getId(); // Now fetch the same message using that ID. const messageById = GmailApp.getMessageById(messageId); // Should always log true as they should be the same message Logger.log(message.getSubject() === messageById.getSubject());
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
id | String | رقم تعريف الرسالة المطلوب استردادها |
الإرجاع
GmailMessage: الرسالة التي تحمل المعرّف المحدّد
عمليات الطرح
Error: في حال تعذّر العثور على أي رسالة بالمعرّف المحدّد
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
getMessagesForThread(thread)
استرداد جميع الرسائل في سلسلة المحادثات المحدّدة
// Log all the subject lines in the first thread of your inbox const thread = GmailApp.getInboxThreads(0, 1)[0]; const messages = GmailApp.getMessagesForThread(thread); for (let i = 0; i < messages.length; i++) { Logger.log(`subject: ${messages[i].getSubject()}`); }
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
thread | Gmail | سلسلة الرسائل المطلوب استردادها |
الإرجاع
GmailMessage[]: مصفوفة من الرسائل المرتبطة بسلسلة المحادثات هذه
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
getMessagesForThreads(threads)
استرداد جميع الرسائل في سلاسل المحادثات المحدّدة
// Log the subject lines of all messages in the first two threads of your inbox const thread = GmailApp.getInboxThreads(0, 2); const messages = GmailApp.getMessagesForThreads(thread); for (let i = 0; i < messages.length; i++) { for (let j = 0; j < messages[i].length; j++) { Logger.log(`subject: ${messages[i][j].getSubject()}`); } }
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
threads | Gmail | سلاسل الرسائل المطلوب استردادها |
الإرجاع
GmailMessage[][]: مصفوفة من مصفوفات الرسائل، حيث يتوافق كل عنصر في المصفوفة الخارجية مع سلسلة محادثات، وتحتوي المصفوفة الداخلية على الرسائل في سلسلة المحادثات هذه
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
getPriorityInboxThreads()
يستردّ هذا الإجراء جميع سلاسل المحادثات في "البريد الوارد المهم" بغض النظر عن التصنيفات.
سيتعذّر تنفيذ هذه العملية عندما يكون حجم جميع سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام التعامل معه. في حال كان حجم سلسلة المحادثات غير معروف، ومن المحتمل أن يكون كبيرًا جدًا، يُرجى استخدام طلب "صفحات"، وتحديد نطاقات سلاسل المحادثات التي سيتم استردادها في كل طلب.
Logger.log( `# of messages in your Priority Inbox: ${ GmailApp.getPriorityInboxThreads().length}`, );
الإرجاع
GmailThread[]: مصفوفة سلاسل محادثات Gmail في "البريد الهام"
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getPriorityInboxThreads(start, max)
يسترد هذا الإجراء مجموعة من سلاسل المحادثات في "البريد الهام" بغض النظر عن التصنيفات.
// Will log some number 2 or less Logger.log( `# of messages in your Priority Inbox: ${ GmailApp.getPriorityInboxThreads(0, 2).length}`, );
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
start | Integer | فهرس سلسلة المحادثات الأولى المطلوب استردادها |
max | Integer | الحد الأقصى لعدد سلاسل المحادثات المطلوب استردادها |
الإرجاع
GmailThread[]: مصفوفة سلاسل محادثات Gmail في "البريد الهام"
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getPriorityInboxUnreadCount()
تعرض هذه الدالة عدد سلاسل المحادثات غير المقروءة في "البريد الوارد المهم".
Logger.log( `Number of unread emails in your Priority Inbox : ${ GmailApp.getPriorityInboxUnreadCount()}`, );
الإرجاع
Integer: عدد سلاسل المحادثات في "البريد الوارد المهم" التي تتضمّن رسائل غير مقروءة
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getSpamThreads()
يستردّ جميع سلاسل المحادثات غير المرغوب فيها بغض النظر عن التصنيفات.
سيتعذّر تنفيذ هذه العملية عندما يكون حجم جميع سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام التعامل معه. في حال كان حجم سلسلة المحادثات غير معروف، ومن المحتمل أن يكون كبيرًا جدًا، يُرجى استخدام طلب "صفحات"، وتحديد نطاقات سلاسل المحادثات التي سيتم استردادها في كل طلب.
Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads().length}`);
الإرجاع
GmailThread[]: مصفوفة من سلاسل المحادثات في Gmail في مجلد الرسائل غير المرغوب فيها
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getSpamThreads(start, max)
تسترد هذه الطريقة نطاقًا من سلاسل المحادثات غير المرغوب فيها بغض النظر عن التصنيفات.
// Will log a number at most 5 Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads(0, 5).length}`);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
start | Integer | فهرس سلسلة المحادثات الأولى المطلوب استردادها |
max | Integer | الحد الأقصى لعدد سلاسل المحادثات المطلوب استردادها |
الإرجاع
GmailThread[]: مصفوفة من سلاسل المحادثات في Gmail في مجلد الرسائل غير المرغوب فيها
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getSpamUnreadCount()
تعرض هذه الطريقة عدد سلاسل المحادثات غير المقروءة التي تم تصنيفها كرسائل غير مرغوب فيها.
// Unless you actually read stuff in your spam folder, this should be the same // as the number of messages in your spam folder. Logger.log(`# unread threads that are spam: ${GmailApp.getSpamUnreadCount()}`);
الإرجاع
Integer: عدد سلاسل المحادثات غير المرغوب فيها التي تتضمّن رسائل غير مقروءة
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getStarredThreads()
تعرض هذه الطريقة جميع سلاسل المحادثات المميزة بنجمة بغض النظر عن التصنيفات.
سيتعذّر تنفيذ هذه العملية عندما يكون حجم جميع سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام التعامل معه. في حال كان حجم سلسلة المحادثات غير معروف، ومن المحتمل أن يكون كبيرًا جدًا، يُرجى استخدام طلب "صفحات"، وتحديد نطاقات سلاسل المحادثات التي سيتم استردادها في كل طلب.
// Logs the number of starred threads Logger.log(`# Starred threads: ${GmailApp.getStarredThreads().length}`);
الإرجاع
GmailThread[]: مصفوفة سلاسل محادثات Gmail المميزة بنجمة
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getStarredThreads(start, max)
يستردّ هذا الإجراء نطاقًا من سلاسل المحادثات المميّزة بنجمة بغض النظر عن التصنيفات.
// Logs the number of starred threads to a maximum of 5 Logger.log(`# Starred threads: ${GmailApp.getStarredThreads(0, 5).length}`);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
start | Integer | فهرس سلسلة المحادثات الأولى المطلوب استردادها |
max | Integer | الحد الأقصى لعدد سلاسل المحادثات المطلوب استردادها |
الإرجاع
GmailThread[]: مصفوفة سلاسل محادثات Gmail المميزة بنجمة
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getStarredUnreadCount()
تعرض هذه الطريقة عدد سلاسل المحادثات غير المقروءة التي تم وضع نجمة عليها.
Logger.log(`# unread and starred: ${GmailApp.getStarredUnreadCount()}`);
الإرجاع
Integer: عدد سلاسل المحادثات المميّزة بنجمة التي تتضمّن رسائل غير مقروءة
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getThreadById(id)
تعرض هذه الطريقة سلسلة محادثات حسب رقم التعريف.
استخدِم هذا الإجراء مع getId() في سلاسل محادثات Gmail.
// Gets the first inbox thread. const firstThread = GmailApp.getInboxThreads(0, 1)[0]; // Gets the same thread by ID. const threadById = GmailApp.getThreadById(firstThread.getId()); // Verifies that they are the same. console.log( firstThread.getFirstMessageSubject() === threadById.getFirstMessageSubject(), );
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
id | String | رقم تعريف سلسلة المحادثات المطلوب استردادها |
الإرجاع
GmailThread|null: سلسلة المحادثات التي تحمل رقم التعريف المحدّد أو null إذا لم يتم العثور عليها.
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
getTrashThreads()
يستردّ جميع سلاسل المحادثات في المهملات بغض النظر عن التصنيفات.
سيتعذّر تنفيذ هذه العملية عندما يكون حجم جميع سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام التعامل معه. في حال كان حجم سلسلة المحادثات غير معروف، ومن المحتمل أن يكون كبيرًا جدًا، يُرجى استخدام طلب "صفحات"، وتحديد نطاقات سلاسل المحادثات التي سيتم استردادها في كل طلب.
Logger.log(`# of total trash threads: ${GmailApp.getTrashThreads().length}`);
الإرجاع
GmailThread[]: مصفوفة من سلاسل محادثات Gmail في المهملات
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getTrashThreads(start, max)
يستردّ هذا الإجراء نطاقًا من سلاسل المحادثات في المهملات بغض النظر عن التصنيفات.
// Will log a number at most 5 Logger.log( `# of total trash threads: ${GmailApp.getTrashThreads(0, 5).length}`, );
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
start | Integer | فهرس سلسلة المحادثات الأولى المطلوب استردادها |
max | Integer | الحد الأقصى لعدد سلاسل المحادثات المطلوب استردادها |
الإرجاع
GmailThread[]: مصفوفة من سلاسل محادثات Gmail في المهملات
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getUserLabelByName(name)
تعرض هذه الطريقة تصنيفًا معيّنًا حسب اسم التصنيف.
const labelObject = GmailApp.getUserLabelByName('myLabel');
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
name | String | اسم التصنيف المطلوب استرداده |
الإرجاع
GmailLabel: تصنيف Gmail بالاسم المحدّد
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
getUserLabels()
تعرض هذه الطريقة قائمة بالتصنيفات التي أنشأها المستخدم.
// Logs all of the names of your labels const labels = GmailApp.getUserLabels(); for (let i = 0; i < labels.length; i++) { Logger.log(`label: ${labels[i].getName()}`); }
الإرجاع
GmailLabel[]: مصفوفة من التصنيفات التي أنشأها المستخدم
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
markMessageRead(message)
يضع علامة على هذه الرسالة بأنّها مقروءة ويفرض إعادة تحميلها.
// Mark the first message in the first thread of your inbox as read const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; GmailApp.markMessageRead(message);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
message | Gmail | الرسالة المطلوب وضع علامة "مقروءة" عليها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
markMessageUnread(message)
يضع علامة على هذه الرسالة بأنّها غير مقروءة ويفرض إعادة تحميلها.
// Mark the first message in the first thread of your inbox as unread const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; GmailApp.markMessageUnread(message);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
message | Gmail | الرسالة المطلوب وضع علامة "غير مقروءة" عليها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
markMessagesRead(messages)
يضع علامة على هذه الرسائل بأنّها مقروءة ويفرض إعادة تحميلها.
// Mark first three messages in the first inbox thread as read. // Assumes that the first inbox thread has 3 messages in it. const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages(); const messages = [threadMessages[0], threadMessages[1], threadMessages[2]]; GmailApp.markMessagesRead(messages);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
messages | Gmail | مصفوفة من الرسائل المطلوب وضع علامة "مقروءة" عليها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
markMessagesUnread(messages)
يضع علامة "غير مقروءة" على هذه الرسائل ويفرض إعادة تحميلها.
// Mark first three messages in the first inbox thread as unread. // Assumes that the first inbox thread has 3 messages in it const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages(); const messages = [threadMessages[0], threadMessages[1], threadMessages[2]]; GmailApp.markMessagesUnread(messages);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
messages | Gmail | مصفوفة من الرسائل المطلوب وضع علامة "غير مقروءة" عليها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
markThreadImportant(thread)
يضع علامة "مهمة" على سلسلة المحادثات هذه ويفرض إعادة تحميلها.
// Marks first inbox thread as important const thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadImportant(thread);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
thread | Gmail | سلسلة المحادثات التي تريد وضع علامة "مهمة" عليها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
markThreadRead(thread)
يضع علامة "مقروءة" على سلسلة المحادثات هذه ويفرض إعادة تحميلها.
// Marks first inbox thread as read const thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadRead(thread);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
thread | Gmail | سلسلة المحادثات المطلوب وضع علامة "مقروءة" عليها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
markThreadUnimportant(thread)
يضع علامة "غير مهمة" على سلسلة المحادثات هذه ويفرض إعادة تحميلها.
// Marks first inbox thread as unimportant const thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnimportant(thread);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
thread | Gmail | سلسلة المحادثات التي تريد وضع علامة "غير مهمة" عليها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
markThreadUnread(thread)
يضع علامة "غير مقروءة" على سلسلة المحادثات هذه ويفرض إعادة تحميلها.
// Marks first inbox thread as unread const thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnread(thread);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
thread | Gmail | سلسلة المحادثات المطلوب وضع علامة "غير مقروءة" عليها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
markThreadsImportant(threads)
يضع علامة "مهمة" على سلاسل المحادثات هذه ويفرض إعادة تحميلها.
// Marks first two threads in inbox as important const threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsImportant(threads);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
threads | Gmail | مصفوفة سلاسل محادثات لوضع علامة "مهمة" عليها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
markThreadsRead(threads)
يضع علامة "مقروءة" على سلاسل المحادثات هذه ويفرض إعادة تحميلها.
// Marks first two threads in inbox as read const threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsRead(threads);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
threads | Gmail | مجموعة من سلاسل المحادثات المطلوب وضع علامة "مقروءة" عليها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
markThreadsUnimportant(threads)
يضع علامة "غير مهمة" على سلاسل المحادثات هذه ويفرض إعادة تحميلها.
// Marks first two threads in inbox as unimportant const threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnimportant(threads);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
threads | Gmail | مصفوفة سلاسل محادثات لوضع علامة "غير مهمة" عليها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
markThreadsUnread(threads)
يضع علامة "غير مقروءة" على سلاسل المحادثات هذه ويفرض إعادة تحميلها.
// Marks first two threads in inbox as unread const threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnread(threads);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
threads | Gmail | مصفوفة سلاسل محادثات لوضع علامة "غير مقروءة" عليها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
moveMessageToTrash(message)
ينقل الرسالة إلى المهملات ويفرض إعادة تحميلها.
// Move the first message in your inbox to trash const firstThread = GmailApp.getInboxThreads(0, 1)[0]; const firstMessage = firstThread.getMessages()[0]; GmailApp.moveMessageToTrash(firstMessage);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
message | Gmail | الرسالة المطلوب نقلها إلى المهملات |
الإرجاع
GmailApp: خدمة Gmail (مفيدة للتسلسل)
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
moveMessagesToTrash(messages)
ينقل الرسائل المحدّدة إلى المهملات ويفرض إعادة تحميل الرسائل.
// Move first two messages in your inbox to trash const firstThread = GmailApp.getInboxThreads(0, 1)[0]; const messages = firstThread.getMessages(); const toDelete = [messages[0], messages[1]]; GmailApp.moveMessagesToTrash(toDelete);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
messages | Gmail | الرسائل المطلوب نقلها إلى المهملات |
الإرجاع
GmailApp: خدمة Gmail (مفيدة للتسلسل)
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
moveThreadToArchive(thread)
ينقل سلسلة المحادثات هذه إلى الأرشيف ويفرض إعادة تحميلها.
// Archive the first thread in your inbox const firstThread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.moveThreadToArchive(firstThread);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
thread | Gmail | سلسلة المحادثات المطلوب أرشفتها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
moveThreadToInbox(thread)
ينقل سلسلة المحادثات هذه إلى البريد الوارد ويفرض إعادة تحميلها.
// Find a thread not already in your inbox const thread = GmailApp.search('-in:inbox')[0]; // Get the first one GmailApp.moveThreadToInbox(thread);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
thread | Gmail | سلسلة المحادثات التي سيتم نقلها إلى البريد الوارد |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
moveThreadToSpam(thread)
ينقل سلسلة المحادثات هذه إلى مجلد "المحادثات غير المرغوب فيها" ويفرض إعادة تحميلها.
// Tag first thread in inbox as spam const firstThread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.moveThreadToSpam(firstThread);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
thread | Gmail | سلسلة المحادثات المطلوب نقلها إلى مجلد الرسائل غير المرغوب فيها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
moveThreadToTrash(thread)
ينقل سلسلة المحادثات هذه إلى المهملات ويفرض إعادة تحميلها.
// Move first thread in inbox to trash const firstThread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.moveThreadToTrash(firstThread);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
thread | Gmail | سلسلة المحادثات المطلوب نقلها إلى المهملات |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
moveThreadsToArchive(threads)
ينقل سلاسل المحادثات هذه إلى الأرشيف ويفرض إعادة تحميلها.
// Move first two threads in your inbox to the archive const firstTwoThreads = GmailApp.getInboxThreads(0, 2); GmailApp.moveThreadsToArchive(firstTwoThreads);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
threads | Gmail | مصفوفة سلاسل المحادثات المطلوب أرشفتها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
moveThreadsToInbox(threads)
ينقل سلاسل المحادثات هذه إلى البريد الوارد ويفرض إعادة تحميلها.
// Find two threads not already in your inbox const firstTwoThreads = GmailApp.search('-in:inbox', 0, 2); GmailApp.moveThreadsToInbox(firstTwoThreads);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
threads | Gmail | مصفوفة سلاسل محادثات سيتم نقلها إلى البريد الوارد |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
moveThreadsToSpam(threads)
تنقل هذه السلاسل إلى مجلد الرسائل غير المرغوب فيها وتفرض إعادة تحميلها.
// Move first two threads in your inbox to spam const firstTwoThreads = GmailApp.getInboxThreads(0, 2); GmailApp.moveThreadsToSpam(firstTwoThreads);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
threads | Gmail | مصفوفة سلاسل المحادثات المطلوب نقلها إلى مجلد الرسائل غير المرغوب فيها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
moveThreadsToTrash(threads)
ينقل سلاسل المحادثات هذه إلى المهملات ويفرض إعادة تحميلها.
// Move first two threads in your inbox to trash const firstTwoThreads = GmailApp.getInboxThreads(0, 2); GmailApp.moveThreadsToTrash(firstTwoThreads);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
threads | Gmail | مصفوفة سلاسل المحادثات المطلوب نقلها إلى المهملات |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
refreshMessage(message)
تعيد تحميل الرسالة والحالة المرتبطة بها من Gmail (مفيدة في حال تغيّر التصنيفات أو حالة القراءة أو غير ذلك).
const firstThread = GmailApp.getInboxThreads(0, 1)[0]; const firstMessage = firstThread.getMessages()[0]; // ...Do something that may take a while here.... GmailApp.refreshMessage(firstMessage); // ...Do more stuff with firstMessage...
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
message | Gmail | الرسالة المطلوب إعادة تحميلها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
refreshMessages(messages)
تعيد تحميل الرسائل والحالة المرتبطة بها من Gmail (مفيدة في حال تغيّر التصنيفات أو حالة القراءة أو غير ذلك).
const firstThread = GmailApp.getInboxThreads(0, 1)[0]; const coupleOfMessages = firstThread.getMessages().slice(0, 2); // ...Do something that may take a while here.... GmailApp.refreshMessages(coupleOfMessages); // ...Do more stuff with coupleOfMessages...
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
messages | Gmail | الرسائل المطلوب إعادة تحميلها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
refreshThread(thread)
تعيد تحميل سلسلة المحادثات والحالة المرتبطة بها من Gmail (مفيدة في حال تغيّرت التصنيفات أو حالة القراءة أو غير ذلك).
const firstThread = GmailApp.getInboxThreads(0, 1)[0]; // ...Do something that may take a while here.... GmailApp.refreshThread(firstThread); // ... Do more stuff with the thread ...
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
thread | Gmail | سلسلة المحادثات التي سيتم إعادة تحميلها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
refreshThreads(threads)
إعادة تحميل سلاسل المحادثات والحالة المرتبطة بها من Gmail (مفيدة في حال تغيّر التصنيفات أو حالة القراءة أو غير ذلك).
const threads = GmailApp.getInboxThreads(0, 3); // ...Do something that may take a while here.... GmailApp.refreshThreads(threads); // ... Do more stuff with threads ...
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
threads | Gmail | سلاسل المحادثات التي سيتم تعديلها |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
search(query)
البحث في Gmail باستخدام طلب البحث المحدّد
سيتعذّر تنفيذ هذه العملية عندما يكون حجم جميع سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام التعامل معه. في حال كان حجم سلسلة المحادثات غير معروف، ومن المحتمل أن يكون كبيرًا جدًا، يُرجى استخدام طلب "صفحات"، وتحديد نطاقات سلاسل المحادثات التي سيتم استردادها في كل طلب.
// Find starred messages with subject IMPORTANT const threads = GmailApp.search('is:starred subject:"IMPORTANT"');
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
query | String | طلب البحث، كما تكتبه في Gmail |
الإرجاع
GmailThread[]: مصفوفة من سلاسل محادثات Gmail التي تتطابق مع طلب البحث هذا
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
search(query, start, max)
البحث في Gmail باستخدام طلب البحث المحدّد
// Find starred messages with subject IMPORTANT and return second batch of 10. // Assumes there are at least 11 of them, otherwise this will return an empty // array. const threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
query | String | طلب البحث، كما تكتبه في Gmail |
start | Integer | فهرس سلسلة المحادثات الأولية |
max | Integer | الحدّ الأقصى لعدد سلاسل المحادثات المطلوب عرضها |
الإرجاع
GmailThread[]: مصفوفة من سلاسل محادثات Gmail التي تتطابق مع طلب البحث هذا
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
sendEmail(recipient, subject, body)
يرسِل رسالة إلكترونية. يتم تحديد الحصة لحجم الرسالة الإلكترونية (بما في ذلك العناوين).
// The code below will send an email with the current date and time. const now = new Date(); GmailApp.sendEmail( 'mike@example.com', 'current time', `The time is: ${now.toString()}`, );
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
recipient | String | قائمة بعناوين البريد الإلكتروني مفصولة بفواصل |
subject | String | موضوع الرسالة الإلكترونية (250 حرفًا كحد أقصى) |
body | String | نص الرسالة الإلكترونية |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
sendEmail(recipient, subject, body, options)
يرسل رسالة إلكترونية تتضمّن وسيطات اختيارية. يمكن أن تحتوي الرسالة الإلكترونية على نص عادي أو نص بتنسيق HTML. يخضع حجم الرسالة الإلكترونية (بما في ذلك العناوين، ولكن باستثناء المرفقات) لحد أقصى.
// Send an email with a file from Google Drive attached as a PDF. const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz'); GmailApp.sendEmail( 'mike@example.com', 'Attachment example', 'Please see the attached file.', { attachments: [file.getAs(MimeType.PDF)], name: 'Automatic Emailer Script', }, );
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
recipient | String | عناوين المستلِم |
subject | String | سطر الموضوع (250 حرفًا كحدّ أقصى) |
body | String | نص الرسالة الإلكترونية |
options | Object | كائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه |
المعلمات المتقدمة
| الاسم | النوع | الوصف |
|---|---|---|
attachments | Blob | مصفوفة من الملفات المراد إرسالها مع الرسالة الإلكترونية |
bcc | String | قائمة قيم مفصولة بفاصلة لعناوين البريد الإلكتروني التي سيتم إرسال نسخة مخفية الوجهة إليها |
cc | String | قائمة قيم مفصولة بفاصلة لعناوين البريد الإلكتروني التي يجب تضمينها في السطر "نسخة إلى" |
from | String | عنوان البريد الإلكتروني الذي يجب إرسال الرسالة منه، ويجب أن يكون إحدى القيم التي تعرضها الدالة get |
html | String | في حال ضبط هذا الحقل، ستستخدم الأجهزة التي يمكنها عرض HTML هذا الحقل بدلاً من وسيطة النص الأساسي المطلوبة. يمكنك إضافة حقل inline اختياري في النص الأساسي لـ HTML إذا كانت لديك صور مضمّنة في رسالتك الإلكترونية. |
inline | Object | كائن JavaScript يحتوي على ربط من مفتاح الصورة
(String) إلى بيانات الصورة (Blob)، وهذا يفترض أنّه يتم استخدام المَعلمة html وأنّها تحتوي على مراجع إلى هذه الصور بالتنسيق <img src="cid:imageKey" /> |
name | String | اسم مرسل الرسالة الإلكترونية (القيمة التلقائية: اسم المستخدم) |
no | Boolean | true إذا كان من المفترض إرسال الرسالة الإلكترونية من عنوان بريد إلكتروني عام
لا يسمح بالردّ لتثبيط المستلِمين عن الردّ على الرسائل الإلكترونية، لا يتوفّر هذا الخيار إلا لحسابات Google Workspace، وليس لمستخدمي Gmail |
reply | String | عنوان بريد إلكتروني لاستخدامه كعنوان الردّ التلقائي (القيمة التلقائية: عنوان البريد الإلكتروني للمستخدم) |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
setCurrentMessageAccessToken(accessToken)
تضبط رمز الدخول إلى الرسالة الحالية الذي يتيح للبرنامج النصي الوصول إلى خصائص GmailMessage الحالية.
لا تتطلّب هذه الطريقة سوى مشاريع إضافات Google Workspace التي تستخدم نطاقات الرسائل الحالية في Gmail.
function handleAddonActionEvent(e) { GmailApp.setCurrentMessageAccessToken(e.messageMetadata.accessToken); const mailMessage = GmailApp.getMessageById(e.messageMetadata.messageId); // Do something with mailMessage }
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
access | String | رمز الدخول المؤقت الذي تم الحصول عليه من عنصر حدث الإجراء لإحدى إضافات Gmail |
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
starMessage(message)
يضيف نجمة إلى هذه الرسالة ويفرض إعادة تحميلها.
// Stars the first message in the first thread in your inbox const firstThread = GmailApp.getInboxThreads(0, 1)[0]; const message = firstThread.getMessages()[0]; GmailApp.starMessage(message);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
message | Gmail | الرسالة المطلوب تمييزها بنجمة |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
starMessages(messages)
يضيف نجومًا إلى هذه الرسائل ويفرض إعادة تحميلها.
// Stars the first three messages in the first thread in your inbox const firstThread = GmailApp.getInboxThreads(0, 1)[0]; const coupleOfMessages = firstThread.getMessages().slice(0, 3); GmailApp.starMessages(coupleOfMessages);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
messages | Gmail | مصفوفة من الرسائل المطلوب تمييزها بنجمة |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
unstarMessage(message)
يزيل نجمة من هذه الرسالة ويفرض إعادة تحميلها.
// Unstars the first message in the first thread in your inbox const firstThread = GmailApp.getInboxThreads(0, 1)[0]; const message = firstThread.getMessages()[0]; GmailApp.unstarMessage(message);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
message | Gmail | الرسالة المطلوب إلغاء تمييزها بنجمة |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/
انظر أيضًا
unstarMessages(messages)
تتم إزالة النجوم من هذه الرسائل وإعادة تحميلها.
// Unstars the first three messages in the first thread in your inbox const firstThread = GmailApp.getInboxThreads(0, 1)[0]; const coupleOfMessages = firstThread.getMessages().slice(0, 3); GmailApp.unstarMessages(coupleOfMessages);
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
messages | Gmail | مصفوفة من الرسائل المطلوب إلغاء تمييزها بنجمة |
الإرجاع
GmailApp: خدمة Gmail، وهي مفيدة للربط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:
-
https://mail.google.com/