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

Class GmailApp

دسترسی به رشته‌ها، پیام‌ها و برچسب‌های Gmail را فراهم می‌کند.

روش ها

روش	نوع برگشت	شرح مختصر
`create Draft(recipient, subject, body)`	`Gmail Draft`	یک پیام ایمیل پیش نویس ایجاد می کند.
`create Draft(recipient, subject, body, options)`	`Gmail Draft`	یک پیام ایمیل پیش نویس با آرگومان های اختیاری ایجاد می کند.
`create Label(name)`	`Gmail Label`	یک برچسب کاربری جدید با نام داده شده ایجاد کنید.
`delete Label(label)`	`Gmail App`	برچسب مشخص شده را حذف می کند.
`get Aliases()`	`String[]`	فهرستی از ایمیل هایی را دریافت می کند که به عنوان نام مستعار برای این حساب در Gmail تنظیم شده اند.
`get Draft(draftId)`	`Gmail Draft`	پیش نویس پیام ایمیل را با شناسه بازیابی کنید.
`get Draft Messages()`	`Gmail Message[]`	همه پیام های پیش نویس را بازیابی می کند.
`get Drafts()`	`Gmail Draft[]`	همه پیام‌های پیش‌نویس Gmail را دریافت می‌کند.
`get Inbox Threads()`	`Gmail Thread[]`	همه رشته‌های صندوق ورودی را بدون در نظر گرفتن برچسب‌ها بازیابی می‌کند.
`get Inbox Threads(start, max)`	`Gmail Thread[]`	طیفی از رشته‌های صندوق ورودی را بدون توجه به برچسب‌ها بازیابی می‌کند.
`get Inbox Unread Count()`	`Integer`	تعداد رشته های خوانده نشده را در صندوق ورودی دریافت می کند.
`get Message By Id(id)`	`Gmail Message`	با شناسه پیام می گیرد.
`get Messages For Thread(thread)`	`Gmail Message[]`	همه پیام های موجود در رشته مشخص شده را بازیابی کنید.
`get Messages For Threads(threads)`	`Gmail Message[][]`	همه پیام ها را در رشته های مشخص شده بازیابی کنید.
`get Priority Inbox Threads()`	`Gmail Thread[]`	همه رشته‌های صندوق ورودی اولویتی را بدون توجه به برچسب‌ها بازیابی می‌کند.
`get Priority Inbox Threads(start, max)`	`Gmail Thread[]`	طیفی از رشته‌های صندوق ورودی اولویتی را بدون توجه به برچسب‌ها بازیابی می‌کند.
`get Priority Inbox Unread Count()`	`Integer`	تعداد رشته های خوانده نشده را در صندوق ورودی اولویتی دریافت می کند.
`get Spam Threads()`	`Gmail Thread[]`	همه رشته های هرزنامه را بدون در نظر گرفتن برچسب ها بازیابی می کند.
`get Spam Threads(start, max)`	`Gmail Thread[]`	طیفی از رشته های هرزنامه را بدون توجه به برچسب ها بازیابی می کند.
`get Spam Unread Count()`	`Integer`	تعداد رشته های خوانده نشده که هرزنامه هستند را دریافت می کند.
`get Starred Threads()`	`Gmail Thread[]`	همه رشته های ستاره دار را بدون در نظر گرفتن برچسب ها بازیابی می کند.
`get Starred Threads(start, max)`	`Gmail Thread[]`	طیفی از رشته های ستاره دار را بدون توجه به برچسب ها بازیابی می کند.
`get Starred Unread Count()`	`Integer`	تعداد رشته های خوانده نشده ستاره دار را دریافت می کند.
`get Thread By Id(id)`	`Gmail Thread`	یک موضوع با شناسه دریافت می کند.
`get Trash Threads()`	`Gmail Thread[]`	همه رشته های زباله را بدون در نظر گرفتن برچسب ها بازیابی می کند.
`get Trash Threads(start, max)`	`Gmail Thread[]`	طیفی از رشته های زباله را بدون توجه به برچسب ها بازیابی می کند.
`get User Label By Name(name)`	`Gmail Label`	برچسبی را با نام برچسب بازیابی می کند.
`get User Labels()`	`Gmail Label[]`	لیستی از برچسب های ایجاد شده توسط کاربر را بازیابی می کند.
`mark Message Read(message)`	`Gmail App`	این پیام را به عنوان خوانده شده علامت گذاری می کند و پیام را مجبور به بازخوانی می کند.
`mark Message Unread(message)`	`Gmail App`	این پیام را به عنوان خوانده‌نشده علامت‌گذاری می‌کند و پیام را مجبور به بازخوانی می‌کند.
`mark Messages Read(messages)`	`Gmail App`	این پیام‌ها را به‌عنوان خوانده‌شده علامت‌گذاری می‌کند و پیام‌ها را مجبور به بازخوانی می‌کند.
`mark Messages Unread(messages)`	`Gmail App`	این پیام‌ها را به عنوان خوانده نشده علامت‌گذاری می‌کند و پیام‌ها را مجبور به بازخوانی می‌کند.
`mark Thread Important(thread)`	`Gmail App`	این موضوع را به‌عنوان مهم علامت‌گذاری می‌کند و موضوع را مجبور به تازه کردن می‌کند.
`mark Thread Read(thread)`	`Gmail App`	این موضوع را به عنوان خوانده شده علامت گذاری می کند و موضوع را مجبور به تازه کردن می کند.
`mark Thread Unimportant(thread)`	`Gmail App`	این رشته را به‌عنوان بی‌اهمیت علامت‌گذاری می‌کند و موضوع را مجبور به تازه کردن می‌کند.
`mark Thread Unread(thread)`	`Gmail App`	این موضوع را به عنوان خوانده نشده علامت گذاری می کند و موضوع را مجبور به تازه کردن می کند.
`mark Threads Important(threads)`	`Gmail App`	این رشته‌ها را به‌عنوان مهم علامت‌گذاری می‌کند و رشته‌ها را مجبور به تازه کردن می‌کند.
`mark Threads Read(threads)`	`Gmail App`	این رشته‌ها را به‌عنوان خوانده شده علامت‌گذاری می‌کند و رشته‌ها را مجبور به تازه کردن می‌کند.
`mark Threads Unimportant(threads)`	`Gmail App`	این رشته‌ها را به‌عنوان بی‌اهمیت علامت‌گذاری می‌کند و رشته‌ها را مجبور به تازه‌سازی می‌کند.
`mark Threads Unread(threads)`	`Gmail App`	این رشته‌ها را به‌عنوان خوانده‌نشده علامت‌گذاری می‌کند و رشته‌ها را مجبور به تازه کردن می‌کند.
`move Message To Trash(message)`	`Gmail App`	پیام را به سطل زباله منتقل می کند و پیام را مجبور به بازخوانی می کند.
`move Messages To Trash(messages)`	`Gmail App`	پیام های مشخص شده را به سطل زباله منتقل می کند و پیام ها را مجبور به بازخوانی می کند.
`move Thread To Archive(thread)`	`Gmail App`	این رشته را به بایگانی منتقل می کند و موضوع را مجبور به تازه کردن می کند.
`move Thread To Inbox(thread)`	`Gmail App`	این رشته را به صندوق ورودی منتقل می کند و موضوع را مجبور می کند تا به روز شود.
`move Thread To Spam(thread)`	`Gmail App`	این رشته را به هرزنامه منتقل می کند و موضوع را مجبور به تازه کردن می کند.
`move Thread To Trash(thread)`	`Gmail App`	این رشته را به سطل زباله منتقل می کند و موضوع را مجبور به تازه کردن می کند.
`move Threads To Archive(threads)`	`Gmail App`	این رشته ها را به بایگانی منتقل می کند و رشته ها را مجبور به تازه کردن می کند.
`move Threads To Inbox(threads)`	`Gmail App`	این رشته‌ها را به صندوق ورودی منتقل می‌کند و رشته‌ها را مجبور به تازه‌سازی می‌کند.
`move Threads To Spam(threads)`	`Gmail App`	این رشته ها را به هرزنامه منتقل می کند و رشته ها را مجبور به بازخوانی می کند.
`move Threads To Trash(threads)`	`Gmail App`	این رشته‌ها را به سطل زباله منتقل می‌کند و رشته‌ها را مجبور به تازه کردن می‌کند.
`refresh Message(message)`	`Gmail App`	پیام و وضعیت مربوطه را از Gmail بارگیری مجدد می کند (در مواردی که برچسب ها، وضعیت خواندن و غیره تغییر کرده باشند مفید است).
`refresh Messages(messages)`	`Gmail App`	پیام‌ها و وضعیت مرتبط را از Gmail بارگیری مجدد می‌کند (برای مواردی که برچسب‌ها، وضعیت خواندن و غیره تغییر کرده باشند مفید است).
`refresh Thread(thread)`	`Gmail App`	رشته و وضعیت مرتبط را از Gmail بارگیری مجدد می کند (در مواردی که برچسب ها، وضعیت خواندن و غیره تغییر کرده باشند مفید است).
`refresh Threads(threads)`	`Gmail App`	رشته ها و وضعیت مرتبط را از Gmail بارگیری مجدد می کند (در مواردی که برچسب ها، وضعیت خواندن و غیره تغییر کرده باشند مفید است).
`search(query)`	`Gmail Thread[]`	جیمیل را با عبارت مورد نظر جستجو کنید.
`search(query, start, max)`	`Gmail Thread[]`	جیمیل را با عبارت مورد نظر جستجو کنید.
`send Email(recipient, subject, body)`	`Gmail App`	یک پیام ایمیل می فرستد.
`send Email(recipient, subject, body, options)`	`Gmail App`	یک پیام ایمیل با آرگومان های اختیاری ارسال می کند.
`set Current Message Access Token(accessToken)`	`void`	رمز دسترسی پیام فعلی را تنظیم می کند که اسکریپت را قادر می سازد به ویژگی های `Gmail Message` فعلی دسترسی پیدا کند.
`star Message(message)`	`Gmail App`	یک ستاره به این پیام اضافه می کند و پیام را مجبور می کند تا به روز شود.
`star Messages(messages)`	`Gmail App`	به این پیام‌ها ستاره اضافه می‌کند و پیام‌ها را مجبور به تازه‌سازی می‌کند.
`unstar Message(message)`	`Gmail App`	ستاره ای را از این پیام حذف می کند و پیام را مجبور به بازخوانی می کند.
`unstar Messages(messages)`	`Gmail App`	ستاره‌ها را از این پیام‌ها حذف می‌کند و پیام‌ها را مجبور به بازخوانی می‌کند.

