دسترسی به رشتهها، پیامها و برچسبهای 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
- سرویس Gmail، مفید برای زنجیرهسازی
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از 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
- سرویس Gmail، مفید برای زنجیرهسازی
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از 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
- سرویس Gmail، مفید برای زنجیرهسازی
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از 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
- سرویس Gmail، مفید برای زنجیرهسازی
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:
-
https://mail.google.com/