Class GmailThread

جیمیل ترید

یک تاپیک در حساب جیمیل یک کاربر.

روش‌ها

روش	نوع بازگشتی	شرح مختصر
add Label(label)	Gmail Thread	این برچسب را به موضوع اضافه می‌کند.
create Draft Reply(body)	Gmail Draft	با استفاده از آدرس پاسخ، یک پیام پیش‌نویس در پاسخ به فرستنده آخرین پیام در این رشته ایجاد می‌کند.
create Draft Reply(body, options)	Gmail Draft	با استفاده از آدرس پاسخ، یک پیام پیش‌نویس در پاسخ به فرستنده آخرین پیام در این موضوع ایجاد می‌کند، که آرگومان‌های آن اختیاری است.
create Draft Reply All(body)	Gmail Draft	با استفاده از آدرس پاسخ‌دهنده و تمام گیرندگان این پیام، یک پیام پیش‌نویس در پاسخ به فرستنده آخرین پیام در این رشته ایجاد می‌کند.
create Draft Reply All(body, options)	Gmail Draft	یک پیام پیش‌نویس در پاسخ به فرستنده آخرین پیام در این رشته، با استفاده از آدرس پاسخ و همه گیرندگان، با آرگومان‌های اختیاری ایجاد می‌کند.
get First Message Subject()	String	موضوع اولین پیام در رشته پیام‌ها را دریافت می‌کند.
get Id()	String	شناسه (ID) این رشته را دریافت می‌کند.
get Labels()	Gmail Label[]	برچسب‌های ایجاد شده توسط کاربر در این موضوع را برمی‌گرداند.
get Last Message Date()	Date	تاریخ آخرین پیام این تاپیک را دریافت می‌کند.
get Message Count()	Integer	تعداد پیام‌های موجود در رشته را برمی‌گرداند.
get Messages()	Gmail Message[]	پیام‌های این تاپیک را دریافت می‌کند.
get Permalink()	String	برای این تاپیک یک پیوند دائمی دریافت می‌کند.
has Starred Messages()	Boolean	برمی‌گرداند که آیا رشته پیام‌های ستاره‌دار دارد یا خیر.
is Important()	Boolean	برمی‌گرداند که آیا موضوع به عنوان مهم علامت‌گذاری شده است یا خیر.
is In Chats()	Boolean	برمی‌گرداند که آیا موضوع مورد بحث، چت (chat) نامگذاری شده است یا خیر.
is In Inbox()	Boolean	برمی‌گرداند که آیا موضوع در صندوق ورودی قرار دارد یا خیر.
is In Priority Inbox()	Boolean	اگر این رشته در صندوق ورودی اولویت‌دار باشد، مقدار true و در غیر این صورت مقدار false را برمی‌گرداند.
is In Spam()	Boolean	برمی‌گرداند که آیا تاپیک به عنوان هرزنامه علامت‌گذاری شده است یا خیر.
is In Trash()	Boolean	برمی‌گرداند که آیا رشته در سطل زباله قرار دارد یا خیر.
is Unread()	Boolean	برمی‌گرداند که آیا رشته پیام‌های خوانده نشده‌ای دارد یا خیر.
mark Important()	Gmail Thread	این تاپیک را به عنوان تاپیک مهم علامت گذاری می‌کند.
mark Read()	Gmail Thread	این تاپیک را به عنوان خوانده شده علامت گذاری می کند.
mark Unimportant()	Gmail Thread	این تاپیک را به عنوان بی‌اهمیت علامت‌گذاری می‌کند.
mark Unread()	Gmail Thread	این تاپیک را به عنوان خوانده نشده علامت گذاری می کند.
move To Archive()	Gmail Thread	این تاپیک را به بایگانی منتقل می‌کند.
move To Inbox()	Gmail Thread	این تاپیک را به صندوق ورودی منتقل می‌کند.
move To Spam()	Gmail Thread	این تاپیک رو به اسپم منتقل میکنه.
move To Trash()	Gmail Thread	این تاپیک را به سطل زباله منتقل می‌کند.
refresh()	Gmail Thread	این رشته و وضعیت مرتبط با آن را از Gmail مجدداً بارگذاری می‌کند (در صورتی که برچسب‌ها، وضعیت خوانده شدن و غیره تغییر کرده باشند، مفید است).
remove Label(label)	Gmail Thread	این برچسب را از تاپیک حذف می‌کند.
reply(body)	Gmail Thread	با استفاده از آدرس replyTo به فرستنده آخرین پیام در این تاپیک پاسخ دهید.
reply(body, options)	Gmail Thread	با استفاده از آدرس replyTo، با آرگومان‌های اختیاری، به فرستنده آخرین پیام در این تاپیک پاسخ دهید.
reply All(body)	Gmail Thread	به فرستنده (با استفاده از آدرس replyTo) و تمام گیرندگان آخرین پیام در این رشته پاسخ دهید.
reply All(body, options)	Gmail Thread	به فرستنده (با استفاده از آدرس reply To ) و تمام گیرندگان آخرین پیام در این رشته، با آرگومان‌های اختیاری پاسخ دهید.