روش های منسوخ شده

روش	نوع برگشت	شرح مختصر
`get Chat Threads()`	`Gmail Thread[]`	همه رشته‌های کلاسیک Google Hangouts و رشته‌های Google Chat را دریافت می‌کند تا زمانی که Google در اواخر امسال همه کاربران Hangouts کلاسیک را به Chat تغییر دهد.
`get Chat Threads(start, max)`	`Gmail Thread[]`	طیفی از رشته‌های کلاسیک Google Hangouts و رشته‌های Google Chat را دریافت می‌کند تا زمانی که Google همه کاربران Hangouts کلاسیک را در اواخر امسال به Chat تغییر دهد.

مستندات دقیق

`create Draft(recipient, subject, body)`

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

// The code below creates a draft email with the current date and time.
const now = new Date();
GmailApp.createDraft(
    'mike@example.com',
    'current time',
    `The time is: ${now.toString()}`,
);

پارامترها

نام	تایپ کنید	توضیحات
`recipient`	`String`	لیست آدرس های ایمیل جدا شده با کاما
`subject`	`String`	موضوع ایمیل
`body`	`String`	بدنه ایمیل

بازگشت

Gmail Draft - GmailDraft تازه ایجاد شده

مجوز

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

https://mail.google.com/

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

create Draft(recipient, subject, body, options)

