این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Class GmailMessage

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

مواد و روش ها

روش	نوع برگشت	توضیح مختصر
`createDraftReply(body)`	`GmailDraft`	یک پیش نویس پیام ایجاد می کند که با استفاده از آدرس پاسخ به فرستنده این پیام را پاسخ می دهد.
`createDraftReply(body, options)`	`GmailDraft`	یک پیام پیش نویس ایجاد می کند که با استفاده از آدرس پاسخ به این پیام، با آرگومان های اختیاری به فرستنده این پیام پاسخ می دهد.
`createDraftReplyAll(body)`	`GmailDraft`	یک پیام پیش نویس ایجاد می کند که با استفاده از آدرس پاسخ به فرستنده و همه گیرندگان این پیام به فرستنده پاسخ می دهد.
`createDraftReplyAll(body, options)`	`GmailDraft`	یک پیام پیش نویس ایجاد می کند که با استفاده از آدرس پاسخ به این پیام و همه گیرندگان، با آرگومان های اختیاری به فرستنده این پیام پاسخ می دهد.
`forward(recipient)`	`GmailMessage`	این پیام را برای گیرندگان جدید بازارسال می کند.
`forward(recipient, options)`	`GmailMessage`	این پیام را با آرگومان های اختیاری به گیرندگان جدید فوروارد می کند.
`getAttachments()`	`GmailAttachment[]`	تمام پیوست های این پیام را دریافت می کند.
`getAttachments(options)`	`GmailAttachment[]`	تمام پیوست های این پیام را دریافت می کند.
`getBcc()`	`String`	گیرندگانی که با کاما از هم جدا شده اند را روی این پیام bcc'd می کند.
`getBody()`	`String`	محتوای HTML متن این پیام را دریافت می کند.
`getCc()`	`String`	گیرندگان جدا شده با کاما را در این پیام cc'd می کند.
`getDate()`	`Date`	تاریخ و زمان این پیام را دریافت می کند.
`getFrom()`	`String`	فرستنده این پیام را دریافت می کند.
`getHeader(name)`	`String`	با توجه به نام هدر، مقدار یک هدر RFC 2822 را دریافت می کند.
`getId()`	`String`	شناسه این پیام را دریافت می کند.
`getPlainBody()`	`String`	محتوای متن این پیام را بدون قالب بندی HTML دریافت می کند.
`getRawContent()`	`String`	محتوای خام این پیام را دریافت می کند.
`getReplyTo()`	`String`	آدرس پاسخ به این پیام (معمولاً فرستنده) را دریافت می کند.
`getSubject()`	`String`	موضوع این پیام را دریافت می کند.
`getThread()`	`GmailThread`	رشته ای را دریافت می کند که حاوی این پیام است.
`getTo()`	`String`	گیرندگان این پیام را که با کاما از هم جدا شده اند دریافت می کند.
`isDraft()`	`Boolean`	متوجه می شود که آیا این پیام پیش نویس است یا خیر.
`isInChats()`	`Boolean`	متوجه می شود که آیا این پیام یک چت است یا خیر.
`isInInbox()`	`Boolean`	متوجه می شود که آیا این پیام در صندوق ورودی است یا خیر.
`isInPriorityInbox()`	`Boolean`	اگر این پیام در صندوق ورودی اولویت قرار داشته باشد، `true` برمی گردد. در غیر این صورت `false` برمی گرداند.
`isInTrash()`	`Boolean`	متوجه می شود که آیا این پیام در سطل زباله است.
`isStarred()`	`Boolean`	متوجه می شود که آیا این پیام ستاره دار است یا خیر.
`isUnread()`	`Boolean`	متوجه می شود که آیا این پیام خوانده نشده است یا خیر.
`markRead()`	`GmailMessage`	پیام را به عنوان خوانده شده علامت گذاری می کند.
`markUnread()`	`GmailMessage`	پیام را به عنوان خوانده نشده علامت گذاری می کند.
`moveToTrash()`	`GmailMessage`	پیام را به سطل زباله منتقل می کند.
`refresh()`	`GmailMessage`	این پیام و وضعیت مرتبط را از Gmail مجدداً بارگیری می‌کند (در مواردی که برچسب‌ها، وضعیت خواندن و غیره تغییر کرده باشند مفید است).
`reply(body)`	`GmailMessage`	با استفاده از آدرس پاسخ به فرستنده این پیام را پاسخ می دهد.
`reply(body, options)`	`GmailMessage`	با استفاده از آدرس پاسخ به، با آرگومان های اختیاری به فرستنده این پیام پاسخ می دهد.
`replyAll(body)`	`GmailMessage`	به فرستنده با استفاده از آدرس پاسخ به و همه گیرندگان این پیام پاسخ می دهد.
`replyAll(body, options)`	`GmailMessage`	به فرستنده این پیام با استفاده از آدرس پاسخ به و همه گیرندگان، با آرگومان های اختیاری پاسخ می دهد.
`star()`	`GmailMessage`	پیام را ستاره می دهد.
`unstar()`	`GmailMessage`	پیام را از ستاره خارج می کند.