مستندات دقیق

addLabel(label)

این برچسب را به موضوع اضافه می‌کند.

// Add label MyLabel to the first thread in the inbox
const label = GmailApp.getUserLabelByName('MyLabel');
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.addLabel(label);

پارامترها

نام	نوع	توضیحات
label	Gmail Label	برچسبی که باید به این تاپیک اعمال شود

بازگشت

GmailThread — این تاپیک، برای زنجیره‌سازی مفید است

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• removeLabel(label)

---

createDraftReply(body)

با استفاده از آدرس پاسخ، یک پیام پیش‌نویس در پاسخ به فرستنده آخرین پیام در این موضوع ایجاد می‌کند. اندازه ایمیل (شامل هدرها) محدود به سهمیه است.

// Create a draft reply to the message author with an acknowledgement.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.createDraftReply('Got your message');

پارامترها

نام	نوع	توضیحات
body	String	بدنه ایمیل

بازگشت

GmailDraft - پیام پیش‌نویس تازه ایجاد شده

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• reply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body)
• createDraftReplyAll(body, options)

---

createDraftReply(body, options)

با استفاده از آدرس پاسخ، یک پیام پیش‌نویس در پاسخ به فرستنده آخرین پیام در این موضوع ایجاد می‌کند، که آرگومان‌های آن اختیاری است.

ایمیل می‌تواند شامل متن ساده و بدنه HTML باشد. اندازه ایمیل (شامل هدرها) محدودیت سهمیه‌ای دارد.

// Create a draft response with an HTML text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.createDraftReply('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: '[e-mail]',
});

پارامترها

نام	نوع	توضیحات
body	String	بدنه ایمیل
options	Object	یک شیء جاوا اسکریپت که پارامترهای پیشرفته را مشخص می‌کند، همانطور که در زیر فهرست شده است

پارامترهای پیشرفته

نام	نوع	توضیحات
attachments	Blob Source[]	مجموعه‌ای از فایل‌ها برای ارسال با ایمیل
bcc	String	فهرستی از آدرس‌های ایمیل که با کاما از هم جدا شده‌اند و در BCC قرار می‌گیرند.
cc	String	فهرستی از آدرس‌های ایمیل که با کاما از هم جدا شده‌اند، به CC
from	String	آدرسی که ایمیل باید از آن ارسال شود، که باید یکی از مقادیر برگردانده شده توسط Gmail App.getAliases() باشد.
html Body	String	اگر تنظیم شود، دستگاه‌هایی که قادر به رندر HTML هستند، به جای آرگومان مورد نیاز body از آن استفاده می‌کنند؛ اگر برای ایمیل خود تصاویر درون‌خطی دارید، می‌توانید یک فیلد inline Images اختیاری در بدنه HTML اضافه کنید.
inline Images	Object	یک شیء جاوا اسکریپت حاوی نگاشتی از کلید تصویر ( String ) به داده‌های تصویر ( Blob Source )؛ این فرض می‌کند که از پارامتر html Body استفاده شده است و شامل ارجاعاتی به این تصاویر در قالب <img src="cid:imageKey" />
name	String	نام فرستنده ایمیل (پیش‌فرض: نام کاربر)
reply To	String	یک آدرس ایمیل برای استفاده به عنوان آدرس پیش‌فرض پاسخ (پیش‌فرض: آدرس ایمیل کاربر)
subject	String	یک خط موضوع جدید برای ایمیل (حداکثر ۲۵۰ کاراکتر)

