Class GmailApp

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
تطبيق Gmail

توفر الوصول إلى سلاسل محادثات ورسائل وتصنيفات 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());

المعلّمات

الاسمالنوعالوصف
recipientStringقائمة بعناوين البريد الإلكتروني مفصولة بفواصل
subjectStringموضوع الرسالة الإلكترونية
bodyStringنص الرسالة الإلكترونية

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
recipientStringعناوين المستلِم
subjectStringسطر الموضوع
bodyStringنص الرسالة الإلكترونية
optionsObjectعنصر JavaScript يُحدّد المعلمات المتقدمة، كما هو موضّح أدناه

المعلمات المتقدمة

الاسمالنوعالوصف
attachmentsBlobSource[]مصفوفة من الملفات لإرسالها عبر الرسالة الإلكترونية
bccStringقائمة بعناوين البريد الإلكتروني المفصولة بفاصلة إلى نسخة مخفية الوجهة
ccStringقائمة بعناوين البريد الإلكتروني المفصولة بفاصلة إلى نسخة
fromStringالعنوان الذي يجب إرسال الرسالة الإلكترونية منه، والذي يجب أن يكون إحدى القيم التي يعرضها getAliases()
htmlBodyStringفي حال ضبط هذه السياسة، ستستخدم الأجهزة التي بإمكانها عرض HTML بدلاً من وسيطة النص المطلوبة، ويمكنك إضافة حقل inlineImages اختياري في نص HTML إذا كانت لديك صور مضمّنة للبريد الإلكتروني.
inlineImagesObjectعنصر JavaScript يحتوي على عملية ربط من مفتاح الصورة (String) إلى بيانات الصورة (BlobSource)، ويفترض ذلك أنّه يتم استخدام المعلّمة htmlBody وتتضمن إشارات إلى هذه الصور بالتنسيق <img src="cid:imageKey" />.
nameStringاسم مُرسِل الرسالة الإلكترونية (الإعداد التلقائي: اسم المستخدم's)
replyToStringعنوان بريد إلكتروني لاستخدامه كعنوان الرد التلقائي (تلقائي: عنوان البريد الإلكتروني للمستخدم's)

تذكرة ذهاب وعودة

GmailDraft — مسودة Gmail التي تم إنشاؤها حديثًا

التفويض

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

  • https://mail.google.com/

راجع أيضًا


createLabel(name)

إنشاء تصنيف مستخدم جديد للاسم المحدد.

// Creates the label @FOO and logs label: FOO
Logger.log("label: " + GmailApp.createLabel("FOO"));

المعلّمات

الاسمالنوعالوصف
nameStringاسم التصنيف الجديد

تذكرة ذهاب وعودة

GmailLabel - التصنيف الذي تم إنشاؤه حديثًا

التفويض

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

  • https://mail.google.com/

راجع أيضًا


deleteLabel(label)

حذف التصنيف المحدد.

// Have to get the label by name first
var label = GmailApp.getUserLabelByName("FOO");
GmailApp.deleteLabel(label);

المعلّمات

الاسمالنوعالوصف
labelGmailLabelالتصنيف الذي تريد حذفه

تذكرة ذهاب وعودة

GmailApp - خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

راجع أيضًا


getAliases()

يحصل على قائمة برسائل البريد الإلكتروني التي تم إعدادها كأسماء مستعارة لهذا الحساب في Gmail.

يمكنك إرسال رسالة من أي من هذه العناوين البديلة باستخدام الوسيطة "from" الاختيارية.

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

المعلّمات

الاسمالنوعالوصف
draftIdStringرقم تعريف المسودة المراد استردادها

تذكرة ذهاب وعودة

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

لاسترداد جميع سلاسل محادثات البريد الوارد بغض النظر عن التصنيفات.

ستتعذّر هذه المكالمة عندما يكون حجم جميع سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام معالجتها. عندما يكون حجم سلسلة المحادثات غير معروف، ومن المحتمل أن يكون كبيرًا جدًا، يُرجى استخدام 'paged'call وتحديد نطاقات سلاسل المحادثات لاستردادها في كل مكالمة.

// 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());
}

المعلّمات

الاسمالنوعالوصف
startIntegerفهرس سلسلة المحادثات الأولى لاستردادها.
maxIntegerالحد الأقصى لعدد سلاسل المحادثات التي يمكن استردادها

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
idStringرقم تعريف الرسالة المطلوب استردادها

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadGmailThreadسلسلة الرسائل المراد استردادها

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadsGmailThread[]سلاسل الرسائل المراد استردادها

تذكرة ذهاب وعودة

GmailMessage[][] - مصفوفة من مصفوفات الرسائل، حيث يتطابق كل عنصر في المصفوفة الخارجية مع سلسلة محادثات وتحتوي المصفوفة الداخلية على الرسائل في سلسلة المحادثات هذه

التفويض

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

  • https://mail.google.com/

راجع أيضًا


getPriorityInboxThreads()

لاسترداد جميع سلاسل البريد الوارد ذات الأولوية بغض النظر عن التصنيفات.

ستتعذّر هذه المكالمة عندما يكون حجم جميع سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام معالجتها. عندما يكون حجم سلسلة المحادثات غير معروف، ومن المحتمل أن يكون كبيرًا جدًا، يُرجى استخدام 'paged'call وتحديد نطاقات سلاسل المحادثات لاستردادها في كل مكالمة.

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

المعلّمات

الاسمالنوعالوصف
startIntegerفهرس سلسلة المحادثات الأولى لاستردادها.
maxIntegerالحد الأقصى لعدد سلاسل المحادثات التي يمكن استردادها

تذكرة ذهاب وعودة

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

لاسترداد جميع سلاسل المحادثات غير المرغوب فيها بغض النظر عن التصنيفات.

ستتعذّر هذه المكالمة عندما يكون حجم جميع سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام معالجتها. عندما يكون حجم سلسلة المحادثات غير معروف، ومن المحتمل أن يكون كبيرًا جدًا، يُرجى استخدام 'paged'call وتحديد نطاقات سلاسل المحادثات لاستردادها في كل مكالمة.

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

المعلّمات

الاسمالنوعالوصف
startIntegerفهرس سلسلة المحادثات الأولى لاستردادها.
maxIntegerالحد الأقصى لعدد سلاسل المحادثات التي يمكن استردادها

تذكرة ذهاب وعودة

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

لاسترداد جميع سلاسل المحادثات المميّزة بنجمة بغض النظر عن التصنيفات.

ستتعذّر هذه المكالمة عندما يكون حجم جميع سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام معالجتها. عندما يكون حجم سلسلة المحادثات غير معروف، ومن المحتمل أن يكون كبيرًا جدًا، يُرجى استخدام 'paged'call وتحديد نطاقات سلاسل المحادثات لاستردادها في كل مكالمة.

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

المعلّمات

الاسمالنوعالوصف
startIntegerفهرس سلسلة المحادثات الأولى لاستردادها.
maxIntegerالحد الأقصى لعدد سلاسل المحادثات التي يمكن استردادها

تذكرة ذهاب وعودة

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.

// Thread IDs can also be found in the location bar when you have a thread open in Gmail
// get first inbox thread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
// Get the same thread by ID
var threadById = GmailApp.getThreadById(firstThread.getId());
// Verify they are the same
Logger.log(firstThread.getFirstMessageSubject() == threadById.getFirstMessageSubject());

المعلّمات

الاسمالنوعالوصف
idStringرقم تعريف سلسلة المحادثات لاستردادها

تذكرة ذهاب وعودة

GmailThread - سلسلة المحادثات التي لها رقم التعريف المحدد أو قيمة فارغة في حال عدم العثور عليها

التفويض

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

  • https://mail.google.com/

راجع أيضًا


getTrashThreads()

لاسترداد جميع سلاسل محادثات المهملات بغض النظر عن التصنيفات.

ستتعذّر هذه المكالمة عندما يكون حجم جميع سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام معالجتها. عندما يكون حجم سلسلة المحادثات غير معروف، ومن المحتمل أن يكون كبيرًا جدًا، يُرجى استخدام 'paged'call وتحديد نطاقات سلاسل المحادثات لاستردادها في كل مكالمة.

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

المعلّمات

الاسمالنوعالوصف
startIntegerفهرس سلسلة المحادثات الأولى لاستردادها.
maxIntegerالحد الأقصى لعدد سلاسل المحادثات التي يمكن استردادها

تذكرة ذهاب وعودة

GmailThread[] - مصفوفة من سلاسل محادثات Gmail في المهملات

التفويض

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

  • https://mail.google.com/

getUserLabelByName(name)

استرداد تصنيف نظرًا لاسم التصنيف.

var labelObject = GmailApp.getUserLabelByName("myLabel");

المعلّمات

الاسمالنوعالوصف
nameStringاسم التصنيف لاسترداده

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
messageGmailMessageالرسالة التي يجب وضع علامة "مقروءة" عليها

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
messageGmailMessageالرسالة لوضع علامة "غير مقروءة"

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
messagesGmailMessage[]مصفوفة من الرسائل لوضع علامة "مقروءة" عليها

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
messagesGmailMessage[]مصفوفة من الرسائل لوضع علامة "غير مقروءة" عليها

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadGmailThreadسلسلة المحادثات التي يجب وضع علامة عليها كمهمة

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadGmailThreadسلسلة المحادثات التي يجب وضع علامة "مقروءة" عليها

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadGmailThreadسلسلة المحادثات التي يجب وضع علامة "غير مهمة" عليها

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadGmailThreadسلسلة المحادثات التي تريد وضع علامة "غير مقروءة" عليها

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات لوضع علامة عليها كمهمة

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات لوضع علامة "مقروءة" عليها

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات لوضع علامة عليها باعتبارها غير مهمة

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات لوضع علامة "غير مقروءة" عليها

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
messageGmailMessageالرسالة التي سيتم نقلها إلى المهملات

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
messagesGmailMessage[]الرسائل التي سيتم نقلها إلى المهملات

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadGmailThreadسلسلة المحادثات التي سيتم وضعها في الأرشيف

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadGmailThreadسلسلة المحادثات التي سيتم نقلها إلى البريد الوارد

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadGmailThreadسلسلة المحادثات التي سيتم نقلها إلى مجلد الرسائل غير المرغوب فيها

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadGmailThreadسلسلة المحادثات التي سيتم نقلها إلى المهملات

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات التي ستتم أرشفتها

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات التي سيتم نقلها إلى البريد الوارد

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات التي سيتم نقلها إلى مجلد الرسائل غير المرغوب فيها

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات التي سيتم نقلها إلى المهملات

تذكرة ذهاب وعودة

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...

المعلّمات

الاسمالنوعالوصف
messageGmailMessageالرسالة المطلوب إعادة تحميلها

تذكرة ذهاب وعودة

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...

المعلّمات

الاسمالنوعالوصف
messagesGmailMessage[]الرسائل المطلوب إعادة تحميلها

تذكرة ذهاب وعودة

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 ...

المعلّمات

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

تذكرة ذهاب وعودة

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 ...

المعلّمات

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

تذكرة ذهاب وعودة

GmailApp - خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

راجع أيضًا


search(query)

ابحث في Gmail باستخدام طلب البحث المحدد.

ستتعذّر هذه المكالمة عندما يكون حجم جميع سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام معالجتها. عندما يكون حجم سلسلة المحادثات غير معروف، ومن المحتمل أن يكون كبيرًا جدًا، يُرجى استخدام 'paged'call وتحديد نطاقات سلاسل المحادثات لاستردادها في كل مكالمة.

// Find starred messages with subject IMPORTANT
var threads = GmailApp.search('is:starred subject:"IMPORTANT"');

المعلّمات

الاسمالنوعالوصف
queryStringطلب البحث، تمامًا كما تكتبه في 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);

