Class GmailApp

יצירת טיוטה של הודעת אימייל. גודל האימייל (כולל הכותרות) מוגבל במכסה.

// The code below creates a draft email with the current date and time.
var now = new Date();
GmailApp.createDraft("mike@example.com", "current time", "The time is: " + now.toString());

פרמטרים

חזרה

GmailDraft – הגרסה החדשה של GmailDraft שנוצרה

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• createDraft(recipient, subject, body, options)

יצירת טיוטת אימייל עם ארגומנטים אופציונליים. האימייל יכול להכיל טקסט פשוט או גוף HTML. גודל הודעת האימייל (כולל כותרות, אבל לא כולל קבצים מצורפים) מוגבל במכסה.

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

פרמטרים

פרמטרים מתקדמים

חזרה

GmailDraft – הגרסה החדשה של GmailDraft שנוצרה

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• createDraft(recipient, subject, body)

יוצרים תווית משתמש חדשה עם השם הפרטי.

// Creates the label @FOO and logs label: FOO
Logger.log("label: " + GmailApp.createLabel("FOO"));

פרמטרים

חזרה

GmailLabel – התווית החדשה שנוצרה

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• deleteLabel(label)

מחיקת התווית שצוינה.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• createLabel(name)

קבלת רשימה של הודעות האימייל שהוגדרו ככינויים לחשבון הזה ב-Gmail.

אפשר לשלוח הודעה מכל אחד מהכינויים האלה באמצעות הפקודה 'from' ארגומנט אופציונלי.

// Log the aliases for this Gmail account and send an email as the first one.
var me = Session.getActiveUser().getEmail();
var 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[] – מערך של כינויים לחשבון הזה

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• sendEmail(recipient, subject, body, options)

אחזור טיוטה של הודעת אימייל לפי מזהה.

שימוש בפונקציה הזו בשילוב עם getId() בטיוטות של Gmail.

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

פרמטרים

חזרה

GmailDraft – הטיוטה עם המזהה הנתון

קליעות

Error – אם לא נמצאה טיוטה עם המזהה הנתון

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

אחזור כל הטיוטות של הודעות.

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

חזרה

GmailMessage[] – מערך טיוטות של הודעות ב-Gmail

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

מקבלים את כל הודעות הטיוטות של Gmail.

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

חזרה

GmailDraft[] – מערך הודעות טיוטה ב-Gmail

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

אחזור כל השרשורים של תיבת הדואר הנכנס ללא קשר לתוויות.

השיחה תיכשל אם כל השרשורים יהיו גדולים מדי והמערכת לא תוכל לטפל בהם. אם גודל השרשור לא ידוע ועשוי להיות גדול מאוד, אפשר להשתמש בשדה 'דפים' שיחה, וכן להגדיר את הטווחים של השרשורים שרוצים לאחזר בכל קריאה.

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

חזרה

GmailThread[] – מערך שרשורי Gmail בתיבת הדואר הנכנס

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

אחזור טווח של שרשורים מתיבת הדואר הנכנס, ללא קשר לתוויות.

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

פרמטרים

חזרה

GmailThread[] – מערך שרשורי Gmail בתיבת הדואר הנכנס

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

קבלת מספר השרשורים שלא נקראו בתיבת הדואר הנכנס.

Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());

חזרה

Integer – מספר השרשורים בתיבת הדואר הנכנס שיש בהם הודעות שלא נקראו

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

מתקבלת הודעה לפי מזהה.

יש להשתמש בפונקציה הזו בשילוב עם getId() בהודעות Gmail.

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

פרמטרים

חזרה

GmailMessage – ההודעה עם המזהה הנתון

קליעות

Error – אם לא נמצאה הודעה עם המזהה הנתון

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• getThreadById(id)

אחזור כל ההודעות בשרשור שצוין.

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

פרמטרים

חזרה

GmailMessage[] – מערך הודעות שתואמות לשרשור הזה

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• getMessagesForThreads(threads)

אחזור כל ההודעות בשרשורים שצוינו.

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

פרמטרים

חזרה

GmailMessage[][] - מערך של מערכים של הודעות, כאשר כל פריט במערך החיצוני תואם ה-thread והמערך הפנימי מכילים את ההודעות שבשרשור הזה

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• getMessagesForThread(thread)

אחזור כל השרשורים של תיבת הדואר הנכנס הממוין, ללא קשר לתוויות.

השיחה תיכשל אם כל השרשורים יהיו גדולים מדי והמערכת לא תוכל לטפל בהם. אם גודל השרשור לא ידוע ועשוי להיות גדול מאוד, אפשר להשתמש בשדה 'דפים' שיחה, וכן להגדיר את הטווחים של השרשורים שרוצים לאחזר בכל קריאה.

Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads().length);

חזרה

GmailThread[] — מערך שרשורי Gmail בתיבת הדואר הנכנס הממוין

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

אחזור טווח של שרשורים ב'דואר ממוין', ללא קשר לתוויות.

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

פרמטרים

חזרה