بازگشت

GmailDraft - پیام پیش‌نویس تازه ایجاد شده

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• reply(body, options)
• createDraftReply(body)
• createDraftReplyAll(body)
• createDraftReplyAll(body, options)

---

createDraftReplyAll(body)

با استفاده از آدرس پاسخ و تمام گیرندگان این پیام، یک پیام پیش‌نویس در پاسخ به فرستنده آخرین پیام در این رشته ایجاد می‌کند. اندازه ایمیل (شامل هدرها) محدود است.

// Create a draft reply to all recipients (except those bcc'd) of the last email
// in this thread.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReplyAll('Got your message');

پارامترها

نام	نوع	توضیحات
body	String	بدنه ایمیل

بازگشت

GmailDraft - پیام پیش‌نویس تازه ایجاد شده

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• replyAll(body)
• createDraftReply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body, options)

---

createDraftReplyAll(body, options)

یک پیام پیش‌نویس در پاسخ به فرستنده آخرین پیام در این رشته، با استفاده از آدرس پاسخ و همه گیرندگان، با آرگومان‌های اختیاری ایجاد می‌کند.

ایمیل می‌تواند شامل متن ساده و بدنه HTML باشد. اندازه ایمیل (شامل هدرها) محدودیت سهمیه‌ای دارد.

// Create a draft reply, using an HTML text body, to all recipients (except
// those bcc'd) of the last email of in this thread.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.createDraftReplyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: '[e-mail]',
});

پارامترها

نام	نوع	توضیحات
body	String	بدنه ایمیل
options	Object	یک شیء جاوا اسکریپت که پارامترهای پیشرفته را مشخص می‌کند، همانطور که در زیر فهرست شده است

پارامترهای پیشرفته

نام	نوع	توضیحات
attachments	Blob Source[]	مجموعه‌ای از فایل‌ها برای ارسال با ایمیل
bcc	String	فهرستی از آدرس‌های ایمیل که با کاما از هم جدا شده‌اند و در BCC قرار می‌گیرند.
cc	String	فهرستی از آدرس‌های ایمیل که با کاما از هم جدا شده‌اند، به CC
from	String	آدرسی که ایمیل باید از آن ارسال شود، که باید یکی از مقادیر برگردانده شده توسط Gmail App.getAliases() باشد.
html Body	String	اگر تنظیم شود، دستگاه‌هایی که قادر به رندر HTML هستند، به جای آرگومان مورد نیاز body از آن استفاده می‌کنند؛ اگر برای ایمیل خود تصاویر درون‌خطی دارید، می‌توانید یک فیلد inline Images اختیاری در بدنه HTML اضافه کنید.
inline Images	Object	یک شیء جاوا اسکریپت حاوی نگاشتی از کلید تصویر ( String ) به داده‌های تصویر ( Blob Source )؛ این فرض می‌کند که از پارامتر html Body استفاده شده است و شامل ارجاعاتی به این تصاویر در قالب <img src="cid:imageKey" />
name	String	نام فرستنده ایمیل (پیش‌فرض: نام کاربر)
reply To	String	یک آدرس ایمیل برای استفاده به عنوان آدرس پیش‌فرض پاسخ (پیش‌فرض: آدرس ایمیل کاربر)
subject	String	یک خط موضوع جدید برای ایمیل. حداکثر اندازه ۲۵۰ کاراکتر است.

