Class GmailMessage

جیمیل مسیج

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

روش‌ها

روش نوع بازگشتی شرح مختصر
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 با استفاده از آدرس پاسخ و همه گیرندگان، یک پیام پیش‌نویس در پاسخ به فرستنده این پیام ایجاد می‌کند، البته با آرگومان‌های اختیاری.
forward(recipient) Gmail Message این پیام را برای گیرندگان جدید ارسال می‌کند.
forward(recipient, options) Gmail Message این پیام را با آرگومان‌های اختیاری به گیرندگان جدید ارسال می‌کند.
get Attachments() Gmail Attachment[] تمام پیوست‌های این پیام را دریافت می‌کند.
get Attachments(options) Gmail Attachment[] تمام پیوست‌های این پیام را دریافت می‌کند.
get Bcc() String گیرندگان جدا شده با کاما را که در bcc پیام قرار دارند، دریافت می‌کند.
get Body() String محتوای HTML بدنه‌ی این پیام را دریافت می‌کند.
get Cc() String گیرندگان جدا شده با کاما را در cc'd این پیام دریافت می‌کند.
get Date() Date تاریخ و زمان این پیام را دریافت می‌کند.
get From() String فرستنده این پیام را دریافت می‌کند.
get Header(name) String مقدار یک هدر RFC 2822 را با توجه به نام هدر دریافت می‌کند.
get Id() String شناسه (ID) این پیام را دریافت می‌کند.
get Plain Body() String محتوای بدنه‌ی این پیام را بدون قالب‌بندی HTML دریافت می‌کند.
get Raw Content() String محتوای خام این پیام را دریافت می‌کند.
get Reply To() String آدرس پاسخ به این پیام (معمولاً فرستنده) را دریافت می‌کند.
get Subject() String موضوع این پیام را دریافت می‌کند.
get Thread() Gmail Thread رشته‌ای که حاوی این پیام است را دریافت می‌کند.
get To() String گیرندگان این پیام را که با کاما از هم جدا شده‌اند، دریافت می‌کند.
is Draft() Boolean مشخص می‌کند که آیا این پیام پیش‌نویس است یا خیر.
is In Chats() Boolean مشخص می‌کند که آیا این پیام، چت است یا خیر.
is In Inbox() Boolean دریافت می‌کند که آیا این پیام در صندوق ورودی است یا خیر.
is In Priority Inbox() Boolean اگر این پیام در صندوق ورودی اولویت‌دار باشد، مقدار true و در غیر این صورت false را برمی‌گرداند.
is In Trash() Boolean دریافت می‌کند که آیا این پیام در سطل زباله قرار دارد یا خیر.
is Starred() Boolean دریافت می‌کند که آیا این پیام ستاره‌دار است یا خیر.
is Unread() Boolean دریافت می‌کند که آیا این پیام خوانده نشده است یا خیر.
mark Read() Gmail Message پیام را به عنوان خوانده شده علامت گذاری می کند.
mark Unread() Gmail Message پیام را به عنوان خوانده نشده علامت گذاری می کند.
move To Trash() Gmail Message پیام را به سطل زباله منتقل می‌کند.
refresh() Gmail Message این پیام و وضعیت مرتبط با آن را از Gmail دوباره بارگذاری می‌کند (در صورتی که برچسب‌ها، وضعیت خوانده شدن و غیره تغییر کرده باشند، مفید است).
reply(body) Gmail Message با استفاده از آدرس پاسخ به فرستنده این پیام، به او پاسخ می‌دهد.
reply(body, options) Gmail Message با استفاده از آدرس پاسخ، با آرگومان‌های اختیاری، به فرستنده این پیام پاسخ می‌دهد.
reply All(body) Gmail Message با استفاده از آدرس پاسخ به فرستنده و همه گیرندگان این پیام پاسخ می‌دهد.
reply All(body, options) Gmail Message با استفاده از آدرس پاسخ و همه گیرندگان، به فرستنده این پیام پاسخ می‌دهد، با آرگومان‌های اختیاری.
star() Gmail Message پیام را ستاره‌گذاری می‌کند.
unstar() Gmail Message پیام را از حالت ستاره‌دار خارج می‌کند.

مستندات دقیق

createDraftReply(body)

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

// Create a draft reply to the original message with an acknowledgment.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 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/

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

createDraftReplyAll(body)

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

// Create a draft response to all recipients (except those bcc'd) with an
// acknowledgment.
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/

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

createDraftReplyAll(body, options)

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

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

// Create a draft response to all recipients (except those bcc'd) using an HTML
// text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 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/

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

forward(recipient)

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

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

پارامترها

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

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

forward(recipient, options)

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

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

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 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 نام فرستنده ایمیل (پیش‌فرض: نام کاربر)
no Reply Boolean اگر ایمیل باید از یک آدرس ایمیل عمومی بدون پاسخ ارسال شود تا گیرندگان از پاسخ دادن به ایمیل‌ها منصرف شوند، true ؛ این گزینه فقط برای حساب‌های Google Workspace امکان‌پذیر است، نه کاربران Gmail
reply To String یک آدرس ایمیل برای استفاده به عنوان آدرس پیش‌فرض پاسخ (پیش‌فرض: آدرس ایمیل کاربر)
subject String یک خط موضوع جدید برای ایمیل، تا سقف ۲۵۰ کاراکتر.

