Gmail Service

Gmail

تتيح لك هذه الخدمة إرسال رسائل إلكترونية وإنشاء مسودات وإدارة التصنيفات ووضع علامة على الرسائل وسلاسل المحادثات وتنفيذ مجموعة متنوعة من مهام إدارة حساب Gmail الأخرى. يمكنك أيضًا الاطّلاع على خدمة البريد، وهي خدمة أبسط تتيح إرسال الرسائل الإلكترونية فقط.

الدروس

الاسموصف قصير
GmailAppتتيح هذه النطاقات الوصول إلى سلاسل محادثات Gmail ورسائله وتصنيفاته.
GmailAttachmentمرفق من Gmail
GmailDraftمسودة رسالة أنشأها المستخدم في حسابه على Gmail
GmailLabelتصنيف أنشأه المستخدم في حسابه على Gmail
GmailMessageرسالة في حساب Gmail الخاص بالمستخدم
GmailThreadسلسلة محادثات في حساب Gmail الخاص بالمستخدم

GmailApp

الطُرق

الطريقةنوع القيمة التي تم إرجاعهاوصف قصير
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|nullتعرض هذه الطريقة سلسلة محادثات حسب رقم التعريف.
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تتم إزالة النجوم من هذه الرسائل وإعادة تحميلها.

GmailAttachment

الطُرق

الطريقةنوع القيمة التي تم إرجاعهاوصف قصير
copyBlob()Blobتعرض هذه الدالة نسخة من كائن البيانات الثنائية الكبير.
getAs(contentType)Blobلعرض البيانات داخل هذا العنصر ككائن ثنائي كبير تم تحويله إلى نوع المحتوى المحدّد
getBytes()Byte[]تعرض هذه الطريقة البيانات المخزّنة في هذا الكائن الثنائي الكبير.
getContentType()String|nullتعرض هذه السمة نوع المحتوى الخاص بالبايت في كائن التخزين الثنائي الكبير هذا.
getDataAsString()Stringتعرض هذه الطريقة بيانات الكائن الثنائي الكبير (blob) كسلسلة بترميز UTF-8.
getDataAsString(charset)Stringتعرض بيانات هذا الكائن الثنائي الكبير كسلسلة باستخدام الترميز المحدّد.
getHash()Stringتعرض هذه السمة تجزئة SHA1 للمحتوى الخاص بهذا المرفق.
getName()String|nullتعرض هذه السمة اسم الكائن الثنائي الكبير.
getSize()Integerتعرض هذه السمة حجم المرفق.
isGoogleType()Booleanتعرض هذه الدالة ما إذا كانت هذه البيانات الثنائية الكبيرة عبارة عن ملف Google Workspace (جداول بيانات Google، ومستندات Google، وما إلى ذلك).
setBytes(data)Blobتضبط هذه السمة البيانات المخزَّنة في هذا الكائن الثنائي الكبير.
setContentType(contentType)Blobتضبط هذه السمة نوع محتوى البايتات في هذا الكائن الثنائي الكبير.
setContentTypeFromExtension()Blobتضبط هذه السمة نوع المحتوى للبايتات في هذا الكائن الثنائي الكبير استنادًا إلى امتداد الملف.
setDataFromString(string)Blobتضبط هذه الطريقة بيانات الكائن الثنائي الكبير من سلسلة بترميز UTF-8.
setDataFromString(string, charset)Blobتضبط هذه الطريقة بيانات الكائن الثنائي الكبير من سلسلة باستخدام الترميز المحدّد.
setName(name)Blobتضبط هذه السمة اسم الكائن الثنائي الكبير.

GmailDraft

الطُرق

