دسترسی به رشتهها، پیامها و برچسبهای 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[] | جیمیل را با عبارت مورد نظر جستجو کنید. |
search(query, start, max) | GmailThread[] | جیمیل را با عبارت مورد نظر جستجو کنید. |
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());
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
recipient | String | لیست آدرس های ایمیل جدا شده با کاما |
subject | String | موضوع ایمیل |
body | String | بدنه ایمیل |
بازگشت
GmailDraft
- GmailDraft تازه ایجاد شده
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
createDraft(recipient, subject, body, options)
یک پیام ایمیل پیش نویس با آرگومان های اختیاری ایجاد می کند. ایمیل می تواند حاوی متن ساده یا متن HTML باشد. اندازه ایمیل (شامل سرصفحهها، اما به استثنای پیوستها) در سهمیه محدود است.
// Create a draft email with a file from Google Drive attached as a PDF. 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' });
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
recipient | String | آدرس های گیرنده |
subject | String | خط موضوع |
body | String | بدنه ایمیل |
options | Object | یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند |
پارامترهای پیشرفته
نام | تایپ کنید | توضیحات |
---|---|---|
attachments | BlobSource[] | مجموعه ای از فایل ها برای ارسال با ایمیل |
bcc | String | فهرستی از آدرسهای ایمیل به BCC که با کاما از هم جدا شدهاند |
cc | String | فهرستی از آدرسهای ایمیل به CC جدا شده با کاما |
from | String | آدرسی که ایمیل باید از آن ارسال شود، که باید یکی از مقادیر بازگردانده شده توسط getAliases() باشد. |
htmlBody | String | در صورت تنظیم، دستگاه هایی که قادر به ارائه HTML هستند، از آن به جای آرگومان بدن مورد نیاز استفاده می کنند. اگر برای ایمیل خود تصاویر درون خطی دارید، می توانید یک فیلد inlineImages اختیاری در متن HTML اضافه کنید |
inlineImages | Object | یک شی جاوا اسکریپت حاوی نگاشت از کلید تصویر ( String ) به داده های تصویر ( BlobSource ). فرض بر این است که پارامتر htmlBody استفاده شده است و حاوی ارجاعاتی به این تصاویر در قالب <img src="cid:imageKey" /> است. |
name | String | نام فرستنده ایمیل (پیشفرض: نام کاربر) |
replyTo | String | یک آدرس ایمیل برای استفاده به عنوان آدرس پیش فرض پاسخ به (پیش فرض: آدرس ایمیل کاربر) |
بازگشت
GmailDraft
- GmailDraft تازه ایجاد شده
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
createLabel(name)
یک برچسب کاربری جدید با نام داده شده ایجاد کنید.
// Creates the label @FOO and logs label: FOO Logger.log("label: " + GmailApp.createLabel("FOO"));
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
name | String | نام برچسب جدید |
بازگشت
GmailLabel
- برچسب تازه ایجاد شده
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
deleteLabel(label)
برچسب مشخص شده را حذف می کند.
// Have to get the label by name first var label = GmailApp.getUserLabelByName("FOO"); GmailApp.deleteLabel(label);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
label | GmailLabel | برچسب برای حذف |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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 API مربوطه دارند:
-
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());
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
draftId | String | شناسه پیش نویس برای بازیابی |
بازگشت
GmailDraft
- پیش نویس با شناسه داده شده
پرتاب می کند
Error
- اگر هیچ پیش نویس با شناسه داده شده یافت نشد
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
getDraftMessages()
همه پیام های پیش نویس را بازیابی می کند.
// Logs the number of draft messages var drafts = GmailApp.getDraftMessages(); Logger.log(drafts.length);
بازگشت
GmailMessage[]
- آرایهای از پیامهای پیشنویس Gmail
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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 API مربوطه دارند:
-
https://mail.google.com/
getInboxThreads()
همه رشتههای صندوق ورودی را بدون در نظر گرفتن برچسبها بازیابی میکند.
زمانی که اندازه همه رشتهها برای سیستم بسیار بزرگ باشد، این تماس با شکست مواجه میشود. در جایی که اندازه رشته ناشناخته است، و احتمالاً بسیار بزرگ است، لطفاً از فراخوانی «صفحهشده» استفاده کنید و محدوده رشتهها را برای بازیابی در هر تماس مشخص کنید.
// Log the subject lines of your Inbox var threads = GmailApp.getInboxThreads(); for (var i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); }
بازگشت
GmailThread[]
- آرایه ای از رشته های Gmail در صندوق ورودی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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()); }
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
start | Integer | نمایه اولین موضوعی که باید بازیابی شود |
max | Integer | حداکثر تعداد رشته ها برای بازیابی |
بازگشت
GmailThread[]
- آرایه ای از رشته های Gmail در صندوق ورودی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
getInboxUnreadCount()
تعداد رشته های خوانده نشده را در صندوق ورودی دریافت می کند.
Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());
بازگشت
Integer
- تعداد رشتههایی در صندوق ورودی که پیامهای خوانده نشده دارند
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
getMessageById(id)
با شناسه پیام می گیرد.
از این در ارتباط با getId() در پیامهای Gmail استفاده کنید.
// Get the first message in the first thread of your inbox 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());
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
id | String | شناسه پیام برای بازیابی |
بازگشت
GmailMessage
- پیام با شناسه داده شده
پرتاب می کند
Error
- اگر هیچ پیامی با شناسه داده شده یافت نشد
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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()); }
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
thread | GmailThread | رشته پیام ها برای بازیابی |
بازگشت
GmailMessage[]
- آرایه ای از پیام های مربوط به این رشته
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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()); } }
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
threads | GmailThread[] | رشته های پیام برای بازیابی |
بازگشت
GmailMessage[][]
- آرایهای از آرایهها از پیامها، که در آن هر مورد در آرایه بیرونی مربوط به یک رشته است و آرایه داخلی حاوی پیامهای موجود در آن رشته است.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
getPriorityInboxThreads()
همه رشتههای صندوق ورودی اولویتی را بدون توجه به برچسبها بازیابی میکند.
زمانی که اندازه همه رشتهها برای سیستم بسیار بزرگ باشد، این تماس با شکست مواجه میشود. در جایی که اندازه رشته ناشناخته است، و احتمالاً بسیار بزرگ است، لطفاً از فراخوانی «صفحهشده» استفاده کنید و محدوده رشتهها را برای بازیابی در هر تماس مشخص کنید.
Logger.log("# of messages in your Priority Inbox: " + GmailApp.getPriorityInboxThreads().length);
بازگشت
GmailThread[]
- آرایه ای از رشته های Gmail در صندوق ورودی اولویتی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
getPriorityInboxThreads(start, max)
طیفی از رشتههای صندوق ورودی اولویتی را بدون توجه به برچسبها بازیابی میکند.
// Will log some number 2 or less Logger.log("# of messages in your Priority Inbox: " + GmailApp.getPriorityInboxThreads(0, 2).length);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
start | Integer | نمایه اولین موضوعی که باید بازیابی شود |
max | Integer | حداکثر تعداد رشته ها برای بازیابی |
بازگشت
GmailThread[]
- آرایه ای از رشته های Gmail در صندوق ورودی اولویتی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
getPriorityInboxUnreadCount()
تعداد رشته های خوانده نشده را در صندوق ورودی اولویتی دریافت می کند.
Logger.log("Number of unread emails in your Priority Inbox : " + GmailApp.getPriorityInboxUnreadCount());
بازگشت
Integer
- تعداد رشتههایی در صندوق ورودی اولویتی که پیامهای خوانده نشده دارند
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
getSpamThreads()
همه رشته های هرزنامه را بدون در نظر گرفتن برچسب ها بازیابی می کند.
زمانی که اندازه همه رشتهها برای سیستم بسیار بزرگ باشد، این تماس با شکست مواجه میشود. در جایی که اندازه رشته ناشناخته است، و احتمالاً بسیار بزرگ است، لطفاً از فراخوانی «صفحهشده» استفاده کنید و محدوده رشتهها را برای بازیابی در هر تماس مشخص کنید.
Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);
بازگشت
GmailThread[]
- آرایه ای از رشته های Gmail در پوشه هرزنامه
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
getSpamThreads(start, max)
طیفی از رشته های هرزنامه را بدون توجه به برچسب ها بازیابی می کند.
// Will log a number at most 5 Logger.log("# of total spam threads: " + GmailApp.getSpamThreads(0, 5).length);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
start | Integer | نمایه اولین موضوعی که باید بازیابی شود |
max | Integer | حداکثر تعداد رشته ها برای بازیابی |
بازگشت
GmailThread[]
- آرایه ای از رشته های Gmail در پوشه هرزنامه
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
getSpamUnreadCount()
تعداد رشته های خوانده نشده که هرزنامه هستند را دریافت می کند.
// Unless you actually read stuff in your spam folder, this should be the same as // the number of messages in your spam folder. Logger.log("# unread threads that are spam: " + GmailApp.getSpamUnreadCount());
بازگشت
Integer
- تعداد رشتههای هرزنامه که پیامهای خوانده نشده دارند
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
getStarredThreads()
همه رشته های ستاره دار را بدون در نظر گرفتن برچسب ها بازیابی می کند.
زمانی که اندازه همه رشتهها برای سیستم بسیار بزرگ باشد، این تماس با شکست مواجه میشود. در جایی که اندازه رشته ناشناخته است، و احتمالاً بسیار بزرگ است، لطفاً از فراخوانی «صفحهشده» استفاده کنید و محدوده رشتهها را برای بازیابی در هر تماس مشخص کنید.
// Logs the number of starred threads Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);
بازگشت
GmailThread[]
- آرایه ای از رشته های ستاره دار Gmail
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
getStarredThreads(start, max)
طیفی از رشته های ستاره دار را بدون توجه به برچسب ها بازیابی می کند.
// Logs the number of starred threads to a maximum of 5 Logger.log("# Starred threads: " + GmailApp.getStarredThreads(0, 5).length);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
start | Integer | نمایه اولین موضوعی که باید بازیابی شود |
max | Integer | حداکثر تعداد رشته ها برای بازیابی |
بازگشت
GmailThread[]
- آرایه ای از رشته های ستاره دار Gmail
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
getStarredUnreadCount()
تعداد رشته های خوانده نشده ستاره دار را دریافت می کند.
Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());
بازگشت
Integer
- تعداد رشته های ستاره دار که پیام های خوانده نشده دارند
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
getThreadById(id)
یک موضوع با شناسه دریافت می کند.
از این در ارتباط با getId() در موضوعات Gmail استفاده کنید.
// Gets the first inbox thread. const firstThread = GmailApp.getInboxThreads(0,1)[0]; // Gets the same thread by ID. const threadById = GmailApp.getThreadById(firstThread.getId()); // Verifies that they are the same. console.log(firstThread.getFirstMessageSubject() === threadById.getFirstMessageSubject());
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
id | String | شناسه موضوع برای بازیابی. |
بازگشت
GmailThread
- رشته ای با شناسه داده شده یا در صورت یافت نشدن null
.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
getTrashThreads()
همه رشته های زباله را بدون در نظر گرفتن برچسب ها بازیابی می کند.
زمانی که اندازه همه رشتهها برای سیستم بسیار بزرگ باشد، این تماس با شکست مواجه میشود. در جایی که اندازه رشته ناشناخته است، و احتمالاً بسیار بزرگ است، لطفاً از فراخوانی «صفحهشده» استفاده کنید و محدوده رشتهها را برای بازیابی در هر تماس مشخص کنید.
Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);
بازگشت
GmailThread[]
- آرایه ای از رشته های Gmail در سطل زباله
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
getTrashThreads(start, max)
طیفی از رشته های زباله را بدون توجه به برچسب ها بازیابی می کند.
// Will log a number at most 5 Logger.log("# of total trash threads: " + GmailApp.getTrashThreads(0, 5).length);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
start | Integer | نمایه اولین موضوعی که باید بازیابی شود |
max | Integer | حداکثر تعداد رشته ها برای بازیابی |
بازگشت
GmailThread[]
- آرایه ای از رشته های Gmail در سطل زباله
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
getUserLabelByName(name)
برچسبی را با نام برچسب بازیابی می کند.
var labelObject = GmailApp.getUserLabelByName("myLabel");
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
name | String | نام برچسب برای بازیابی |
بازگشت
GmailLabel
- برچسب Gmail با نام داده شده
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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 API مربوطه دارند:
-
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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
message | GmailMessage | پیام علامت گذاری به عنوان خوانده شده |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
message | GmailMessage | پیام علامت گذاری به عنوان خوانده نشده |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
markMessagesRead(messages)
این پیامها را بهعنوان خواندهشده علامتگذاری میکند و پیامها را مجبور به بازخوانی میکند.
// Mark first three messages in the first inbox thread as read. // Assumes that the first inbox thread has 3 messages in it. var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages(); var messages = [threadMessages[0], threadMessages[1], threadMessages[2]]; GmailApp.markMessagesRead(thread.getMessages());
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
messages | GmailMessage[] | مجموعه ای از پیام ها برای علامت گذاری به عنوان خوانده شده |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
markMessagesUnread(messages)
این پیامها را به عنوان خوانده نشده علامتگذاری میکند و پیامها را مجبور به بازخوانی میکند.
// Mark first three messages in the first inbox thread as unread. // Assumes that the first inbox thread has 3 messages in it var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages(); var messages = [threadMessages[0], threadMessages[1], threadMessages[2]]; GmailApp.markMessagesUnread(thread.getMessages());
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
messages | GmailMessage[] | مجموعه ای از پیام ها برای علامت گذاری به عنوان خوانده نشده |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
markThreadImportant(thread)
این موضوع را بهعنوان مهم علامتگذاری میکند و موضوع را مجبور به تازه کردن میکند.
// Marks first inbox thread as important var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadImportant(thread);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
thread | GmailThread | موضوعی که باید به عنوان مهم علامت گذاری شود |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
markThreadRead(thread)
این موضوع را به عنوان خوانده شده علامت گذاری می کند و موضوع را مجبور به تازه کردن می کند.
// Marks first inbox thread as read var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadRead(thread);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
thread | GmailThread | موضوع برای علامت گذاری به عنوان خوانده شده |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
markThreadUnimportant(thread)
این رشته را بهعنوان بیاهمیت علامتگذاری میکند و موضوع را مجبور به تازه کردن میکند.
// Marks first inbox thread as unimportant var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnimportant(thread);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
thread | GmailThread | موضوعی که باید به عنوان غیر مهم علامت گذاری شود |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
markThreadUnread(thread)
این موضوع را به عنوان خوانده نشده علامت گذاری می کند و موضوع را مجبور به تازه کردن می کند.
// Marks first inbox thread as unread var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnread(thread);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
thread | GmailThread | موضوعی که باید به عنوان خوانده نشده علامت گذاری شود |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
markThreadsImportant(threads)
این رشتهها را بهعنوان مهم علامتگذاری میکند و رشتهها را مجبور به تازه کردن میکند.
// Marks first two threads in inbox as important var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsImportant(threads);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
threads | GmailThread[] | آرایه ای از رشته ها برای علامت گذاری به عنوان مهم |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
markThreadsRead(threads)
این رشتهها را بهعنوان خوانده شده علامتگذاری میکند و رشتهها را مجبور به تازه کردن میکند.
// Marks first two threads in inbox as read var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsRead(threads);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
threads | GmailThread[] | آرایه ای از رشته ها برای علامت گذاری به عنوان خوانده شده |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
markThreadsUnimportant(threads)
این رشتهها را بهعنوان بیاهمیت علامتگذاری میکند و رشتهها را مجبور به تازهسازی میکند.
// Marks first two threads in inbox as unimportant var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnimportant(threads);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
threads | GmailThread[] | آرایه ای از رشته ها برای علامت گذاری به عنوان غیر مهم |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
markThreadsUnread(threads)
این رشتهها را بهعنوان خواندهنشده علامتگذاری میکند و رشتهها را مجبور به تازه کردن میکند.
// Marks first two threads in inbox as unread var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnread(threads);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
threads | GmailThread[] | آرایه ای از رشته ها برای علامت گذاری به عنوان خوانده نشده |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
message | GmailMessage | پیامی که باید حذف شود |
بازگشت
GmailApp
— سرویس جیمیل (مفید برای زنجیره زدن)
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
messages | GmailMessage[] | پیام هایی که باید حذف شوند |
بازگشت
GmailApp
— سرویس جیمیل (مفید برای زنجیره زدن)
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
moveThreadToArchive(thread)
این رشته را به بایگانی منتقل می کند و موضوع را مجبور به تازه کردن می کند.
// Archive the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToArchive(firstThread);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
thread | GmailThread | موضوعی که باید بایگانی شود |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
thread | GmailThread | موضوعی که باید به صندوق ورودی منتقل شود |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
moveThreadToSpam(thread)
این رشته را به هرزنامه منتقل می کند و موضوع را مجبور به تازه کردن می کند.
// Tag first thread in inbox as spam var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToSpam(firstThread);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
thread | GmailThread | موضوعی که باید به هرزنامه منتقل شود |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
moveThreadToTrash(thread)
این رشته را به سطل زباله منتقل می کند و موضوع را مجبور به تازه کردن می کند.
// Move first thread in inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToTrash(firstThread);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
thread | GmailThread | نخی که باید سطل زباله ریخته شود |
بازگشت
GmailApp
- سرویس جیمیل، مفید برای زنجیره زدن
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
threads | GmailThread[] | آرایه ای از موضوعات که باید بایگانی شوند |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
threads | GmailThread[] | آرایه ای از رشته ها برای انتقال به صندوق ورودی |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
moveThreadsToSpam(threads)
این رشته ها را به هرزنامه منتقل می کند و رشته ها را مجبور به بازخوانی می کند.
// Move first two threads in your inbox to spam var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToSpam(firstTwoThreads);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
threads | GmailThread[] | آرایه ای از رشته ها برای انتقال به هرزنامه |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
moveThreadsToTrash(threads)
این رشتهها را به سطل زباله منتقل میکند و رشتهها را مجبور به تازه کردن میکند.
// Move first two threads in your inbox to trash var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToTrash(firstTwoThreads);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
threads | GmailThread[] | آرایه ای از رشته ها که باید در سطل زباله ریخته شوند |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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...
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
message | GmailMessage | پیامی که باید به روز شود |
بازگشت
GmailApp
- سرویس جیمیل، مفید برای زنجیره زدن
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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...
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
messages | GmailMessage[] | پیام هایی که باید به روز شوند |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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 ...
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
thread | GmailThread | موضوعی که باید تازه شود |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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 ...
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
threads | GmailThread[] | موضوعاتی که باید تجدید شوند |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
search(query)
جیمیل را با عبارت مورد نظر جستجو کنید.
زمانی که اندازه همه رشتهها برای سیستم بسیار بزرگ باشد، این تماس با شکست مواجه میشود. در جایی که اندازه رشته ناشناخته است، و احتمالاً بسیار بزرگ است، لطفاً از فراخوانی «صفحهشده» استفاده کنید و محدوده رشتهها را برای بازیابی در هر تماس مشخص کنید.
// Find starred messages with subject IMPORTANT var threads = GmailApp.search('is:starred subject:"IMPORTANT"');
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
query | String | عبارت جستجو، همانطور که آن را در جیمیل تایپ می کنید |
بازگشت
GmailThread[]
- آرایهای از رشتههای Gmail که با این جستار مطابقت دارند
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
search(query, start, max)
جیمیل را با عبارت مورد نظر جستجو کنید.
// 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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
query | String | عبارت جستجو، همانطور که آن را در جیمیل تایپ می کنید |
start | Integer | شاخص نخ شروع |
max | Integer | حداکثر تعداد موضوعات برای بازگشت |
بازگشت
GmailThread[]
- آرایهای از رشتههای Gmail که با این جستار مطابقت دارند
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
sendEmail(recipient, subject, body)
یک پیام ایمیل می فرستد. اندازه ایمیل (شامل سرصفحه ها) محدود است.
// The code below will send an email with the current date and time. var now = new Date(); GmailApp.sendEmail("mike@example.com", "current time", "The time is: " + now.toString());
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
recipient | String | لیست آدرس های ایمیل جدا شده با کاما |
subject | String | موضوع ایمیل (حداکثر 250 کاراکتر) |
body | String | بدنه ایمیل |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/
همچنین ببینید
sendEmail(recipient, subject, body, options)
یک پیام ایمیل با آرگومان های اختیاری ارسال می کند. ایمیل می تواند حاوی متن ساده یا متن HTML باشد. اندازه ایمیل (شامل سرصفحهها، اما به استثنای پیوستها) در سهمیه محدود است.
// Send an email with a file from Google Drive attached as a PDF. 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' });
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
recipient | String | آدرس های گیرنده |
subject | String | خط موضوع (حداکثر 250 کاراکتر) |
body | String | بدنه ایمیل |
options | Object | یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند |
پارامترهای پیشرفته
نام | تایپ کنید | توضیحات |
---|---|---|
attachments | BlobSource[] | مجموعه ای از فایل ها برای ارسال با ایمیل |
bcc | String | فهرستی از آدرسهای ایمیل به BCC که با کاما از هم جدا شدهاند |
cc | String | فهرستی از آدرسهای ایمیل به CC جدا شده با کاما |
from | String | آدرسی که ایمیل باید از آن ارسال شود، که باید یکی از مقادیر بازگردانده شده توسط getAliases() باشد. |
htmlBody | String | در صورت تنظیم، دستگاه هایی که قادر به ارائه HTML هستند، از آن به جای آرگومان بدن مورد نیاز استفاده می کنند. اگر برای ایمیل خود تصاویر درون خطی دارید، می توانید یک فیلد inlineImages اختیاری در متن HTML اضافه کنید |
inlineImages | Object | یک شی جاوا اسکریپت حاوی نگاشت از کلید تصویر ( String ) به داده های تصویر ( BlobSource ). فرض بر این است که پارامتر htmlBody استفاده شده است و حاوی ارجاعاتی به این تصاویر در قالب <img src="cid:imageKey" /> است. |
name | String | نام فرستنده ایمیل (پیشفرض: نام کاربر) |
noReply | Boolean | true اگر ایمیل باید از یک آدرس ایمیل عمومی بدون پاسخ ارسال شود تا گیرندگان را از پاسخ دادن به ایمیل ها منصرف کند. این گزینه فقط برای حساب های Google Workspace امکان پذیر است، نه کاربران Gmail |
replyTo | String | یک آدرس ایمیل برای استفاده به عنوان آدرس پیش فرض پاسخ به (پیش فرض: آدرس ایمیل کاربر) |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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 }
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
accessToken | String | نشانه دسترسی موقت که از یک شیء رویداد اقدام افزودنی Gmail بدست می آید. |
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
message | GmailMessage | پیام ستاره دار شدن |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
messages | GmailMessage[] | مجموعه ای از پیام ها برای ستاره گذاری |
بازگشت
GmailApp
- سرویس Gmail، مفید برای زنجیرهسازی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
message | GmailMessage | پیام حذف ستاره |
بازگشت
GmailApp
- سرویس جیمیل، مفید برای زنجیره زدن
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
messages | GmailMessage[] | مجموعه ای از پیام ها برای حذف ستاره |
بازگشت
GmailApp
- سرویس جیمیل، مفید برای زنجیره زدن
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/