بازگشت

GmailDraft - پیام پیش‌نویس تازه ایجاد شده

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• replyAll(body, options)
• createDraftReply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body)

---

getFirstMessageSubject()

موضوع اولین پیام در رشته پیام‌ها را دریافت می‌کند.

// Log the subject of the first message in the first thread in the inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(firstThread.getFirstMessageSubject());

بازگشت

String - موضوع اولین پیام در رشته

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• getLastMessageDate()

---

getId()

شناسه‌ی این رشته را دریافت می‌کند. شناسه‌ی یک رشته بسته به پیام‌هایی که در آن وجود دارد متفاوت است؛ برای داشتن یک شناسه‌ی ثابت برای یک پیام خاص در رشته، به جای آن getMessages()[0].getId() را فراخوانی کنید.

// Log the subject of the first message in the first thread in the inbox.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const id = firstThread.getId();
// Get same thread by its ID.
const thread = GmailApp.getThreadById(id);
Logger.log(
    thread.getFirstMessageSubject() === firstThread.getFirstMessageSubject(),
);  // True

بازگشت

String - شناسه این نخ

---

getLabels()

برچسب‌های ایجاد شده توسط کاربر در این موضوع را برمی‌گرداند.

// Log the names of the labels attached to the first thread in the inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const labels = firstThread.getLabels();
for (let i = 0; i < labels.length; i++) {
  Logger.log(labels[i].getName());
}

بازگشت

GmailLabel[] — آرایه‌ای از برچسب‌ها برای این رشته

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

---

getLastMessageDate()

تاریخ آخرین پیام این تاپیک را دریافت می‌کند.

// Log the date of the most recent message on the first thread in the inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(firstThread.getLastMessageDate());

بازگشت

Date — تاریخ آخرین پیام در تاپیک

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• getFirstMessageSubject()

---

getMessageCount()

تعداد پیام‌های موجود در رشته را برمی‌گرداند.

// Log the number of messages in the thread
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(firstThread.getMessageCount());

بازگشت

Integer - تعداد پیام‌های موجود در رشته پیام‌ها

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• getMessages()

---

getMessages()

پیام‌های این تاپیک را دریافت می‌کند.

// Log the subjects of the messages in the thread
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const messages = firstThread.getMessages();
for (let i = 0; i < messages.length; i++) {
  Logger.log(messages[i].getSubject());
}

بازگشت

GmailMessage[] — آرایه‌ای از پیام‌های Gmail در این تاپیک

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• getMessageCount()

---

getPermalink()

برای این تاپیک یک پیوند دائمی دریافت می‌کند.

توجه داشته باشید که این روش فقط با رابط کاربری کلاسیک جیمیل کار می‌کند، نه با اینباکس.

// Logs the permalink for the first thread in the inbox
const thread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(thread.getPermalink());

بازگشت

String - پیوند دائمی برای این موضوع

---

hasStarredMessages()

برمی‌گرداند که آیا رشته پیام‌های ستاره‌دار دارد یا خیر.

// Log if this thread has starred messages
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(`has starred : ${firstThread.hasStarredMessages()}`);

بازگشت

Boolean - اگر رشته پیام‌های ستاره‌دار داشته باشد، مقدار true را برمی‌گرداند.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

---

isImportant()

برمی‌گرداند که آیا موضوع به عنوان مهم علامت‌گذاری شده است یا خیر.

// Log if this thread is marked as important
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(`Important? : ${firstThread.isImportant()}`);

بازگشت

Boolean - اینکه آیا موضوع به عنوان مهم علامت گذاری شده است یا خیر.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

---

isInChats()

برمی‌گرداند که آیا موضوع مورد بحث، چت (chat) نامگذاری شده است یا خیر.

// Log if this thread is a chat
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(`is in chats? : ${firstThread.isInChats()}`);

بازگشت

Boolean - اگر موضوع به عنوان چت برچسب گذاری شده باشد، درست است.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

---

isInInbox()