`create Draft(recipient, subject, body, options)`

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

// Create a draft email with a file from Google Drive attached as a PDF.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft(
    'mike@example.com',
    'Attachment example',
    'Please see attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

پارامترها

نام	تایپ کنید	توضیحات
`recipient`	`String`	آدرس های گیرنده
`subject`	`String`	خط موضوع
`body`	`String`	بدنه ایمیل
`options`	`Object`	یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند

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

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

بازگشت

Gmail Draft - GmailDraft تازه ایجاد شده

مجوز

https://mail.google.com/

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

create Draft(recipient, subject, body)

`create Label(name)`

یک برچسب کاربری جدید با نام داده شده ایجاد کنید.

// Creates the label @FOO and logs label: FOO
Logger.log(`label: ${GmailApp.createLabel('FOO')}`);

پارامترها

نام	تایپ کنید	توضیحات
`name`	`String`	نام برچسب جدید

بازگشت

Gmail Label - برچسب تازه ایجاد شده

مجوز

https://mail.google.com/

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

delete Label(label)

`delete Label(label)`

برچسب مشخص شده را حذف می کند.

// Have to get the label by name first
const label = GmailApp.getUserLabelByName('FOO');
GmailApp.deleteLabel(label);

پارامترها

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

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

create Label(name)

`get Aliases()`

فهرستی از ایمیل هایی را دریافت می کند که به عنوان نام مستعار برای این حساب در Gmail تنظیم شده اند.

با استفاده از آرگومان اختیاری "from" می توانید از هر یک از این نام های مستعار پیام ارسال کنید.

// Log the aliases for this Gmail account and send an email as the first one.
const me = Session.getActiveUser().getEmail();
const aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {
    from: aliases[0],
  });
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

بازگشت

String[] - آرایه ای از نام مستعار برای این حساب

مجوز

https://mail.google.com/

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

send Email(recipient, subject, body, options)

`get Draft(draftId)`

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

از این به همراه getId() در پیش نویس های Gmail استفاده کنید.

// Get the first draft message in your drafts folder
const draft = GmailApp.getDrafts()[0];
// Get its ID
const draftId = draft.getId();
// Now fetch the same draft using that ID.
const draftById = GmailApp.getDraft(draftId);
// Should always log true as they should be the same message
Logger.log(
    draft.getMessage().getSubject() === draftById.getMessage().getSubject(),
);

پارامترها

نام	تایپ کنید	توضیحات
`draft Id`	`String`	شناسه پیش نویس برای بازیابی

بازگشت

Gmail Draft - پیش نویس با شناسه داده شده

پرتاب می کند

Error - اگر هیچ پیش نویس با شناسه داده شده یافت نشد

مجوز

https://mail.google.com/

`get Draft Messages()`

همه پیام های پیش نویس را بازیابی می کند.

// Logs the number of draft messages
const drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

بازگشت

Gmail Message[] - آرایه ای از پیش نویس پیام های جیمیل

مجوز

https://mail.google.com/

`get Drafts()`

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