مستندات دقیق

`createDraftReply(body)`

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

// Create a draft reply to the original message with an acknowledgment.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReply("Got your message");

مولفه های

نام	تایپ کنید	شرح
`body`	`String`	بدنه ایمیل.

برگشت

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

مجوز

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

https://mail.google.com/

`createDraftReply(body, options)`

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

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

// Create a draft response with an HTML text body.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReply("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "another@example.com"
});

مولفه های

نام	تایپ کنید	شرح
`body`	`String`	بدنه ایمیل.
`options`	`Object`	یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند.

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

نام	تایپ کنید	شرح
`attachments`	`BlobSource[]`	مجموعه ای از فایل ها برای ارسال با ایمیل
`bcc`	`String`	فهرستی از آدرس‌های ایمیل به BCC که با کاما از هم جدا شده‌اند
`cc`	`String`	فهرستی از آدرس‌های ایمیل به CC جدا شده با کاما
`from`	`String`	آدرسی که ایمیل باید از آن ارسال شود، که باید یکی از مقادیر بازگردانده شده توسط `GmailApp.getAliases()` باشد.
`htmlBody`	`String`	هنگامی که تنظیم می شود، دستگاه هایی که قادر به ارائه HTML هستند به جای آرگومان بدن مورد نیاز از آن استفاده می کنند. اگر برای ایمیل خود تصاویر درون خطی دارید، می توانید یک فیلد `inlineImages` اختیاری در متن HTML اضافه کنید
`inlineImages`	`Object`	یک شی جاوا اسکریپت حاوی نگاشت از کلید تصویر ( `String` ) به داده های تصویر ( `BlobSource` ). فرض بر این است که پارامتر `htmlBody` استفاده شده است و حاوی ارجاعاتی به این تصاویر در قالب `<img src="cid:imageKey" />` است.
`name`	`String`	نام فرستنده ایمیل (پیش‌فرض: نام کاربر)
`replyTo`	`String`	یک آدرس ایمیل برای استفاده به عنوان آدرس پیش فرض پاسخ به (پیش فرض: آدرس ایمیل کاربر)
`subject`	`String`	یک خط موضوع جدید برای ایمیل، حداکثر تا 250 کاراکتر.

برگشت

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

مجوز

https://mail.google.com/

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

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

`createDraftReplyAll(body)`

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

// Create a draft response to all recipients (except those bcc'd) with an acknowledgment.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReplyAll("Got your message");

مولفه های

نام	تایپ کنید	شرح
`body`	`String`	بدنه ایمیل.

برگشت

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

مجوز

https://mail.google.com/

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

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

`createDraftReplyAll(body, options)`

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

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

// Create a draft response to all recipients (except those bcc'd) using an HTML text body.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReplyAll("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "another@example.com"
});

مولفه های

نام	تایپ کنید	شرح
`body`	`String`	بدنه ایمیل.
`options`	`Object`	یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند.

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

نام	تایپ کنید	شرح
`attachments`	`BlobSource[]`	مجموعه ای از فایل ها برای ارسال با ایمیل
`bcc`	`String`	فهرستی از آدرس‌های ایمیل به BCC که با کاما از هم جدا شده‌اند
`cc`	`String`	فهرستی از آدرس‌های ایمیل به CC جدا شده با کاما
`from`	`String`	آدرسی که ایمیل باید از آن ارسال شود، که باید یکی از مقادیر بازگردانده شده توسط `GmailApp.getAliases()` باشد.
`htmlBody`	`String`	هنگامی که تنظیم می شود، دستگاه هایی که قادر به ارائه HTML هستند به جای آرگومان بدن مورد نیاز از آن استفاده می کنند. اگر برای ایمیل خود تصاویر درون خطی دارید، می توانید یک فیلد `inlineImages` اختیاری در متن HTML اضافه کنید
`inlineImages`	`Object`	یک شی جاوا اسکریپت حاوی نگاشت از کلید تصویر ( `String` ) به داده های تصویر ( `BlobSource` ). فرض بر این است که پارامتر `htmlBody` استفاده شده است و حاوی ارجاعاتی به این تصاویر در قالب `<img src="cid:imageKey" />` است.
`name`	`String`	نام فرستنده ایمیل (پیش‌فرض: نام کاربر)
`replyTo`	`String`	یک آدرس ایمیل برای استفاده به عنوان آدرس پیش فرض پاسخ به (پیش فرض: آدرس ایمیل کاربر)
`subject`	`String`	یک خط موضوع جدید برای ایمیل، حداکثر تا 250 کاراکتر.

