Class GmailApp

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

// 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()}`,
);

פרמטרים

חזרה

GmailDraft – הטיוטה החדשה שנוצרה ב-Gmail

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מההיקפי הגישה הבאים, או עם היקפי גישה מתאימים מה-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.
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',
    },
);

פרמטרים

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

חזרה

GmailDraft – הטיוטה החדשה שנוצרה ב-Gmail

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מההיקפי הגישה הבאים, או עם היקפי גישה מתאימים מה-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
const 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.
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[] – מערך של כינויים לחשבון הזה

אישור

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

• https://mail.google.com/

ראה גם

• sendEmail(recipient, subject, body, options)

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

משתמשים ב-getId() בשילוב עם נוסחת ה-drafts של 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(),
);

פרמטרים

חזרה

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

זריקות

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

אישור

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

• https://mail.google.com/

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

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

חזרה

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

אישור

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

• https://mail.google.com/

הפונקציה מקבלת את כל טיוטות ההודעות ב-Gmail.

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

חזרה

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

אישור

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

• https://mail.google.com/

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

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

// Log the subject lines of your Inbox
const threads = GmailApp.getInboxThreads();
for (let 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
const threads = GmailApp.getInboxThreads(0, 50);
for (let 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() בשילוב עם 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());

פרמטרים

חזרה

GmailMessage – ההודעה עם המזהה שצוין

זריקות

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

אישור

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

• https://mail.google.com/

ראה גם

• getThreadById(id)

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

// 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()}`);
}

פרמטרים

חזרה

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

אישור

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

• https://mail.google.com/

ראה גם

• getMessagesForThreads(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()}`);
  }
}

פרמטרים

חזרה

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

אישור

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

• https://mail.google.com/

ראה גם

• getMessagesForThread(thread)

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

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

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/

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

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

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/

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

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

// 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() בשילוב עם 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)

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

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

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/

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

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

פרמטרים

חזרה

GmailLabel – התווית ב-Gmail עם השם שצוין

אישור

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

• https://mail.google.com/

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

// 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()}`);
}

חזרה

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

אישור

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

• https://mail.google.com/

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

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

פרמטרים

חזרה

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

אישור

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

• https://mail.google.com/

ראה גם

• markMessageUnread(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);

פרמטרים

חזרה

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.
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(messages);

פרמטרים

חזרה

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
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(messages);

פרמטרים

חזרה

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

אישור

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

• https://mail.google.com/

ראה גם

• markMessagesRead(messages)

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

// Marks first inbox thread as important
const 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
const 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
const 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
const 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
const 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
const 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
const 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
const 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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const messages = firstThread.getMessages();
const 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
const 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
const 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
const 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
const 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
const 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
const 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
const 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
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

פרמטרים

חזרה

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

אישור

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

• https://mail.google.com/

ראה גם

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

טעינת מחדש של ההודעה והמצב המשויך מ-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...

פרמטרים

חזרה

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

אישור

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

• https://mail.google.com/

ראה גם

• refreshMessages(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...

פרמטרים

חזרה

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

אישור

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

• https://mail.google.com/

ראה גם

• refreshMessage(message)

טעינת מחדש של השרשור והמצב המשויך מ-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 ...

פרמטרים

חזרה

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

אישור

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

• https://mail.google.com/

ראה גם

• refreshThreads(threads)

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

const 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 באמצעות השאילתה שצוינה.

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

// Find starred messages with subject IMPORTANT
const 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.
const 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.
const 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.
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',
    },
);

פרמטרים

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

חזרה

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

אישור

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

• https://mail.google.com/

ראה גם

• sendEmail(recipient, subject, body)

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

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

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

פרמטרים

אישור

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

• https://mail.google.com/

הוספת כוכב להודעה הזו ואילץ את ההודעה להתעדכן.

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

פרמטרים

חזרה

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

אישור

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

• https://mail.google.com/

ראה גם

• starMessages(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);

פרמטרים

חזרה

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

אישור

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

• https://mail.google.com/

ראה גם

• starMessage(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);

פרמטרים

חזרה

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

אישור

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

• https://mail.google.com/

ראה גם

• unstarMessages(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);

פרמטרים

חזרה

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

אישור

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

• https://mail.google.com/

ראה גם

• unstarMessage(message)