const drafts = GmailApp.getDrafts();
for (let i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

بازگشت

Gmail Draft[] - آرایه‌ای از پیام‌های پیش‌نویس Gmail

مجوز

https://mail.google.com/

`get Inbox Threads()`

همه رشته‌های صندوق ورودی را بدون در نظر گرفتن برچسب‌ها بازیابی می‌کند.

زمانی که اندازه همه رشته‌ها برای سیستم بسیار بزرگ باشد، این تماس با شکست مواجه می‌شود. در جایی که اندازه رشته ناشناخته است، و احتمالاً بسیار بزرگ است، لطفاً از فراخوانی «صفحه‌شده» استفاده کنید و محدوده رشته‌ها را برای بازیابی در هر تماس مشخص کنید.

// Log the subject lines of your Inbox
const threads = GmailApp.getInboxThreads();
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

بازگشت

Gmail Thread[] - آرایه‌ای از رشته‌های Gmail در صندوق ورودی

مجوز

https://mail.google.com/

`get Inbox Threads(start, max)`

طیفی از رشته‌های صندوق ورودی را بدون توجه به برچسب‌ها بازیابی می‌کند.

// Log the subject lines of up to the first 50 emails in your Inbox
const threads = GmailApp.getInboxThreads(0, 50);
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

پارامترها

نام	تایپ کنید	توضیحات
`start`	`Integer`	نمایه اولین موضوعی که باید بازیابی شود
`max`	`Integer`	حداکثر تعداد رشته ها برای بازیابی

بازگشت

Gmail Thread[] - آرایه‌ای از رشته‌های Gmail در صندوق ورودی

مجوز

https://mail.google.com/

`get Inbox Unread Count()`

تعداد رشته های خوانده نشده را در صندوق ورودی دریافت می کند.

Logger.log(`Messages unread in inbox: ${GmailApp.getInboxUnreadCount()}`);

بازگشت

Integer - تعداد رشته‌هایی در صندوق ورودی که پیام‌های خوانده نشده دارند

مجوز

https://mail.google.com/

`get Message By Id(id)`

با شناسه پیام می گیرد.

از این در ارتباط با getId() در پیام‌های Gmail استفاده کنید.

// Get the first message in the first thread of your inbox
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
const messageId = message.getId();
// Now fetch the same message using that ID.
const messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() === messageById.getSubject());

پارامترها

نام	تایپ کنید	توضیحات
`id`	`String`	شناسه پیام برای بازیابی

بازگشت

Gmail Message - پیام با شناسه داده شده

پرتاب می کند

Error - اگر هیچ پیامی با شناسه داده شده یافت نشد

مجوز

https://mail.google.com/

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

get Thread By Id(id)

`get Messages For Thread(thread)`

همه پیام های موجود در رشته مشخص شده را بازیابی کنید.

// Log all the subject lines in the first thread of your inbox
const thread = GmailApp.getInboxThreads(0, 1)[0];
const messages = GmailApp.getMessagesForThread(thread);
for (let i = 0; i < messages.length; i++) {
  Logger.log(`subject: ${messages[i].getSubject()}`);
}

پارامترها

نام	تایپ کنید	توضیحات
`thread`	`Gmail Thread`	رشته پیام ها برای بازیابی

بازگشت

Gmail Message[] - آرایه ای از پیام های مربوط به این رشته

مجوز

https://mail.google.com/

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

get Messages For Threads(threads)

`get Messages For Threads(threads)`

همه پیام ها را در رشته های مشخص شده بازیابی کنید.

// Log the subject lines of all messages in the first two threads of your inbox
const thread = GmailApp.getInboxThreads(0, 2);
const messages = GmailApp.getMessagesForThreads(thread);
for (let i = 0; i < messages.length; i++) {
  for (let j = 0; j < messages[i].length; j++) {
    Logger.log(`subject: ${messages[i][j].getSubject()}`);
  }
}

پارامترها

نام	تایپ کنید	توضیحات
`threads`	`Gmail Thread[]`	رشته های پیام برای بازیابی

بازگشت

Gmail Message[][] - آرایه‌ای از آرایه‌های پیام‌ها، که در آن هر مورد در آرایه بیرونی مربوط به یک رشته است و آرایه داخلی حاوی پیام‌های موجود در آن رشته است.

مجوز

https://mail.google.com/

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

get Messages For Thread(thread)

`get Priority Inbox Threads()`

همه رشته‌های صندوق ورودی اولویتی را بدون توجه به برچسب‌ها بازیابی می‌کند.

Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads().length}`,
);

بازگشت

Gmail Thread[] - آرایه ای از رشته های Gmail در صندوق ورودی اولویتی

مجوز

https://mail.google.com/

`get Priority Inbox Threads(start, max)`

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

// Will log some number 2 or less
Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads(0, 2).length}`,
);

پارامترها

نام	تایپ کنید	توضیحات
`start`	`Integer`	نمایه اولین موضوعی که باید بازیابی شود
`max`	`Integer`	حداکثر تعداد رشته ها برای بازیابی

بازگشت

Gmail Thread[] - آرایه ای از رشته های Gmail در صندوق ورودی اولویتی

مجوز

https://mail.google.com/

`get Priority Inbox Unread Count()`

تعداد رشته های خوانده نشده را در صندوق ورودی اولویتی دریافت می کند.

Logger.log(
    `Number of unread emails in your Priority Inbox : ${
        GmailApp.getPriorityInboxUnreadCount()}`,
);

بازگشت

Integer - تعداد رشته‌هایی در صندوق ورودی اولویتی که پیام‌های خوانده نشده دارند

مجوز

https://mail.google.com/

`get Spam Threads()`

همه رشته های هرزنامه را بدون در نظر گرفتن برچسب ها بازیابی می کند.

Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads().length}`);

بازگشت

Gmail Thread[] - آرایه ای از رشته های Gmail در پوشه هرزنامه

مجوز

https://mail.google.com/

`get Spam Threads(start, max)`

طیفی از رشته های هرزنامه را بدون توجه به برچسب ها بازیابی می کند.

// Will log a number at most 5
Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads(0, 5).length}`);

پارامترها

نام	تایپ کنید	توضیحات
`start`	`Integer`	نمایه اولین موضوعی که باید بازیابی شود
`max`	`Integer`	حداکثر تعداد رشته ها برای بازیابی