الطريقةنوع القيمة التي تم إرجاعهاوصف قصير
deleteDraft()voidلحذف رسالة المسودة هذه
getId()Stringتعرض هذه الطريقة رقم تعريف الرسالة المسودّة.
getMessage()GmailMessageتعرض هذه الدالة كائن GmailMessage يمثّل هذه المسودّة.
getMessageId()Stringتعرِض هذه السمة رقم تعريف GmailMessage الذي يمثّل هذه المسودّة.
send()GmailMessageيرسل مسودة الرسالة الإلكترونية هذه.
update(recipient, subject, body)GmailDraftيستبدل محتوى هذه الرسالة المسودّة.
update(recipient, subject, body, options)GmailDraftيستبدل محتوى رسالة المسودة هذه باستخدام وسيطات اختيارية.

GmailLabel

الطُرق

الطريقةنوع القيمة التي تم إرجاعهاوصف قصير
addToThread(thread)GmailLabelتضيف هذه العلامة إلى سلسلة المحادثات المحدّدة وتفرض إعادة تحميل السلسلة (GmailThread.refresh()).
addToThreads(threads)GmailLabelتضيف هذه الطريقة التصنيف إلى سلاسل المحادثات المحدّدة وتفرض إعادة تحميل سلاسل المحادثات.
deleteLabel()voidلحذف هذا التصنيف
getId()Stringتعرض هذه الطريقة معرّف التصنيف.
getName()Stringتعرض هذه الدالة اسم التصنيف.
getThreads()GmailThread[]تعرض هذه الطريقة سلاسل المحادثات التي تم وضع علامة عليها بهذا التصنيف.
getThreads(start, max)GmailThread[]تعرض هذه الطريقة نطاقًا من سلاسل المحادثات التي تم وضع هذه التصنيف عليها.
getUnreadCount()Integerتعرض هذه الدالة عدد سلاسل المحادثات غير المقروءة التي تمّت الإشارة إليها باستخدام هذه التصنيف.
removeFromThread(thread)GmailLabelيزيل هذا التصنيف من سلسلة المحادثات المحدّدة ويفرض إعادة تحميلها.
removeFromThreads(threads)GmailLabelيزيل هذا التصنيف من سلاسل المحادثات المحدّدة ويفرض إعادة تحميلها.

GmailMessage

الطُرق