GmailThread[] — מערך שרשורי Gmail בתיבת הדואר הנכנס הממוין

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

קבלת מספר השרשורים שלא נקראו בתיבת הדואר הנכנס הממוין.

Logger.log("Number of unread emails in your Priority Inbox : " +
           GmailApp.getPriorityInboxUnreadCount());

חזרה

Integer – מספר השרשורים בתיבת הדואר הנכנס הממוין שיש בהם הודעות שלא נקראו

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

אחזור כל שרשורי הספאם ללא קשר לתוויות.

השיחה תיכשל אם כל השרשורים יהיו גדולים מדי והמערכת לא תוכל לטפל בהם. אם גודל השרשור לא ידוע ועשוי להיות גדול מאוד, אפשר להשתמש בשדה 'דפים' שיחה, וכן להגדיר את הטווחים של השרשורים שרוצים לאחזר בכל קריאה.

Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);

חזרה

GmailThread[] – מערך שרשורי Gmail בתיקיית הספאם

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

אחזור טווח של שרשורי ספאם, ללא קשר לתוויות.

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

פרמטרים

חזרה

GmailThread[] – מערך שרשורי Gmail בתיקיית הספאם

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

הפונקציה מקבלת את מספר השרשורים שלא נקראו שהם ספאם.

// 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 – מספר שרשורי הספאם שיש בהם הודעות שלא נקראו

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

מאחזר את כל השרשורים המסומנים בכוכב ללא קשר לתוויות.

השיחה תיכשל אם כל השרשורים יהיו גדולים מדי והמערכת לא תוכל לטפל בהם. אם גודל השרשור לא ידוע ועשוי להיות גדול מאוד, אפשר להשתמש בשדה 'דפים' שיחה, וכן להגדיר את הטווחים של השרשורים שרוצים לאחזר בכל קריאה.

// Logs the number of starred threads
Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);

חזרה

GmailThread[] – מערך של שרשורי Gmail שמסומנים בכוכב

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

אחזור טווח של שרשורים מסומנים בכוכב, ללא קשר לתוויות.

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

פרמטרים

חזרה

GmailThread[] – מערך של שרשורי Gmail שמסומנים בכוכב

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

הפונקציה מקבלת את מספר השרשורים המסומנים בכוכב שלא נקראו.

Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());

חזרה

Integer – מספר השרשורים שמסומנים בכוכב שיש בהם הודעות שלא נקראו

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

הפונקציה מקבלת שרשור לפי מזהה.

שימוש בפונקציה הזו בשילוב עם 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());

פרמטרים

חזרה

GmailThread – השרשור עם המזהה הנתון או null אם הוא לא נמצא.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• getMessageById(id)

מאחזר את כל שרשורי האשפה ללא קשר לתוויות.

השיחה תיכשל אם כל השרשורים יהיו גדולים מדי והמערכת לא תוכל לטפל בהם. אם גודל השרשור לא ידוע ועשוי להיות גדול מאוד, אפשר להשתמש בשדה 'דפים' שיחה, וכן להגדיר את הטווחים של השרשורים שרוצים לאחזר בכל קריאה.

Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);

חזרה

GmailThread[] – מערך של שרשורי Gmail באשפה

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

אחזור טווח של שרשורי אשפה ללא קשר לתוויות.

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

פרמטרים

חזרה

GmailThread[] – מערך של שרשורי Gmail באשפה

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

אחזור של תווית לפי שם התווית.

var labelObject = GmailApp.getUserLabelByName("myLabel");

פרמטרים

חזרה

GmailLabel – התווית של Gmail עם השם הפרטי

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

אחזור רשימה של תוויות שנוצרו על ידי משתמשים.

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

חזרה

GmailLabel[] – מערך של תוויות שנוצרו על ידי משתמשים

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

מתבצע סימון של ההודעה כנקראה ומאלץ רענון שלה.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• markMessageUnread(message)

מתבצע סימון של ההודעה כהודעה שעוד לא נקראה ומאלץ את הרענון שלה.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• markMessageRead(message)

סימון ההודעות האלה כהודעות שנקראו ומאלץ רענון שלהן.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• markMessagesUnread(messages)

סימון ההודעות האלה כהודעות שעוד לא נקראו ומאלץ רענון שלהן.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• markMessagesRead(messages)

מתבצע סימון של השרשור הזה כחשוב ומאלץ רענון שלו.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• markThreadUnimportant(thread)

השרשור הזה מסומן כנקרא ומאלץ רענון של השרשור.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• markThreadUnread(thread)

מתבצע סימון של השרשור הזה כלא חשוב ומאלץ רענון שלו.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• markThreadImportant(thread)

השרשור הזה מסומן כ'לא נקרא' ומאלץ רענון של השרשור.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• markThreadRead(thread)

הסימון של השרשורים האלה כחשובים ומאלץ את השרשורים לרענן.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• markThreadsUnimportant(threads)

השרשורים האלה מסומנים כשרשורים שנקראו ומאלצים את רענון השרשורים.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• markThreadsUnread(threads)