بازگشت

Gmail Thread[] - آرایه ای از رشته های Gmail در پوشه هرزنامه

مجوز

https://mail.google.com/

`get Spam Unread Count()`

تعداد رشته های خوانده نشده که هرزنامه هستند را دریافت می کند.

// Unless you actually read stuff in your spam folder, this should be the same
// as the number of messages in your spam folder.
Logger.log(`# unread threads that are spam: ${GmailApp.getSpamUnreadCount()}`);

بازگشت

Integer - تعداد رشته‌های هرزنامه که پیام‌های خوانده نشده دارند

مجوز

https://mail.google.com/

`get Starred Threads()`

همه رشته های ستاره دار را بدون در نظر گرفتن برچسب ها بازیابی می کند.

// Logs the number of starred threads
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads().length}`);

بازگشت

Gmail Thread[] - آرایه‌ای از رشته‌های ستاره‌دار Gmail

مجوز

https://mail.google.com/

`get Starred Threads(start, max)`

طیفی از رشته های ستاره دار را بدون توجه به برچسب ها بازیابی می کند.

// Logs the number of starred threads to a maximum of 5
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads(0, 5).length}`);

پارامترها

نام	تایپ کنید	توضیحات
`start`	`Integer`	نمایه اولین موضوعی که باید بازیابی شود
`max`	`Integer`	حداکثر تعداد رشته ها برای بازیابی

بازگشت

Gmail Thread[] - آرایه‌ای از رشته‌های ستاره‌دار Gmail

مجوز

https://mail.google.com/

`get Starred Unread Count()`

تعداد رشته های خوانده نشده ستاره دار را دریافت می کند.

Logger.log(`# unread and starred: ${GmailApp.getStarredUnreadCount()}`);

بازگشت

Integer - تعداد رشته های ستاره دار که پیام های خوانده نشده دارند

مجوز

https://mail.google.com/

`get Thread By Id(id)`

یک موضوع با شناسه دریافت می کند.

از این در ارتباط با getId() در موضوعات Gmail استفاده کنید.

// Gets the first inbox thread.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
// Gets the same thread by ID.
const threadById = GmailApp.getThreadById(firstThread.getId());
// Verifies that they are the same.
console.log(
    firstThread.getFirstMessageSubject() ===
        threadById.getFirstMessageSubject(),
);

پارامترها

نام	تایپ کنید	توضیحات
`id`	`String`	شناسه موضوع برای بازیابی.

بازگشت

Gmail Thread - رشته ای با شناسه داده شده یا در صورت یافت نشدن null .

مجوز

https://mail.google.com/

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

get Message By Id(id)

`get Trash Threads()`

همه رشته های زباله را بدون در نظر گرفتن برچسب ها بازیابی می کند.

Logger.log(`# of total trash threads: ${GmailApp.getTrashThreads().length}`);

بازگشت

Gmail Thread[] - آرایه‌ای از رشته‌های Gmail در سطل زباله

مجوز

https://mail.google.com/

`get Trash Threads(start, max)`

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

// Will log a number at most 5
Logger.log(
    `# of total trash threads: ${GmailApp.getTrashThreads(0, 5).length}`,
);

پارامترها

نام	تایپ کنید	توضیحات
`start`	`Integer`	نمایه اولین موضوعی که باید بازیابی شود
`max`	`Integer`	حداکثر تعداد رشته ها برای بازیابی

بازگشت

Gmail Thread[] - آرایه‌ای از رشته‌های Gmail در سطل زباله

مجوز

https://mail.google.com/

`get User Label By Name(name)`

برچسبی را با نام برچسب بازیابی می کند.

const labelObject = GmailApp.getUserLabelByName('myLabel');

پارامترها

نام	تایپ کنید	توضیحات
`name`	`String`	نام برچسب برای بازیابی

بازگشت

Gmail Label - برچسب جیمیل با نام داده شده

مجوز

https://mail.google.com/

`get User Labels()`

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

// Logs all of the names of your labels
const labels = GmailApp.getUserLabels();
for (let i = 0; i < labels.length; i++) {
  Logger.log(`label: ${labels[i].getName()}`);
}

بازگشت

Gmail Label[] - آرایه ای از برچسب های ایجاد شده توسط کاربر

مجوز

https://mail.google.com/

`mark Message Read(message)`

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

// Mark the first message in the first thread of your inbox as read
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageRead(message);

پارامترها

نام	تایپ کنید	توضیحات
`message`	`Gmail Message`	پیام علامت گذاری به عنوان خوانده شده

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

mark Message Unread(message)

`mark Message Unread(message)`

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

// Mark the first message in the first thread of your inbox as unread
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

پارامترها

نام	تایپ کنید	توضیحات
`message`	`Gmail Message`	پیام علامت گذاری به عنوان خوانده نشده

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

mark Message Read(message)

`mark Messages Read(messages)`

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

// Mark first three messages in the first inbox thread as read.
// Assumes that the first inbox thread has 3 messages in it.
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(messages);

پارامترها

نام	تایپ کنید	توضیحات
`messages`	`Gmail Message[]`	مجموعه ای از پیام ها برای علامت گذاری به عنوان خوانده شده

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

mark Messages Unread(messages)

`mark Messages Unread(messages)`

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