برگشت

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

مجوز

https://mail.google.com/

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

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

`forward(recipient)`

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

// Forward first message of first inbox thread to recipient1 & recipient2, both @example.com
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("recipient1@example.com,recipient2@example.com");

مولفه های

نام	تایپ کنید	شرح
`recipient`	`String`	فهرستی از آدرس‌های ایمیل جدا شده با کاما.

برگشت

GmailMessage - این پیام برای زنجیره‌سازی مفید است.

مجوز

https://mail.google.com/

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

forward(recipient, options)

`forward(recipient, options)`

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

ایمیل می تواند شامل متن ساده و همچنین یک متن HTML باشد. اندازه ایمیل (شامل سرصفحه ها) محدود است.

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("recipient1@example.com,recipient2@example.com", {
  cc: "myboss@example.com",
  bcc: "mybosses-boss@example.com,vp@example.com"
});

مولفه های

نام	تایپ کنید	شرح
`recipient`	`String`	فهرستی از آدرس‌های ایمیل جدا شده با کاما.
`options`	`Object`	یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند.

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

نام	تایپ کنید	شرح
`attachments`	`BlobSource[]`	مجموعه ای از فایل ها برای ارسال با ایمیل
`bcc`	`String`	فهرستی از آدرس‌های ایمیل به BCC که با کاما از هم جدا شده‌اند
`cc`	`String`	فهرستی از آدرس‌های ایمیل به CC جدا شده با کاما
`from`	`String`	آدرسی که ایمیل باید از آن ارسال شود، که باید یکی از مقادیر بازگردانده شده توسط `GmailApp.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`	یک آدرس ایمیل برای استفاده به عنوان آدرس پیش فرض پاسخ به (پیش فرض: آدرس ایمیل کاربر)
`subject`	`String`	یک خط موضوع جدید برای ایمیل، حداکثر تا 250 کاراکتر.

برگشت

GmailMessage - این پیام برای زنجیره‌سازی مفید است.

مجوز

https://mail.google.com/

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

forward(recipient)

`getAttachments()`

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

برگشت

GmailAttachment[] - آرایه ای از پیوست های Blob برای این پیام.

مجوز

https://mail.google.com/

`getAttachments(options)`

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

مولفه های

نام	تایپ کنید	شرح
`options`	`Object`	یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند.

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

نام	تایپ کنید	شرح
`includeInlineImages`	`Boolean`	`true` اگر آرایه بازگشتی از پیوست های Blob باید شامل تصاویر درون خطی باشد (پیش فرض `true` است).
`includeAttachments`	`Boolean`	`true` اگر آرایه برگشتی از پیوست های Blob باید شامل پیوست های معمولی (غیر خطی) باشد (پیش فرض `true` است).

برگشت

GmailAttachment[] - آرایه ای از پیوست های Blob برای این پیام.

مجوز

https://mail.google.com/

`getBcc()`

گیرندگانی که با کاما از هم جدا شده اند را روی این پیام bcc'd می کند.

این برای همه پیام های دریافتی، طبق تعریف خالی است.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getBcc()); // Log bcc'd addresses

برگشت

String - گیرندگانی که با کاما از هم جدا شده اند روی این پیام bcc'd شده اند.

مجوز

https://mail.google.com/

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

getTo()

`getBody()`

محتوای HTML متن این پیام را دریافت می کند.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getBody()); // Log contents of the body

برگشت

String - محتوای بدنه این پیام.

مجوز

https://mail.google.com/

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

getSubject()

`getCc()`

گیرندگان جدا شده با کاما را در این پیام cc'd می کند.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getCc()); // Log cc'd addresses

برگشت

String - گیرندگانی که با کاما از هم جدا شده اند روی این پیام قید شده اند.

مجوز

https://mail.google.com/

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

getTo()

`getDate()`

تاریخ و زمان این پیام را دریافت می کند.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getDate()); // Log date and time of the message

برگشت

Date - تاریخ و زمان این پیام.

مجوز

https://mail.google.com/

`getFrom()`

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getFrom()); // Log from address of the message