برمی‌گرداند که آیا موضوع در صندوق ورودی قرار دارد یا خیر.

// Log if this thread is in the inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(`is in the inbox? : ${firstThread.isInInbox()}`);

بازگشت

Boolean - اگر موضوع در صندوق ورودی باشد، درست است.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

---

isInPriorityInbox()

اگر این رشته در صندوق ورودی اولویت‌دار باشد، مقدار true و در غیر این صورت مقدار false را برمی‌گرداند.

// Log if this thread is in the priority inbox
const firstThread = GmailApp.getPriorityInboxThreads(0, 1)[0];
Logger.log(`is in priority inbox? ${firstThread.isInPriorityInbox()}`);

بازگشت

Boolean - اگر موضوع در صندوق ورودی اولویت‌دار باشد، درست است.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

---

isInSpam()

برمی‌گرداند که آیا تاپیک به عنوان هرزنامه علامت‌گذاری شده است یا خیر.

// Log if this thread is in the spam folder
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(`Spam? ${firstThread.isInSpam()}`);

بازگشت

Boolean - آیا این تاپیک به عنوان هرزنامه علامت‌گذاری شده است یا خیر.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

---

isInTrash()

برمی‌گرداند که آیا رشته در سطل زباله قرار دارد یا خیر.

// Log if this thread is in the trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(`Trashed? ${firstThread.isInTrash()}`);

بازگشت

Boolean - اگر نخ در سطل زباله باشد، درست است.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

---

isUnread()

برمی‌گرداند که آیا رشته پیام‌های خوانده نشده‌ای دارد یا خیر.

// Log if this thread is unread
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(`Unread? ${firstThread.isUnread()}`);

بازگشت

Boolean - اگر پیام‌های خوانده نشده وجود داشته باشد، مقدار true را برمی‌گرداند.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

---

markImportant()

این تاپیک را به عنوان تاپیک مهم علامت گذاری می‌کند.

// Mark first inbox thread as important
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.markImportant();

بازگشت

GmailThread — این تاپیک، برای زنجیره‌سازی مفید است

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• markUnimportant()

---

markRead()

این تاپیک را به عنوان خوانده شده علامت گذاری می کند.

// Mark first inbox thread as read
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.markRead();

بازگشت

GmailThread — این تاپیک، برای زنجیره‌سازی مفید است

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• markUnread()

---

markUnimportant()

این تاپیک را به عنوان بی‌اهمیت علامت‌گذاری می‌کند.

// Mark first inbox thread as unimportant
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.markUnimportant();

بازگشت

GmailThread — این تاپیک، برای زنجیره‌سازی مفید است

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• markImportant()

---

markUnread()

این تاپیک را به عنوان خوانده نشده علامت گذاری می کند.

// Mark first inbox thread as unread
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.markUnread();

بازگشت

GmailThread — این تاپیک، برای زنجیره‌سازی مفید است

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• markRead()

---

moveToArchive()

این تاپیک را به بایگانی منتقل می‌کند.

// Archive first inbox thread
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.moveToArchive();

بازگشت

GmailThread — این تاپیک، برای زنجیره‌سازی مفید است

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

---

moveToInbox()

این تاپیک را به صندوق ورودی منتقل می‌کند.

// Move first non-inbox thread to inbox
const firstThread = GmailApp.search('-in:inbox')[0];
firstThread.moveToInbox();

بازگشت

GmailThread — این تاپیک، برای زنجیره‌سازی مفید است

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

---

moveToSpam()

این تاپیک رو به اسپم منتقل میکنه.

// Move first inbox thread to spam
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.moveToSpam();

بازگشت

GmailThread — این تاپیک، برای زنجیره‌سازی مفید است

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

---

moveToTrash()

این تاپیک را به سطل زباله منتقل می‌کند.

// Move first inbox thread to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.moveToTrash();

بازگشت

GmailThread — این تاپیک، برای زنجیره‌سازی مفید است

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

---

refresh()