הסימון של השרשורים האלה לא חשובים ומאלץ את השרשורים לרענן.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• markThreadsImportant(threads)

השרשורים האלה מסומנים כשרשורים שלא נקראו ומאלצים את רענון השרשורים.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• markThreadsRead(threads)

מעביר את ההודעה לאשפה ומאלץ רענון שלה.

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

פרמטרים

חזרה

GmailApp — שירות Gmail (שימושי לשרשור)

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• moveMessagesToTrash(messages)

מעביר את ההודעות שצוינו לאשפה ומאלץ את הרענון של ההודעות.

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

פרמטרים

חזרה

GmailApp — שירות Gmail (שימושי לשרשור)

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• moveMessageToTrash(message)

העברת השרשור הזה לארכיון ומאלצת רענון של השרשור.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToTrash(thread)

מעביר את השרשור הזה לתיבת הדואר הנכנס ומאלץ רענון שלו.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• moveThreadToTrash(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

השרשור הזה יועבר לספאם ויאלץ רענון של השרשור.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• moveThreadToTrash(thread)
• moveThreadToInbox(thread)
• moveThreadToArchive(thread)

מעביר את השרשור לאשפה ומאלץ רענון שלו.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

העברת השרשורים האלה לארכיון ומאלצת רענון.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToTrash(threads)

השרשורים האלה מועברים לתיבת הדואר הנכנס ומאלצים את רענון השרשורים.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• moveThreadsToTrash(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

השרשורים האלה מועברים לספאם ומאלצים את רענון השרשורים.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• moveThreadsToInbox(threads)
• moveThreadsToTrash(threads)
• moveThreadsToArchive(threads)

העברת השרשורים האלה לאשפה ומאלצת לרענן את השרשורים.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

טעינה מחדש של ההודעה ושל המצב המשויך אליה מ-Gmail (שימושי במקרה של התוויות, מצב הקריאה, וכו').

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• refreshMessages(messages)

טעינה מחדש של ההודעות והמצב המשויך מ-Gmail (שימושי למקרים שבהם התוויות, מצב הקריאה, וכו').

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• refreshMessage(message)

טעינה מחדש של השרשור והמצב המשויך מ-Gmail (שימושי למקרים שבהם התוויות, מצב הקריאה, וכו').

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• refreshThreads(threads)

טעינה מחדש של השרשורים והמצב המשויך מ-Gmail (שימושי במקרה של התוויות, מצב הקריאה, וכו').

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• refreshThread(thread)

חיפוש ב-Gmail באמצעות השאילתה הנתונה.

השיחה תיכשל אם כל השרשורים יהיו גדולים מדי והמערכת לא תוכל לטפל בהם. אם גודל השרשור לא ידוע ועשוי להיות גדול מאוד, אפשר להשתמש בשדה 'דפים' שיחה, וכן להגדיר את הטווחים של השרשורים שרוצים לאחזר בכל קריאה.

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

פרמטרים

חזרה

GmailThread[] – מערך שרשורי Gmail שתואמים לשאילתה הזו

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

חיפוש ב-Gmail באמצעות השאילתה הנתונה.

// 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.
var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

פרמטרים

חזרה

GmailThread[] – מערך שרשורי Gmail שתואמים לשאילתה הזו

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

יישלח אימייל. גודל האימייל (כולל הכותרות) מוגבל במכסה.

// The code below will send an email with the current date and time.
var now = new Date();
GmailApp.sendEmail("mike@example.com", "current time", "The time is: " + now.toString());

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• sendEmail(recipient, subject, body, options)

שליחת הודעת אימייל עם ארגומנטים אופציונליים. האימייל יכול להכיל טקסט פשוט או HTML גוף ההודעה. גודל הודעת האימייל (כולל כותרות, אבל לא כולל קבצים מצורפים) מוגבל במכסה.

// Send an email with a file from Google Drive attached as a PDF.
var 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'
});

פרמטרים

פרמטרים מתקדמים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• sendEmail(recipient, subject, body)

הגדרת ההודעה הנוכחית אסימון גישה שמאפשר לסקריפט לגשת לנכסי GmailMessage הנוכחיים.

רק פרויקטים עם תוסף Google Workspace שמשתמשים בהיקפי ההודעות הנוכחיים ב-Gmail נדרשת את השיטה הזו.

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

פרמטרים

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

סימון ההודעה בכוכב ואילוץ רענון של ההודעה.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• starMessages(messages)

מוסיף כוכבים להודעות האלה ומאלץ רענון של ההודעות.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• starMessage(message)

הסרת כוכב מההודעה הזו ואילוץ רענון של ההודעה.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• unstarMessages(messages)

הסרת כוכבים מהודעות אלה ומאלצת רענון של ההודעות.

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

פרמטרים

חזרה

GmailApp – שירות Gmail, שימושי לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מההיקפים הבאים או עם היקפי הרשאות מתאימים מ-ה-API הרלוונטי ל-REST:

• https://mail.google.com/

ראה גם

• unstarMessage(message)