المعلّمات

الاسمالنوعالوصف
queryStringطلب البحث، تمامًا كما تكتبه في Gmail
startIntegerفهرس سلسلة المحادثات الأولى
maxIntegerالحدّ الأقصى لعدد سلاسل المحادثات التي يمكن عرضها

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
recipientStringقائمة بعناوين البريد الإلكتروني مفصولة بفواصل
subjectStringموضوع الرسالة الإلكترونية (250 حرفًا كحدٍ أقصى)
bodyStringنص الرسالة الإلكترونية

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
recipientStringعناوين المستلِم
subjectStringسطر الموضوع (250 حرفًا كحد أقصى)
bodyStringنص الرسالة الإلكترونية
optionsObjectعنصر JavaScript يُحدّد المعلمات المتقدمة، كما هو موضّح أدناه

المعلمات المتقدمة

الاسمالنوعالوصف
attachmentsBlobSource[]مصفوفة من الملفات لإرسالها عبر الرسالة الإلكترونية
bccStringقائمة بعناوين البريد الإلكتروني المفصولة بفاصلة إلى نسخة مخفية الوجهة
ccStringقائمة بعناوين البريد الإلكتروني المفصولة بفاصلة إلى نسخة
fromStringالعنوان الذي يجب إرسال الرسالة الإلكترونية منه، والذي يجب أن يكون إحدى القيم التي يعرضها getAliases()
htmlBodyStringفي حال ضبط هذه السياسة، ستستخدم الأجهزة التي بإمكانها عرض HTML بدلاً من وسيطة النص المطلوبة، ويمكنك إضافة حقل inlineImages اختياري في نص HTML إذا كانت لديك صور مضمّنة للبريد الإلكتروني.
inlineImagesObjectعنصر JavaScript يحتوي على عملية ربط من مفتاح الصورة (String) إلى بيانات الصورة (BlobSource)، ويفترض ذلك أنّه يتم استخدام المعلّمة htmlBody وتتضمن إشارات إلى هذه الصور بالتنسيق <img src="cid:imageKey" />.
nameStringاسم مُرسِل الرسالة الإلكترونية (الإعداد التلقائي: اسم المستخدم's)
noReplyBooleantrue إذا كان يجب إرسال الرسالة الإلكترونية من عنوان بريد إلكتروني عام بلا رد لمنع العملاء من الرد على الرسائل الإلكترونية، هذا الخيار متاح فقط لحسابات Google Workspace، وليس لمستخدمي Gmail
replyToStringعنوان بريد إلكتروني لاستخدامه كعنوان الرد التلقائي (تلقائي: عنوان البريد الإلكتروني للمستخدم's)

تذكرة ذهاب وعودة

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
}

المعلّمات

الاسمالنوعالوصف
accessTokenStringرمز الدخول المؤقت الذي تم الحصول عليه من كائن حدث الإجراء لإضافة 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);

المعلّمات

الاسمالنوعالوصف
messageGmailMessageالرسالة للتمييز بنجمة

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
messagesGmailMessage[]مصفوفة من الرسائل بنجمة

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
messageGmailMessageالرسالة لإلغاء التمييز بنجمة

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
messagesGmailMessage[]مصفوفة من الرسائل لإلغاء التمييز بنجمة

تذكرة ذهاب وعودة

GmailApp - خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

راجع أيضًا

الطرق التي تم إيقافها نهائيًا