این رشته و وضعیت مرتبط با آن را از Gmail مجدداً بارگذاری می‌کند (در صورتی که برچسب‌ها، وضعیت خوانده شدن و غیره تغییر کرده باشند، مفید است).

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
// ...Do something that may take a while here....
firstThread.refresh();  // Make sure it's up-to-date
// ...Do more stuff with firstThread ...

بازگشت

GmailThread — این تاپیک، برای زنجیره‌سازی مفید است

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

---

removeLabel(label)

این برچسب را از تاپیک حذف می‌کند.

const myLabel = GmailApp.getUserLabelByName('<your label>');
const threads = myLabel.getThreads();
for (const thread of threads) {
  thread.removeLabel(myLabel);
}

پارامترها

نام	نوع	توضیحات
label	Gmail Label	برچسبی که باید از این تاپیک حذف شود

بازگشت

GmailThread — این تاپیک، برای زنجیره‌سازی مفید است

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• addLabel(label)

---

reply(body)

با استفاده از آدرس replyTo به فرستنده آخرین پیام در این تاپیک پاسخ دهید.

توجه داشته باشید که حجم کل ایمیل (شامل تمام سربرگ‌ها) نباید از 20 کیلوبایت تجاوز کند.

// Respond to author of last email in thread with acknowledgment
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.reply('Got your message');

پارامترها

نام	نوع	توضیحات
body	String	بدنه ایمیل

بازگشت

GmailThread — این تاپیک، برای زنجیره‌سازی مفید است

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• reply(body, options)
• replyAll(body)
• replyAll(body, options)

---

reply(body, options)

با استفاده از آدرس replyTo، با آرگومان‌های اختیاری، به فرستنده آخرین پیام در این تاپیک پاسخ دهید. ایمیل می‌تواند شامل متن ساده و همچنین بدنه HTML باشد. توجه داشته باشید که حجم کل ایمیل (شامل تمام هدرها، اما بدون پیوست‌ها) نباید از 20 کیلوبایت تجاوز کند.

// Respond with HTML body text.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.reply('incapable of HTML', {
  htmlBody: 'some HTML body text',
  noReply: true,
});

پارامترها

نام	نوع	توضیحات
body	String	بدنه ایمیل
options	Object	یک شیء جاوا اسکریپت که پارامترهای پیشرفته را مشخص می‌کند، همانطور که در زیر فهرست شده است

پارامترهای پیشرفته

نام	نوع	توضیحات
cc	String	فهرستی از آدرس‌های ایمیل که با کاما جدا شده‌اند به CC
bcc	String	فهرستی از آدرس‌های ایمیل که با کاما جدا شده‌اند و در BCC قرار می‌گیرند.
html Body	String	اگر تنظیم شود، دستگاه‌هایی که قادر به رندر HTML هستند، به جای آرگومان مورد نیاز body از آن استفاده می‌کنند؛ اگر برای ایمیل خود تصاویر درون‌خطی دارید، می‌توانید یک فیلد inline Images اختیاری در بدنه HTML اضافه کنید.
name	String	نام فرستنده ایمیل (پیش‌فرض: نام کاربر)
from	String	آدرسی که ایمیل باید از آن ارسال شود، که باید یکی از مقادیر برگردانده شده توسط Gmail App.getAliases() باشد.
reply To	String	یک آدرس ایمیل برای استفاده به عنوان آدرس پیش‌فرض پاسخ (پیش‌فرض: آدرس ایمیل کاربر)
no Reply	Boolean	اگر ایمیل باید از یک آدرس ایمیل عمومی بدون پاسخ ارسال شود تا گیرندگان از پاسخ دادن به ایمیل‌ها منصرف شوند، true ؛ این گزینه فقط برای حساب‌های Google Workspace امکان‌پذیر است، نه کاربران Gmail
attachments	Blob Source[]	مجموعه‌ای از فایل‌ها برای ارسال با ایمیل
inline Images	Object	یک شیء جاوا اسکریپت حاوی نگاشتی از کلید تصویر ( String ) به داده‌های تصویر ( Blob Source )؛ این فرض می‌کند که از پارامتر html Body استفاده شده است و شامل ارجاعاتی به این تصاویر در قالب <img src="cid:imageKey" />