بازگشت

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

مجوز

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

  • https://mail.google.com/

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

getAttachments()

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

getAttachments(options)

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

پارامترها

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

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

نام نوع توضیحات
include Inline Images Boolean اگر آرایه‌ی برگردانده شده از پیوست‌های Blob باید شامل تصاویر درون‌خطی باشد، true برمی‌گرداند (پیش‌فرض true است).
include Attachments Boolean اگر آرایه‌ی برگردانده شده از پیوست‌های Blob باید شامل پیوست‌های معمولی (غیر درون‌خطی) باشد، true برمی‌گرداند (پیش‌فرض true است).

بازگشت

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

مجوز

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

  • https://mail.google.com/

getBcc()

گیرندگان جدا شده با کاما را که در bcc پیام قرار دارند، دریافت می‌کند.

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

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

بازگشت

String — گیرندگان جدا شده با کاما که در این پیام bcc'd شده‌اند.

مجوز

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

  • https://mail.google.com/

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

getBody()

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

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

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

getCc()

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

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

بازگشت

String — گیرندگان جدا شده با کاما که در این پیام ثبت شده‌اند.

مجوز

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

  • https://mail.google.com/

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

getDate()

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

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

getFrom()

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

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

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

getHeader(name)

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox.
const 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 — مقدار هدر، یا یک رشته خالی اگر هدر در پیام وجود نداشته باشد.

مجوز

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

  • https://mail.google.com/

getId()

شناسه (ID) این پیام را دریافت می‌کند. 

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

بازگشت

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

getPlainBody()

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

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

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

getRawContent()

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

getReplyTo()

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

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

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

getSubject()

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

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

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

getThread()

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

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

getTo()

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

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

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

isDraft()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is draft? ${message.isDraft()}`);

بازگشت

Boolean - آیا این پیام پیش‌نویس است یا خیر.

مجوز

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

  • https://mail.google.com/

isInChats()

مشخص می‌کند که آیا این پیام، چت است یا خیر. 

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is a chat? ${message.isInChats()}`);

بازگشت

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

isInInbox()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in inbox? ${message.isInInbox()}`);

بازگشت

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

مجوز

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

  • https://mail.google.com/

isInPriorityInbox()

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

const thread = GmailApp.getPriorityInboxThreads(
    0, 1)[0];  // Get first thread in priority inbox
const messages = thread.getMessages();
for (let 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 - اینکه آیا این پیام در صندوق ورودی اولویت‌دار قرار دارد یا خیر.

مجوز

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

  • https://mail.google.com/

isInTrash()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in the trash? ${message.isInTrash()}`);

بازگشت

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

isStarred()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is starred? ${message.isStarred()}`);

بازگشت

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

isUnread()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is unread? ${message.isUnread()}`);

بازگشت

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

مجوز

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

  • https://mail.google.com/

markRead()

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

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

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

markUnread()

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

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

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

moveToTrash()

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

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

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

refresh()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 — این پیام برای زنجیره‌سازی.

مجوز

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

  • https://mail.google.com/

reply(body)

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

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

پارامترها

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

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

reply(body, options)

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

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

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

پارامترها

نام نوع توضیحات
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 نام فرستنده ایمیل (پیش‌فرض: نام کاربر)
no Reply Boolean اگر ایمیل باید از یک آدرس ایمیل عمومی بدون پاسخ ارسال شود تا گیرندگان از پاسخ دادن به ایمیل‌ها منصرف شوند، true ؛ این گزینه فقط برای حساب‌های Google Workspace امکان‌پذیر است، نه کاربران Gmail
reply To String یک آدرس ایمیل برای استفاده به عنوان آدرس پیش‌فرض پاسخ (پیش‌فرض: آدرس ایمیل کاربر)
subject String یک خط موضوع جدید برای ایمیل، تا سقف ۲۵۰ کاراکتر.

بازگشت

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

مجوز

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

  • https://mail.google.com/

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

replyAll(body)

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

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

پارامترها

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

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

replyAll(body, options)

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

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

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

پارامترها

نام نوع توضیحات
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 نام فرستنده ایمیل (پیش‌فرض: نام کاربر)
no Reply Boolean اگر ایمیل باید از یک آدرس ایمیل عمومی بدون پاسخ ارسال شود تا گیرندگان از پاسخ دادن به ایمیل‌ها منصرف شوند، true ؛ این گزینه فقط برای حساب‌های Google Workspace امکان‌پذیر است، نه کاربران Gmail
reply To String یک آدرس ایمیل برای استفاده به عنوان آدرس پیش‌فرض پاسخ (پیش‌فرض: آدرس ایمیل کاربر)
subject String یک خط موضوع جدید برای ایمیل، تا سقف ۲۵۰ کاراکتر.

بازگشت

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

مجوز

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

  • https://mail.google.com/

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

star()

پیام را ستاره‌گذاری می‌کند. 

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

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

unstar()

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

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

بازگشت

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

مجوز

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

  • https://mail.google.com/

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