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.
const 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.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft(
    'mike@example.com',
    'Attachment example',
    'Please see attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

المعلمات

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

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

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

الإرجاع

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
const label = GmailApp.getUserLabelByName('FOO');
GmailApp.deleteLabel(label);

المعلمات

الاسمالنوعالوصف
labelGmailLabelالتصنيف المطلوب حذفه

الإرجاع

GmailApp: خدمة Gmail، وهي مفيدة لإنشاء سلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


getAliases()

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

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

// Log the aliases for this Gmail account and send an email as the first one.
const me = Session.getActiveUser().getEmail();
const aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {
    from: aliases[0],
  });
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

الإرجاع

String[]: صفيف من الأسماء البديلة لهذا الحساب

التفويض

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

  • https://mail.google.com/

انظر أيضًا


getDraft(draftId)

استرداد مسودة رسالة إلكترونية حسب المعرّف

استخدِم هذا الإجراء مع getId() في مسودات Gmail.

// Get the first draft message in your drafts folder
const draft = GmailApp.getDrafts()[0];
// Get its ID
const draftId = draft.getId();
// Now fetch the same draft using that ID.
const draftById = GmailApp.getDraft(draftId);
// Should always log true as they should be the same message
Logger.log(
    draft.getMessage().getSubject() === draftById.getMessage().getSubject(),
);

المعلمات

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

الإرجاع

GmailDraft - المسودة التي تحمل المعرّف المحدّد

عمليات الرمي

Error - إذا تعذّر العثور على مسودة بالمعرّف المحدّد

التفويض

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

  • https://mail.google.com/

getDraftMessages()

استرداد جميع مسودات الرسائل

// Logs the number of draft messages
const drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

الإرجاع

GmailMessage[]: صفيف من مسودات رسائل Gmail

التفويض

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

  • https://mail.google.com/

getDrafts()

الحصول على جميع مسودات الرسائل في Gmail

const drafts = GmailApp.getDrafts();
for (let i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

الإرجاع

GmailDraft[]: صفيف من مسودات رسائل Gmail

التفويض

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

  • https://mail.google.com/

getInboxThreads()

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

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

// Log the subject lines of your Inbox
const threads = GmailApp.getInboxThreads();
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

الإرجاع

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

التفويض

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

  • https://mail.google.com/

getInboxThreads(start, max)

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

// Log the subject lines of up to the first 50 emails in your Inbox
const threads = GmailApp.getInboxThreads(0, 50);
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

المعلمات

الاسمالنوعالوصف
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
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
const messageId = message.getId();
// Now fetch the same message using that ID.
const messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() === messageById.getSubject());

المعلمات

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

الإرجاع

GmailMessage - الرسالة التي تحمل المعرّف المحدّد

عمليات الرمي

Error - إذا تعذّر العثور على رسالة بالمعرّف المحدّد

التفويض

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

  • https://mail.google.com/

انظر أيضًا


getMessagesForThread(thread)

استرداد جميع الرسائل في سلسلة المحادثات المحدّدة

// Log all the subject lines in the first thread of your inbox
const thread = GmailApp.getInboxThreads(0, 1)[0];
const messages = GmailApp.getMessagesForThread(thread);
for (let i = 0; i < messages.length; i++) {
  Logger.log(`subject: ${messages[i].getSubject()}`);
}

المعلمات

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

الإرجاع

GmailMessage[]: صفيف الرسائل المقابلة لسلسلة المحادثات هذه

التفويض

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

  • https://mail.google.com/

انظر أيضًا


getMessagesForThreads(threads)

استرداد جميع الرسائل في سلاسل المحادثات المحدّدة

// Log the subject lines of all messages in the first two threads of your inbox
const thread = GmailApp.getInboxThreads(0, 2);
const messages = GmailApp.getMessagesForThreads(thread);
for (let i = 0; i < messages.length; i++) {
  for (let j = 0; j < messages[i].length; j++) {
    Logger.log(`subject: ${messages[i][j].getSubject()}`);
  }
}

المعلمات

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

الإرجاع

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}`,
);

المعلمات

الاسمالنوعالوصف
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()

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

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

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

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

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

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

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

المعلمات

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

الإرجاع

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}`,
);

المعلمات

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

الإرجاع

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

التفويض

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

  • https://mail.google.com/

getUserLabelByName(name)

يسترجع تصنيفًا بناءً على اسم التصنيف.

const labelObject = GmailApp.getUserLabelByName('myLabel');

المعلمات

الاسمالنوعالوصف
nameStringاسم التصنيف المطلوب استرجاعه

الإرجاع

GmailLabel: تصنيف Gmail الذي يحمل الاسم المحدَّد

التفويض

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

  • https://mail.google.com/

getUserLabels()

يسترجع قائمة بالتصنيفات التي أنشأها المستخدم.

// Logs all of the names of your labels
const labels = GmailApp.getUserLabels();
for (let i = 0; i < labels.length; i++) {
  Logger.log(`label: ${labels[i].getName()}`);
}

الإرجاع

GmailLabel[]: صفيف للتصنيفات التي أنشأها المستخدم

التفويض

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

  • https://mail.google.com/

markMessageRead(message)

يضع علامة على هذه الرسالة بأنّها مقروءة ويجبر على إعادة تحميل الرسالة.

