Class GmailMessage

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

// 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");

پارامترها

بازگشت

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

مجوز

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

• https://mail.google.com/

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

• reply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body)
• createDraftReplyAll(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"
});

پارامترها

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

بازگشت

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

مجوز

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

• https://mail.google.com/

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

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

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

// 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");

پارامترها

بازگشت

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

مجوز

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

• https://mail.google.com/

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

• replyAll(body)
• createDraftReply(body)
• createDraftReply(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"
});

پارامترها

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

بازگشت

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

مجوز

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

• https://mail.google.com/

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

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

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

// 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");

پارامترها

بازگشت

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

مجوز

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

• https://mail.google.com/

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

• 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"
});

پارامترها

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

بازگشت

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

مجوز

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

• https://mail.google.com/

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

• forward(recipient)

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

بازگشت

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

مجوز

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

• https://mail.google.com/

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

پارامترها

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

بازگشت

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

مجوز

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

• https://mail.google.com/

گیرندگانی که با کاما از هم جدا شده اند را روی این پیام 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 شده اند.

مجوز

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

• https://mail.google.com/

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

• getTo()

محتوای 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 - محتوای بدنه این پیام.

مجوز

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

• https://mail.google.com/

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

• getSubject()

گیرندگان جدا شده با کاما را در این پیام 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 - گیرندگانی که با کاما از هم جدا شده اند روی این پیام قید شده اند.

مجوز

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

• 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.getDate()); // Log date and time of the message

بازگشت

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

مجوز

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

• https://mail.google.com/

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

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 - آدرس ایمیل فرستنده پیام.

مجوز

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

• https://mail.google.com/

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

• getReplyTo()

با توجه به نام هدر، مقدار یک هدر 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.

پارامترها

بازگشت

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

مجوز

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

• https://mail.google.com/

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

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 - شناسه پیام.

محتوای متن این پیام را بدون قالب بندی 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 - محتوای بدنه ساده این پیام.

مجوز

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

• https://mail.google.com/

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

• getSubject()

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

بازگشت

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

مجوز

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

• https://mail.google.com/

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

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 - آدرس ایمیل برای پاسخ.

مجوز

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

• https://mail.google.com/

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

• getCc()

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

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 - موضوع این پیام.

مجوز

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

• https://mail.google.com/

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

• getAttachments()

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

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 که حاوی این پیام است.

مجوز

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

• https://mail.google.com/

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

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 - گیرندگان این پیام که با کاما از هم جدا شده اند.

مجوز

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

• https://mail.google.com/

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

• getCc()

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

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 - آیا این پیام پیش‌نویس است.

مجوز

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

• https://mail.google.com/

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

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 - آیا این پیام یک چت است.

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

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 - آیا این پیام در صندوق ورودی است.

مجوز

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

• https://mail.google.com/

اگر این پیام در صندوق ورودی اولویت قرار داشته باشد، 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 - آیا این پیام در صندوق ورودی اولویت قرار دارد یا خیر.

مجوز

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

• https://mail.google.com/

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

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 - آیا این پیام در سطل زباله است.

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

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 - آیا این پیام ستاره‌دار است یا خیر.

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

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 - وضعیت خوانده نشده این پیام.

مجوز

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

• https://mail.google.com/

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

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، برای زنجیره زدن مفید است.

مجوز

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

• https://mail.google.com/

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

• isUnread()

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

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، برای زنجیره زدن مفید است.

مجوز

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

• https://mail.google.com/

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

• isUnread()

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

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، برای زنجیره زدن مفید است.

مجوز

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

• https://mail.google.com/

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

• isInTrash()

این پیام و وضعیت مرتبط را از 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 - این پیام برای زنجیر کردن.

مجوز

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

• https://mail.google.com/

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

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

پارامترها

بازگشت

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

مجوز

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

• https://mail.google.com/

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

• reply(body, options)
• replyAll(body)
• replyAll(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
});

پارامترها

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

بازگشت

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

مجوز

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

• https://mail.google.com/

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

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

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

// 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");

پارامترها

بازگشت

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

مجوز

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

• https://mail.google.com/

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

• reply(body)
• reply(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
});

پارامترها

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

بازگشت

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

مجوز

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

• https://mail.google.com/

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

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

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

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، برای زنجیره زدن مفید است.

مجوز

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

• https://mail.google.com/

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

• 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، برای زنجیره زدن مفید است.

مجوز

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

• https://mail.google.com/

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

• star()