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