// Mark the first message in the first thread of your inbox as read
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageRead(message);

المعلمات

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

الإرجاع

GmailApp: خدمة Gmail، وهي مفيدة لإنشاء سلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


markMessageUnread(message)

يضع علامة على هذه الرسالة بأنّها غير مقروءة ويجبر على إعادة تحميلها.

// Mark the first message in the first thread of your inbox as unread
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

المعلمات

الاسمالنوعالوصف
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.
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(messages);

المعلمات

الاسمالنوعالوصف
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
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(messages);

المعلمات

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

الإرجاع

GmailApp: خدمة Gmail، وهي مفيدة لإنشاء سلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


markThreadImportant(thread)

يضع علامة على سلسلة المحادثات هذه باعتبارها مُهمّة ويُجبر سلسلة المحادثات على إعادة التحميل.

// Marks first inbox thread as important
const 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
const 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
const 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
const 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
const 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
const 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
const 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
const 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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const messages = firstThread.getMessages();
const 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
const 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
const 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
const 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
const 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
const 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
const 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
const 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
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

المعلمات

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

الإرجاع

GmailApp: خدمة Gmail، وهي مفيدة لإنشاء سلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


refreshMessage(message)

إعادة تحميل الرسالة والحالة المرتبطة بها من Gmail (مفيد في حال تغيّر التصنيفات وحالة القراءة وغيرها)

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const firstMessage = firstThread.getMessages()[0];
// ...Do something that may take a while here....
GmailApp.refreshMessage(firstMessage);
// ...Do more stuff with firstMessage...

المعلمات

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

الإرجاع

GmailApp: خدمة Gmail، وهي مفيدة لإنشاء سلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


refreshMessages(messages)

إعادة تحميل الرسائل والحالة المرتبطة بها من Gmail (مفيد في حال تغيّر التصنيفات وحالة القراءة وغيرها)

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 2);
// ...Do something that may take a while here....
GmailApp.refreshMessages(coupleOfMessages);
// ...Do more stuff with coupleOfMessages...

المعلمات

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

الإرجاع

GmailApp: خدمة Gmail، وهي مفيدة لإنشاء سلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


refreshThread(thread)

إعادة تحميل سلسلة المحادثات والحالة المرتبطة بها من Gmail (مفيد في حال تغيّر التصنيفات وحالة القراءة وغيرها)

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
// ...Do something that may take a while here....
GmailApp.refreshThread(firstThread);
// ... Do more stuff with the thread ...

المعلمات

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

الإرجاع

GmailApp: خدمة Gmail، وهي مفيدة لإنشاء سلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


refreshThreads(threads)

إعادة تحميل سلاسل المحادثات والحالة المرتبطة بها من Gmail (مفيد في حال تغيّر التصنيفات وحالة القراءة وغيرها)

const threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

المعلمات

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

الإرجاع

GmailApp: خدمة Gmail، وهي مفيدة لإنشاء سلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


search(query)

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

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

// Find starred messages with subject IMPORTANT
const 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.
const 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.
const 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.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail(
    'mike@example.com',
    'Attachment example',
    'Please see the attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

المعلمات

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

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

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

الإرجاع

GmailApp: خدمة Gmail، وهي مفيدة لإنشاء سلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


setCurrentMessageAccessToken(accessToken)

تُستخدَم لضبط رمز ميزات الوصول الحالي إلى الرسالة الذي يسمح للنص البرمجي بالوصول إلى خصائص GmailMessage الحالية.

لا تتطلّب هذه الطريقة سوى مشاريع إضافة Google Workspace التي تستخدم نطاقات الرسائل الحالية في Gmail.

function handleAddonActionEvent(e) {
  GmailApp.setCurrentMessageAccessToken(e.messageMetadata.accessToken);
  const mailMessage = GmailApp.getMessageById(e.messageMetadata.messageId);
  // Do something with mailMessage
}

المعلمات

الاسمالنوعالوصف
accessTokenStringرمز مفتاح المرور المؤقت الذي تم الحصول عليه من عنصر حدث الإجراء في إحدى إضافات Gmail

التفويض

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

  • https://mail.google.com/

starMessage(message)

تضيف نجمة إلى هذه الرسالة وتجبر على إعادة تحميلها.

// Stars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

المعلمات

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

الإرجاع

GmailApp: خدمة Gmail، وهي مفيدة لإنشاء سلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


starMessages(messages)

تضيف نجومًا إلى هذه الرسائل وتجبر على إعادة تحميل الرسائل.

// Stars the first three messages in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

المعلمات

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

الإرجاع

GmailApp: خدمة Gmail، وهي مفيدة لإنشاء سلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


unstarMessage(message)

تزيل نجمة من هذه الرسالة وتجبر على إعادة تحميلها.

// Unstars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

المعلمات

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

الإرجاع

GmailApp: خدمة Gmail، وهي مفيدة لإنشاء سلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


unstarMessages(messages)

تزيل هذه الميزة النجوم من هذه الرسائل وتجبر على إعادة تحميل الرسائل.

// Unstars the first three messages in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

المعلمات

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

الإرجاع

GmailApp: خدمة Gmail، وهي مفيدة لإنشاء سلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا

الطرق المتوقّفة