// Mark first three messages in the first inbox thread as unread.
// Assumes that the first inbox thread has 3 messages in it
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(messages);

پارامترها

نام	تایپ کنید	توضیحات
`messages`	`Gmail Message[]`	مجموعه ای از پیام ها برای علامت گذاری به عنوان خوانده نشده

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

mark Messages Read(messages)

`mark Thread Important(thread)`

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

// Marks first inbox thread as important
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

پارامترها

نام	تایپ کنید	توضیحات
`thread`	`Gmail Thread`	موضوعی که باید به عنوان مهم علامت گذاری شود

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

mark Thread Unimportant(thread)

`mark Thread Read(thread)`

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

// Marks first inbox thread as read
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadRead(thread);

پارامترها

نام	تایپ کنید	توضیحات
`thread`	`Gmail Thread`	موضوع برای علامت گذاری به عنوان خوانده شده

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

mark Thread Unread(thread)

`mark Thread Unimportant(thread)`

این رشته را به‌عنوان بی‌اهمیت علامت‌گذاری می‌کند و موضوع را مجبور به تازه کردن می‌کند.

// Marks first inbox thread as unimportant
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnimportant(thread);

پارامترها

نام	تایپ کنید	توضیحات
`thread`	`Gmail Thread`	موضوعی که باید به عنوان غیر مهم علامت گذاری شود

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

mark Thread Important(thread)

`mark Thread Unread(thread)`

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

// Marks first inbox thread as unread
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnread(thread);

پارامترها

نام	تایپ کنید	توضیحات
`thread`	`Gmail Thread`	موضوعی که باید به عنوان خوانده نشده علامت گذاری شود

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

mark Thread Read(thread)

`mark Threads Important(threads)`

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

// Marks first two threads in inbox as important
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

پارامترها

نام	تایپ کنید	توضیحات
`threads`	`Gmail Thread[]`	آرایه ای از رشته ها برای علامت گذاری به عنوان مهم

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

mark Threads Unimportant(threads)

`mark Threads Read(threads)`

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

// Marks first two threads in inbox as read
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsRead(threads);

پارامترها

نام	تایپ کنید	توضیحات
`threads`	`Gmail Thread[]`	آرایه ای از رشته ها برای علامت گذاری به عنوان خوانده شده

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

mark Threads Unread(threads)

`mark Threads Unimportant(threads)`

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

// Marks first two threads in inbox as unimportant
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnimportant(threads);

پارامترها

نام	تایپ کنید	توضیحات
`threads`	`Gmail Thread[]`	آرایه ای از رشته ها برای علامت گذاری به عنوان غیر مهم

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

mark Threads Important(threads)

`mark Threads Unread(threads)`

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

// Marks first two threads in inbox as unread
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnread(threads);

پارامترها

نام	تایپ کنید	توضیحات
`threads`	`Gmail Thread[]`	آرایه ای از رشته ها برای علامت گذاری به عنوان خوانده نشده

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

mark Threads Read(threads)

`move Message To Trash(message)`

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

// Move the first message in your inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

پارامترها

نام	تایپ کنید	توضیحات
`message`	`Gmail Message`	پیامی که باید حذف شود

بازگشت

Gmail App — سرویس جیمیل (مفید برای زنجیره زدن)

مجوز

https://mail.google.com/

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

move Messages To Trash(messages)

`move Messages To Trash(messages)`

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

// Move first two messages in your inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const messages = firstThread.getMessages();
const toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

پارامترها

نام	تایپ کنید	توضیحات
`messages`	`Gmail Message[]`	پیام هایی که باید حذف شوند

بازگشت

Gmail App — سرویس جیمیل (مفید برای زنجیره زدن)

مجوز

https://mail.google.com/

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

move Message To Trash(message)

`move Thread To Archive(thread)`

این رشته را به بایگانی منتقل می کند و موضوع را مجبور به تازه کردن می کند.

// Archive the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToArchive(firstThread);

پارامترها

نام	تایپ کنید	توضیحات
`thread`	`Gmail Thread`	موضوعی که باید بایگانی شود

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

`move Thread To Inbox(thread)`

این رشته را به صندوق ورودی منتقل می کند و موضوع را مجبور می کند تا به روز شود.

// Find a thread not already in your inbox
const thread = GmailApp.search('-in:inbox')[0];  // Get the first one
GmailApp.moveThreadToInbox(thread);

پارامترها

نام	تایپ کنید	توضیحات
`thread`	`Gmail Thread`	موضوعی که باید به صندوق ورودی منتقل شود

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

move Thread To Trash(thread)
move Thread To Spam(thread)
move Thread To Archive(thread)

`move Thread To Spam(thread)`

این رشته را به هرزنامه منتقل می کند و موضوع را مجبور به تازه کردن می کند.

// Tag first thread in inbox as spam
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToSpam(firstThread);

پارامترها

نام	تایپ کنید	توضیحات
`thread`	`Gmail Thread`	موضوعی که باید به هرزنامه منتقل شود

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

move Thread To Trash(thread)
move Thread To Inbox(thread)
move Thread To Archive(thread)

`move Thread To Trash(thread)`

این رشته را به سطل زباله منتقل می کند و موضوع را مجبور به تازه کردن می کند.

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

پارامترها

نام	تایپ کنید	توضیحات
`thread`	`Gmail Thread`	نخی که باید سطل زباله ریخته شود

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