الطريقةنوع القيمة التي تم إرجاعهاوصف قصير
createDraftReply(body)GmailDraftتنشئ هذه الطريقة مسودة رسالة للردّ على مرسل هذه الرسالة باستخدام عنوان الردّ.
createDraftReply(body, options)GmailDraftتنشئ هذه الدالة مسودة رسالة للرد على مرسل هذه الرسالة باستخدام عنوان الرد، مع وسيطات اختيارية.
createDraftReplyAll(body)GmailDraftتنشئ هذه الطريقة مسودة رسالة للرد على المرسِل باستخدام عنوان الرد وجميع مستلمي هذه الرسالة.
createDraftReplyAll(body, options)GmailDraftتنشئ هذه الطريقة رسالة ردّ مسودّة على مرسل هذه الرسالة باستخدام عنوان الرد وجميع المستلمين، مع وسيطات اختيارية.
forward(recipient)GmailMessageتعيد توجيه هذه الرسالة إلى مستلِمين جدد.
forward(recipient, options)GmailMessageتعيد توجيه هذه الرسالة إلى مستلِمين جدد، مع وسيطات اختيارية.
getAttachments()GmailAttachment[]تعرض هذه الطريقة جميع المرفقات الخاصة بهذه الرسالة.
getAttachments(options)GmailAttachment[]تعرض هذه الطريقة جميع المرفقات الخاصة بهذه الرسالة.
getBcc()Stringتعرض هذه السمة المستلمين الذين تم إرسال نسخة مخفية الوجهة إليهم من هذه الرسالة، ويكونون مفصولين بفواصل.
getBody()Stringتعرض هذه الدالة محتوى HTML الخاص بنص هذه الرسالة.
getCc()Stringتعرض هذه الطريقة المستلمين الذين تم إرسال نسخة إلى عناوين بريدهم الإلكتروني من هذه الرسالة، ويكونون مفصولين بفواصل.
getDate()Dateتعرض هذه السمة تاريخ ووقت هذه الرسالة.
getFrom()Stringتعرض هذه السمة مُرسِل هذه الرسالة.
getHeader(name)Stringتعرض هذه الطريقة قيمة عنوان RFC 2822 مع اسم العنوان.
getId()Stringتعرض هذه السمة معرّف هذه الرسالة.
getPlainBody()Stringتعرض هذه الطريقة محتوى نص الرسالة بدون تنسيق HTML.
getRawContent()Stringتعرض هذه الطريقة المحتوى الأولي لهذه الرسالة.
getReplyTo()Stringتعرض هذه السمة عنوان الرد على هذه الرسالة (عادةً ما يكون هو المُرسِل).
getSubject()Stringتعرض هذه الطريقة موضوع الرسالة.
getThread()GmailThreadتعرض سلسلة المحادثات التي تتضمّن هذه الرسالة.
getTo()Stringتعرض هذه السمة المستلمين المفصولين بفواصل لهذه الرسالة.
isDraft()Booleanتعرض ما إذا كانت هذه الرسالة مسودة.
isInChats()Booleanتُستخدَم لمعرفة ما إذا كانت هذه الرسالة عبارة عن محادثة.
isInInbox()Booleanتسترد هذه الطريقة ما إذا كانت الرسالة في البريد الوارد.
isInPriorityInbox()Booleanتعرض الدالة true إذا كانت هذه الرسالة في البريد الهام، وتعرض false في الحالات الأخرى.
isInTrash()Booleanتعرض هذه الطريقة ما إذا كانت هذه الرسالة في المهملات.
isStarred()Booleanتعرض هذه السمة ما إذا كانت هذه الرسالة مميَّزة بنجمة.
isUnread()Booleanتعرض هذه السمة ما إذا كانت الرسالة غير مقروءة.
markRead()GmailMessageيضع علامة على الرسالة بأنّها مقروءة.
markUnread()GmailMessageيضع علامة على الرسالة بأنّها غير مقروءة.
moveToTrash()GmailMessageينقل الرسالة إلى المهملات.
refresh()GmailMessageتعيد تحميل هذه الرسالة والحالة المرتبطة بها من Gmail (مفيدة في حال تغيّرت التصنيفات أو حالة القراءة أو غير ذلك).
reply(body)GmailMessageالردود على مُرسِل هذه الرسالة باستخدام عنوان الردّ
reply(body, options)GmailMessageالردّ على مُرسِل هذه الرسالة باستخدام عنوان الردّ، مع وسيطات اختيارية
replyAll(body)GmailMessageالردّ على المرسِل باستخدام عنوان الردّ وجميع مستلمي هذه الرسالة
replyAll(body, options)GmailMessageالرد على مرسل هذه الرسالة باستخدام عنوان الرد وجميع المستلمين، مع وسيطات اختيارية.
star()GmailMessageتمييز الرسالة بنجمة
unstar()GmailMessageإلغاء تمييز الرسالة بنجمة

GmailThread

الطُرق