برگشت

String - آدرس ایمیل فرستنده پیام.

مجوز

https://mail.google.com/

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

getReplyTo()

`getHeader(name)`

مقدار هدر RFC 2822 را با توجه به نام هدر دریافت می کند.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox.
var message = thread.getMessages()[0];         // Get the first message.
Logger.log(message.getHeader("Message-ID"));   // Logs the Message-ID RFC 2822 header.

مولفه های

نام	تایپ کنید	شرح
`name`	`String`	نام سرصفحه RFC، بدون اینکه دو نقطه آن را از مقدار جدا کند.

برگشت

String - مقدار هدر یا یک رشته خالی اگر سرصفحه در پیام وجود نداشته باشد.

مجوز

https://mail.google.com/

`getId()`

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
var id = message.getId();
var messageById = GmailApp.getMessageById(id);
Logger.log(message.getSubject() == messageById.getMessage()); // Always logs true

برگشت

String - شناسه پیام.

`getPlainBody()`

محتوای متن این پیام را بدون قالب بندی HTML دریافت می کند. این پیچیده تر از getBody() است و زمان بیشتری می برد.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getPlainBody()); // Log contents of the body

برگشت

String - محتوای بدنه ساده این پیام.

مجوز

https://mail.google.com/

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

getSubject()

`getRawContent()`

محتوای خام این پیام را دریافت می کند. این معادل «نمایش اصلی» در رابط کاربری Gmail است.

برگشت

String - محتوای خام این پیام.

مجوز

https://mail.google.com/

`getReplyTo()`

آدرس پاسخ به این پیام (معمولاً فرستنده) را دریافت می کند.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getReplyTo()); // Logs reply-to address

برگشت

String - آدرس ایمیل برای پاسخ.

مجوز

https://mail.google.com/

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

getCc()

`getSubject()`

موضوع این پیام را دریافت می کند.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getSubject()); // Log subject line

برگشت

String - موضوع این پیام.

مجوز

https://mail.google.com/

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

getAttachments()

`getThread()`

رشته ای را دریافت می کند که حاوی این پیام است.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getThread().getFirstMessageSubject() ==
           thread.getFirstMessageSubject()); // Always logs true

برگشت

GmailThread - GmailThread که حاوی این پیام است.

مجوز

https://mail.google.com/

`getTo()`

گیرندگان این پیام را که با کاما از هم جدا شده اند دریافت می کند.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getTo()); // Log the recipient of message

برگشت

String - گیرندگان این پیام که با کاما از هم جدا شده اند.

مجوز

https://mail.google.com/

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

getCc()

`isDraft()`

متوجه می شود که آیا این پیام پیش نویس است یا خیر.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is draft? " + message.isDraft());

برگشت

Boolean - آیا این پیام یک پیش نویس است.

مجوز

https://mail.google.com/

`isInChats()`

متوجه می شود که آیا این پیام یک چت است یا خیر.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is a chat? " + message.isInChats());

برگشت

Boolean - آیا این پیام یک چت است.

`isInInbox()`

متوجه می شود که آیا این پیام در صندوق ورودی است یا خیر.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in inbox? " + message.isInInbox());

برگشت

Boolean - آیا این پیام در صندوق ورودی است.

مجوز

https://mail.google.com/

`isInPriorityInbox()`

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

var thread = GmailApp.getPriorityInboxThreads(0,1)[0]; // Get first thread in priority inbox
var messages = thread.getMessages();
for (var i = 0; i < messages.length; i++) {
  // At least one of the messages is in priority inbox
  Logger.log("is in priority inbox? " + messages[i].isInPriorityInbox());
}

برگشت

Boolean - آیا این پیام در صندوق ورودی اولویت قرار دارد یا خیر.

مجوز

https://mail.google.com/

`isInTrash()`

متوجه می شود که آیا این پیام در سطل زباله است یا خیر.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in the trash? " + message.isInTrash());

برگشت

Boolean - آیا این پیام در سطل زباله است.

`isStarred()`

متوجه می شود که آیا این پیام ستاره دار است یا خیر.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is starred? " + message.isStarred());

برگشت

Boolean - آیا این پیام ستاره دار است یا خیر.

`isUnread()`

متوجه می شود که آیا این پیام خوانده نشده است یا خیر.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is unread? " + message.isUnread());

برگشت

Boolean - وضعیت خوانده نشده این پیام.

مجوز

https://mail.google.com/

`markRead()`

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.markRead(); // Mark as read

برگشت

GmailMessage - این GmailMessage، برای زنجیره زدن مفید است.