بازگشت

GmailThread — این تاپیک، برای زنجیره‌سازی مفید است

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• reply(body)
• replyAll(body)
• replyAll(body, options)

---

replyAll(body)

به فرستنده (با استفاده از آدرس replyTo) و تمام گیرندگان آخرین پیام در این رشته پاسخ دهید.

توجه داشته باشید که حجم کل ایمیل (شامل تمام سربرگ‌ها) نباید از 20 کیلوبایت تجاوز کند.

// Respond to all with acknowledgment to the first thread in the inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.replyAll('Got your message');

پارامترها

نام	نوع	توضیحات
body	String	بدنه ایمیل

بازگشت

GmailThread — این تاپیک، برای زنجیره‌سازی مفید است

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• reply(body, options)
• reply(body)
• replyAll(body, options)

---

replyAll(body, options)

به فرستنده (با استفاده از آدرس replyTo ) و تمام گیرندگان آخرین پیام در این تاپیک، با آرگومان‌های اختیاری، پاسخ دهید. ایمیل می‌تواند شامل متن ساده و همچنین بدنه HTML باشد. توجه داشته باشید که حجم کل ایمیل (شامل تمام هدرها، اما بدون پیوست‌ها) نباید از 20 کیلوبایت تجاوز کند.

// Respond with HTML body text.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.replyAll('incapable of HTML', {
  htmlBody: 'some HTML body text',
  noReply: true,
});

پارامترها

نام	نوع	توضیحات
body	String	بدنه ایمیل
options	Object	یک شیء جاوا اسکریپت که پارامترهای پیشرفته را مشخص می‌کند، همانطور که در زیر فهرست شده است

پارامترهای پیشرفته

نام	نوع	توضیحات
cc	String	فهرستی از آدرس‌های ایمیل که با کاما جدا شده‌اند به CC
bcc	String	فهرستی از آدرس‌های ایمیل که با کاما جدا شده‌اند و در BCC قرار می‌گیرند.
html Body	String	اگر تنظیم شود، دستگاه‌هایی که قادر به رندر HTML هستند، به جای آرگومان مورد نیاز body از آن استفاده می‌کنند؛ اگر برای ایمیل خود تصاویر درون‌خطی دارید، می‌توانید یک فیلد inline Images اختیاری در بدنه HTML اضافه کنید.
name	String	نام فرستنده ایمیل (پیش‌فرض: نام کاربر)
from	String	آدرسی که ایمیل باید از آن ارسال شود، که باید یکی از مقادیر برگردانده شده توسط Gmail App.getAliases() باشد.
reply To	String	یک آدرس ایمیل برای استفاده به عنوان آدرس پیش‌فرض پاسخ (پیش‌فرض: آدرس ایمیل کاربر)
no Reply	Boolean	اگر ایمیل باید از یک آدرس ایمیل عمومی بدون پاسخ ارسال شود تا گیرندگان از پاسخ دادن به ایمیل‌ها منصرف شوند، true ؛ این گزینه فقط برای حساب‌های G Suite امکان‌پذیر است، نه کاربران Gmail
attachments	Blob Source[]	مجموعه‌ای از فایل‌ها برای ارسال با ایمیل
inline Images	Object	یک شیء جاوا اسکریپت حاوی نگاشتی از کلید تصویر ( String ) به داده‌های تصویر ( Blob Source )؛ این فرض می‌کند که از پارامتر html Body استفاده شده است و شامل ارجاعاتی به این تصاویر در قالب <img src="cid:imageKey" />

بازگشت

GmailThread — این تاپیک، برای زنجیره‌سازی مفید است

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر یا حوزه‌های مناسب از REST API مرتبط دارند:

• https://mail.google.com/

همچنین ببینید

• reply(body)
• replyAll(body)
• replyAll(body, options)