move Thread To Inbox(thread)
move Thread To Spam(thread)
move Thread To Archive(thread)

`move Threads To Archive(threads)`

این رشته ها را به بایگانی منتقل می کند و رشته ها را مجبور به تازه کردن می کند.

// Move first two threads in your inbox to the archive
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToArchive(firstTwoThreads);

پارامترها

نام	تایپ کنید	توضیحات
`threads`	`Gmail Thread[]`	آرایه ای از موضوعات که باید بایگانی شوند

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

move Threads To Inbox(threads)
move Threads To Spam(threads)
move Threads To Trash(threads)

`move Threads To Inbox(threads)`

این رشته‌ها را به صندوق ورودی منتقل می‌کند و رشته‌ها را مجبور به تازه‌سازی می‌کند.

// Find two threads not already in your inbox
const firstTwoThreads = GmailApp.search('-in:inbox', 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

پارامترها

نام	تایپ کنید	توضیحات
`threads`	`Gmail Thread[]`	آرایه ای از رشته ها برای انتقال به صندوق ورودی

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

move Threads To Trash(threads)
move Threads To Spam(threads)
move Threads To Archive(threads)

`move Threads To Spam(threads)`

این رشته ها را به هرزنامه منتقل می کند و رشته ها را مجبور به بازخوانی می کند.

// Move first two threads in your inbox to spam
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToSpam(firstTwoThreads);

پارامترها

نام	تایپ کنید	توضیحات
`threads`	`Gmail Thread[]`	آرایه ای از رشته ها برای انتقال به هرزنامه

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

move Threads To Inbox(threads)
move Threads To Trash(threads)
move Threads To Archive(threads)

`move Threads To Trash(threads)`

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

// Move first two threads in your inbox to trash
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

پارامترها

نام	تایپ کنید	توضیحات
`threads`	`Gmail Thread[]`	آرایه ای از رشته ها که باید در سطل زباله ریخته شوند

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

move Threads To Inbox(threads)
move Threads To Spam(threads)
move Threads To Archive(threads)

`refresh Message(message)`

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

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const firstMessage = firstThread.getMessages()[0];
// ...Do something that may take a while here....
GmailApp.refreshMessage(firstMessage);
// ...Do more stuff with firstMessage...

پارامترها

نام	تایپ کنید	توضیحات
`message`	`Gmail Message`	پیامی که باید به روز شود

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

refresh Messages(messages)

`refresh Messages(messages)`

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

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 2);
// ...Do something that may take a while here....
GmailApp.refreshMessages(coupleOfMessages);
// ...Do more stuff with coupleOfMessages...

پارامترها

نام	تایپ کنید	توضیحات
`messages`	`Gmail Message[]`	پیام هایی که باید به روز شوند

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

refresh Message(message)

`refresh Thread(thread)`

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

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
// ...Do something that may take a while here....
GmailApp.refreshThread(firstThread);
// ... Do more stuff with the thread ...

پارامترها

نام	تایپ کنید	توضیحات
`thread`	`Gmail Thread`	موضوعی که باید تازه شود

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

refresh Threads(threads)

`refresh Threads(threads)`

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

const threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

پارامترها

نام	تایپ کنید	توضیحات
`threads`	`Gmail Thread[]`	موضوعاتی که باید تجدید شوند

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

refresh Thread(thread)

`search(query)`

جیمیل را با عبارت مورد نظر جستجو کنید.

// Find starred messages with subject IMPORTANT
const threads = GmailApp.search('is:starred subject:"IMPORTANT"');

پارامترها

نام	تایپ کنید	توضیحات
`query`	`String`	عبارت جستجو، همانطور که آن را در جیمیل تایپ می کنید

بازگشت

Gmail Thread[] - آرایه‌ای از رشته‌های Gmail که با این جستار مطابقت دارند

مجوز

https://mail.google.com/

`search(query, start, max)`

جیمیل را با عبارت مورد نظر جستجو کنید.

// Find starred messages with subject IMPORTANT and return second batch of 10.
// Assumes there are at least 11 of them, otherwise this will return an empty
// array.
const threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

پارامترها

نام	تایپ کنید	توضیحات
`query`	`String`	عبارت جستجو، همانطور که آن را در جیمیل تایپ می کنید
`start`	`Integer`	شاخص نخ شروع
`max`	`Integer`	حداکثر تعداد موضوعات برای بازگشت

بازگشت

Gmail Thread[] - آرایه‌ای از رشته‌های Gmail که با این جستار مطابقت دارند

مجوز

https://mail.google.com/

`send Email(recipient, subject, body)`

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

// The code below will send an email with the current date and time.
const now = new Date();
GmailApp.sendEmail(
    'mike@example.com',
    'current time',
    `The time is: ${now.toString()}`,
);

پارامترها

نام	تایپ کنید	توضیحات
`recipient`	`String`	لیست آدرس های ایمیل جدا شده با کاما
`subject`	`String`	موضوع ایمیل (حداکثر 250 کاراکتر)
`body`	`String`	بدنه ایمیل

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

send Email(recipient, subject, body, options)

`send Email(recipient, subject, body, options)`

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

// Send an email with a file from Google Drive attached as a PDF.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail(
    'mike@example.com',
    'Attachment example',
    'Please see the attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

پارامترها