مجوز

https://mail.google.com/

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

isUnread()

`markUnread()`

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.markUnread(); // Mark as unread

برگشت

GmailMessage - این GmailMessage، برای زنجیره زدن مفید است.

مجوز

https://mail.google.com/

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

isUnread()

`moveToTrash()`

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.moveToTrash(); // Move message to trash

برگشت

GmailMessage - این GmailMessage، برای زنجیره زدن مفید است.

مجوز

https://mail.google.com/

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

isInTrash()

`refresh()`

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
// .. Do bunch of stuff here
message.refresh(); // Make sure it's up to date
// Do more stuff to message

برگشت

GmailMessage - این پیام برای زنجیر کردن.

مجوز

https://mail.google.com/

`reply(body)`

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

// Respond to author of message with acknowledgment
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.reply("Got your message");

مولفه های

نام	تایپ کنید	شرح
`body`	`String`	بدنه ایمیل.

برگشت

GmailMessage - این پیام برای زنجیره‌سازی مفید است.

مجوز

https://mail.google.com/

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

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

`reply(body, options)`

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

ایمیل می تواند شامل متن ساده و همچنین یک متن HTML باشد. اندازه ایمیل (شامل سرصفحه ها) محدود است.

// Respond with HTML body text
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.reply("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  noReply: true
});

مولفه های

نام	تایپ کنید	شرح
`body`	`String`	بدنه ایمیل.
`options`	`Object`	یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند.

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

نام	تایپ کنید	شرح
`attachments`	`BlobSource[]`	مجموعه ای از فایل ها برای ارسال با ایمیل
`bcc`	`String`	فهرستی از آدرس‌های ایمیل به BCC که با کاما از هم جدا شده‌اند
`cc`	`String`	فهرستی از آدرس‌های ایمیل به CC جدا شده با کاما
`from`	`String`	آدرسی که ایمیل باید از آن ارسال شود، که باید یکی از مقادیر بازگردانده شده توسط `GmailApp.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`	یک آدرس ایمیل برای استفاده به عنوان آدرس پیش فرض پاسخ به (پیش فرض: آدرس ایمیل کاربر)
`subject`	`String`	یک خط موضوع جدید برای ایمیل، حداکثر تا 250 کاراکتر.

برگشت

GmailMessage - این پیام برای زنجیره‌سازی مفید است.

مجوز

https://mail.google.com/

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

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

`replyAll(body)`

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

// Respond to all recipients (except bcc'd) of last email in thread with acknowledgment
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.replyAll("Got your message");

مولفه های

نام	تایپ کنید	شرح
`body`	`String`	بدنه ایمیل.

برگشت

GmailMessage - این پیام برای زنجیره زدن مفید است.

مجوز

https://mail.google.com/

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

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

`replyAll(body, options)`

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

ایمیل می تواند شامل متن ساده و همچنین یک متن HTML باشد. اندازه ایمیل (شامل سرصفحه ها) محدود است.

// Respond with HTML body text
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
messageThread.replyAll("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  noReply: true
});

مولفه های

نام	تایپ کنید	شرح
`body`	`String`	بدنه ایمیل.
`options`	`Object`	یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند.

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

نام	تایپ کنید	شرح
`attachments`	`BlobSource[]`	مجموعه ای از فایل ها برای ارسال با ایمیل
`bcc`	`String`	فهرستی از آدرس‌های ایمیل به BCC که با کاما از هم جدا شده‌اند
`cc`	`String`	فهرستی از آدرس‌های ایمیل به CC جدا شده با کاما
`from`	`String`	آدرسی که ایمیل باید از آن ارسال شود، که باید یکی از مقادیر بازگردانده شده توسط `GmailApp.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`	یک آدرس ایمیل برای استفاده به عنوان آدرس پیش فرض پاسخ به (پیش فرض: آدرس ایمیل کاربر)
`subject`	`String`	یک خط موضوع جدید برای ایمیل، حداکثر تا 250 کاراکتر.

برگشت

GmailMessage - این پیام برای زنجیره‌سازی مفید است.

مجوز

https://mail.google.com/

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

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

`star()`

پیام را ستاره می دهد.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.star(); // Star the message

برگشت

GmailMessage - این GmailMessage، برای زنجیره زدن مفید است.

مجوز

https://mail.google.com/

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

unstar()

`unstar()`

پیام را از ستاره خارج می کند.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.unstar(); // Unstar the message

برگشت

GmailMessage - این GmailMessage، برای زنجیره زدن مفید است.

مجوز

https://mail.google.com/

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

star()