الطريقةنوع القيمة التي تم إرجاعهاوصف قصير
addLabel(label)GmailThreadيضيف هذا التصنيف إلى سلسلة المحادثات.
createDraftReply(body)GmailDraftتنشئ هذه الطريقة مسودة رسالة للردّ على مرسل آخر رسالة في سلسلة المحادثات هذه باستخدام عنوان الردّ.
createDraftReply(body, options)GmailDraftتنشئ هذه الطريقة مسودة رسالة للرد على مرسل آخر رسالة في سلسلة المحادثات هذه باستخدام عنوان الرد، مع وسيطات اختيارية.
createDraftReplyAll(body)GmailDraftتنشئ هذه الطريقة مسودة رسالة للرد على مرسل آخر رسالة في سلسلة المحادثات هذه، وذلك باستخدام عنوان الرد وجميع مستلمي هذه الرسالة.
createDraftReplyAll(body, options)GmailDraftتنشئ هذه الطريقة مسودة رسالة للرد على مرسل آخر رسالة في هذه السلسلة، باستخدام عنوان الرد وجميع المستلمين، مع وسيطات اختيارية.
getFirstMessageSubject()Stringتعرض هذه السمة موضوع الرسالة الأولى في سلسلة المحادثات.
getId()Stringتعرض هذه السمة رقم تعريف سلسلة المحادثات هذه.
getLabels()GmailLabel[]تعرض هذه الطريقة التصنيفات التي أنشأها المستخدم في سلسلة المحادثات هذه.
getLastMessageDate()Dateتعرض هذه السمة تاريخ أحدث رسالة في سلسلة المحادثات هذه.
getMessageCount()Integerتعرض هذه السمة عدد الرسائل في سلسلة المحادثات.
getMessages()GmailMessage[]تعرض هذه الطريقة الرسائل في سلسلة المحادثات هذه.
getPermalink()Stringتعرض هذه الطريقة رابطًا ثابتًا لسلسلة المحادثات هذه.
hasStarredMessages()Booleanتعرض هذه السمة ما إذا كانت سلسلة المحادثات تتضمّن أي رسائل مميّزة بنجمة.
isImportant()Booleanتعرض هذه السمة ما إذا تم وضع علامة على سلسلة المحادثات باعتبارها مهمة.
isInChats()Booleanتعرض هذه السمة ما إذا تم تصنيف سلسلة المحادثات على أنّها محادثة.
isInInbox()Booleanتعرِض هذه السمة ما إذا كانت سلسلة المحادثات في البريد الوارد.
isInPriorityInbox()Booleanتعرِض القيمة "صحيح" إذا كانت سلسلة المحادثات هذه في البريد الوارد ذي الأولوية، وتعرض القيمة "خطأ" في الحالات الأخرى.
isInSpam()Booleanتعرض هذه السمة ما إذا تم وضع علامة على سلسلة المحادثات باعتبارها رسالة غير مرغوب فيها.
isInTrash()Booleanتعرِض هذه السمة ما إذا كانت سلسلة المحادثات في المهملات.
isUnread()Booleanتعرض هذه السمة ما إذا كانت سلسلة المحادثات تحتوي على أي رسائل غير مقروءة.
markImportant()GmailThreadوضع علامة "مهمة" على سلسلة المحادثات هذه
markRead()GmailThreadيضع علامة "مقروءة" على سلسلة المحادثات هذه.
markUnimportant()GmailThreadيضع علامة "غير مهمة" على سلسلة المحادثات هذه.
markUnread()GmailThreadيضع علامة "غير مقروءة" على سلسلة المحادثات هذه.
moveToArchive()GmailThreadينقل سلسلة المحادثات هذه إلى الأرشيف.
moveToInbox()GmailThreadينقل سلسلة المحادثات هذه إلى البريد الوارد.
moveToSpam()GmailThreadينقل سلسلة المحادثات هذه إلى مجلد الرسائل غير المرغوب فيها.
moveToTrash()GmailThreadينقل سلسلة المحادثات هذه إلى المهملات.
refresh()GmailThreadتعيد تحميل سلسلة المحادثات هذه والحالة المرتبطة بها من Gmail (مفيدة في حال تغيّرت التصنيفات أو حالة القراءة أو غير ذلك).
removeLabel(label)GmailThreadيزيل هذا التصنيف من سلسلة المحادثات.
reply(body)GmailThreadالردّ على مُرسِل آخر رسالة في سلسلة المحادثات هذه باستخدام عنوان replyTo
reply(body, options)GmailThreadالردّ على مُرسِل آخر رسالة في سلسلة المحادثات هذه باستخدام عنوان replyTo، مع وسيطات اختيارية
replyAll(body)GmailThreadالردّ على المُرسِل (باستخدام عنوان replyTo) وجميع مستلِمي آخر رسالة في سلسلة المحادثات هذه
replyAll(body, options)GmailThreadالرد على المُرسِل (باستخدام عنوان replyTo) وجميع مستلمي الرسالة الأخيرة في سلسلة المحادثات هذه، مع وسيطات اختيارية