Class GmailApp

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

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

• https://mail.google.com/

ראה גם

• createDraft(recipient, subject, body, options)

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

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 – התווית החדשה שנוצרה

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

• https://mail.google.com/

ראה גם

• createLabel(name)

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

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

// 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[] – מערך של כינויים לחשבון הזה

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

• https://mail.google.com/

ראה גם

• sendEmail(recipient, subject, body, options)

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

אפשר להשתמש בשיטה הזו בשילוב עם 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(),
);

פרמטרים

חזרה

‫GmailDraft – הטיוטה עם המזהה שצוין

מקפיצה את הודעות השגיאה (Throws)

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

• https://mail.google.com/

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

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

חזרה

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 בתיבת הדואר הנכנס

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 בתיבת הדואר הנכנס

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

• https://mail.google.com/

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

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

חזרה

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

• https://mail.google.com/

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

אפשר להשתמש בזה בשילוב עם 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 – ההודעה עם המזהה שצוין

מקפיצה את הודעות השגיאה (Throws)

‫Error — אם לא נמצאה הודעה עם המזהה שצוין

אישור

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

אישור

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

• https://mail.google.com/

ראה גם

• getMessagesForThread(thread)

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

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

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

חזרה

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

אישור

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

• https://mail.google.com/

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

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

חזרה

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

• https://mail.google.com/

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

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

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

חזרה

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 בתיקיית הספאם

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 — מספר שרשורי הספאם שיש בהם הודעות שלא נקראו

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

• https://mail.google.com/

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

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

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

חזרה

‫GmailThread[] — מערך של שרשורי אימייל ב-Gmail שסומנו בכוכב

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 שסומנו בכוכב

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

• https://mail.google.com/

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

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

חזרה

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 – השרשור עם המזהה הנתון או null אם הוא לא נמצא.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

• https://mail.google.com/

ראה גם

• getMessageById(id)

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

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

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

חזרה

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 באשפה

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

• https://mail.google.com/

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

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

פרמטרים

חזרה

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

אישור

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

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 (שימושי לשרשור)

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 (שימושי לשרשור)

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 שתואמים לשאילתה הזו

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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 שתואמים לשאילתה הזו

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

• https://mail.google.com/

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

// 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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

• https://mail.google.com/

ראה גם

• sendEmail(recipient, subject, body, options)

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

// 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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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
}

פרמטרים

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-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, שימושי לשרשור

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מהיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

• https://mail.google.com/

ראה גם

• unstarMessage(message)