نام	تایپ کنید	توضیحات
`recipient`	`String`	آدرس های گیرنده
`subject`	`String`	خط موضوع (حداکثر 250 کاراکتر)
`body`	`String`	بدنه ایمیل
`options`	`Object`	یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند

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

نام	تایپ کنید	توضیحات
`attachments`	`Blob Source[]`	مجموعه ای از فایل ها برای ارسال با ایمیل
`bcc`	`String`	فهرستی از آدرس‌های ایمیل به BCC که با کاما از هم جدا شده‌اند
`cc`	`String`	فهرستی از آدرس‌های ایمیل به CC جدا شده با کاما
`from`	`String`	آدرسی که ایمیل باید از آن ارسال شود، که باید یکی از مقادیر بازگردانده شده توسط `get Aliases()` باشد.
`html Body`	`String`	در صورت تنظیم، دستگاه هایی که قادر به ارائه HTML هستند، از آن به جای آرگومان بدن مورد نیاز استفاده می کنند. اگر تصاویر درون خطی برای ایمیل خود دارید، می توانید یک فیلد `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`	یک آدرس ایمیل برای استفاده به عنوان آدرس پیش فرض پاسخ به (پیش فرض: آدرس ایمیل کاربر)

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

send Email(recipient, subject, body)

`set Current Message Access Token(accessToken)`

رمز دسترسی پیام فعلی را تنظیم می کند که اسکریپت را قادر می سازد به ویژگی های Gmail Message فعلی دسترسی پیدا کند.

فقط پروژه‌های افزودنی Google Workspace با استفاده از دامنه پیام فعلی Gmail به این روش نیاز دارند.

function handleAddonActionEvent(e) {
  GmailApp.setCurrentMessageAccessToken(e.messageMetadata.accessToken);
  const mailMessage = GmailApp.getMessageById(e.messageMetadata.messageId);
  // Do something with mailMessage
}

پارامترها

نام	تایپ کنید	توضیحات
`access Token`	`String`	نشانه دسترسی موقت که از یک شیء رویداد اقدام افزودنی Gmail بدست می آید.

مجوز

https://mail.google.com/

`star Message(message)`

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

// Stars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

پارامترها

نام	تایپ کنید	توضیحات
`message`	`Gmail Message`	پیام ستاره دار شدن

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

star Messages(messages)

`star Messages(messages)`

به این پیام‌ها ستاره اضافه می‌کند و پیام‌ها را مجبور به تازه‌سازی می‌کند.

// Stars the first three messages in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

پارامترها

نام	تایپ کنید	توضیحات
`messages`	`Gmail Message[]`	مجموعه ای از پیام ها برای ستاره گذاری

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

star Message(message)

`unstar Message(message)`

ستاره ای را از این پیام حذف می کند و پیام را مجبور به بازخوانی می کند.

// Unstars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

پارامترها

نام	تایپ کنید	توضیحات
`message`	`Gmail Message`	پیام حذف ستاره

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

unstar Messages(messages)

`unstar Messages(messages)`

ستاره‌ها را از این پیام‌ها حذف می‌کند و پیام‌ها را مجبور به بازخوانی می‌کند.

// Unstars the first three messages in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

پارامترها

نام	تایپ کنید	توضیحات
`messages`	`Gmail Message[]`	مجموعه ای از پیام ها برای حذف ستاره

بازگشت

Gmail App - سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

https://mail.google.com/

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

unstar Message(message)

روش های منسوخ شده

`get Chat Threads()`

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

همه رشته‌های کلاسیک Google Hangouts و رشته‌های Google Chat را دریافت می‌کند تا زمانی که Google در اواخر امسال همه کاربران Hangouts کلاسیک را به Chat تغییر دهد. برای کسب اطلاعات بیشتر، در مورد تغییر Hangouts کلاسیک به Google Chat آشنا شوید .

این فراخوانی زمانی انجام نمی‌شود که اندازه همه رشته‌ها برای سیستم بسیار بزرگ باشد. در جایی که اندازه رشته ناشناخته است، و به طور بالقوه بسیار بزرگ است، از فراخوانی «صفحه‌شده» استفاده کنید و محدوده رشته‌ها را برای بازیابی در هر تماس مشخص کنید.

const threads = GmailApp.getChatThreads();
Logger.log(`# of chat threads: ${threads.length}`);

بازگشت

Gmail Thread[] - آرایه ای از موضوعات چت از Gmail.

مجوز

https://mail.google.com/

`get Chat Threads(start, max)`

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

طیفی از رشته‌های کلاسیک Google Hangouts و رشته‌های Google Chat را دریافت می‌کند تا زمانی که Google همه کاربران Hangouts کلاسیک را در اواخر امسال به Chat تغییر دهد. برای کسب اطلاعات بیشتر، در مورد تغییر Hangouts کلاسیک به Google Chat آشنا شوید .

// Get first 50 chat threads
const threads = GmailApp.getChatThreads(0, 50);
// Will log no more than 50.0
Logger.log(threads.length);
Logger.log(threads[0].getFirstMessageSubject());

پارامترها

نام	تایپ کنید	توضیحات
`start`	`Integer`	نمایه اولین موضوعی که باید بازیابی شود
`max`	`Integer`	حداکثر تعداد رشته ها برای بازیابی

بازگشت

Gmail Thread[] - آرایه ای از رشته های گفتگوی Gmail

مجوز

https://mail.google.com/