Class GmailThread

Gmailשרשור

שיחה בחשבון Gmail של משתמש.

Methods

שיטהסוג הערך המוחזרתיאור קצר
addLabel(label)GmailThreadהוספת התווית הזו לשרשור.
createDraftReply(body)GmailDraftיצירת טיוטת הודעה שתישלח למי ששלח את ההודעה האחרונה בשרשור הזה, באמצעות כתובת האימייל ל'מענה אל'.
createDraftReply(body, options)GmailDraftיצירת טיוטה של הודעה שתישלח בתשובה לשולח ההודעה האחרונה בשרשור הזה, באמצעות כתובת האימייל של השולח, עם ארגומנטים אופציונליים.
createDraftReplyAll(body)GmailDraftהאפשרות הזו יוצרת טיוטה של הודעה שתישלח לשולח ההודעה האחרונה בשרשור הזה, באמצעות כתובת התשובה וכל הנמענים של ההודעה הזו.
createDraftReplyAll(body, options)GmailDraftיצירת טיוטת הודעה שתהיה תשובה לשולח ההודעה האחרונה בשרשור הזה, באמצעות כתובת התשובה וכל הנמענים, עם ארגומנטים אופציונליים.
getFirstMessageSubject()Stringהפונקציה מקבלת את הנושא של ההודעה הראשונה בשרשור.
getId()Stringהפונקציה מקבלת את המזהה של השרשור.
getLabels()GmailLabel[]הפונקציה מחזירה את התווית שנוצרה על ידי המשתמש בשרשור הזה.
getLastMessageDate()Dateהפונקציה מקבלת את התאריך של ההודעה האחרונה בשרשור הזה.
getMessageCount()Integerהפונקציה מחזירה את מספר ההודעות בשרשור.
getMessages()GmailMessage[]הצגת ההודעות בשרשור הזה.
getPermalink()Stringהפונקציה מקבלת קישור קבוע לשרשור הזה.
hasStarredMessages()Booleanהפונקציה מחזירה תשובה אם יש בשרשור הודעות שמסומנות בכוכב.
isImportant()Booleanהפונקציה מחזירה את הערך true אם השרשור מסומן כחשוב, או את הערך false אם לא.
isInChats()Booleanהפונקציה מחזירה אם השרשור מסומן כצ'אט.
isInInbox()Booleanהפונקציה מחזירה את הערך true אם השרשור נמצא בתיבת הדואר הנכנס.
isInPriorityInbox()Booleanהפונקציה מחזירה את הערך true אם השרשור נמצא בתיבת הדואר הנכנס בעדיפות גבוהה, ואת הערך false במקרים אחרים.
isInSpam()Booleanהפונקציה מחזירה אם השרשור סומן כספאם.
isInTrash()Booleanהפונקציה מחזירה אם השרשור נמצא באשפה.
isUnread()Booleanהפונקציה מחזירה את הערך True אם יש בשרשור הודעות שלא נקראו.
markImportant()GmailThreadסימון השרשור כחשוב.
markRead()GmailThreadסימון השרשור כנקרא.
markUnimportant()GmailThreadסימון השרשור כלא חשוב.
markUnread()GmailThreadסימון השרשור כ'לא נקרא'.
moveToArchive()GmailThreadהעברת השרשור לארכיון.
moveToInbox()GmailThreadהעברת השרשור הזה לתיבת הדואר הנכנס.
moveToSpam()GmailThreadהעברת השרשור הזה לספאם.
moveToTrash()GmailThreadהעברת השרשור לאשפה.
refresh()GmailThreadטעינת מחדש של השרשור הזה והמצב המשויך מ-Gmail (שימושי במקרה שהתוויות, מצב הקריאה וכו' השתנו).
removeLabel(label)GmailThreadהסרת התווית מהשרשור.
reply(body)GmailThreadמשיבים לשולח ההודעה האחרונה בשרשור הזה באמצעות הכתובת replyTo.
reply(body, options)GmailThreadמשיבים לשולח ההודעה האחרונה בשרשור הזה באמצעות כתובת replyTo, עם ארגומנטים אופציונליים.
replyAll(body)GmailThreadלהשיב לשולח (באמצעות כתובת replyTo) לכל הנמענים של ההודעה האחרונה בשרשור הזה.
replyAll(body, options)GmailThreadשליחת תשובה לשולח (באמצעות הכתובת replyTo) לכל הנמענים של ההודעה האחרונה בשרשור הזה, עם ארגומנטים אופציונליים.

מסמכים מפורטים

addLabel(label)

הוספת התווית הזו לשרשור.

// Add label MyLabel to the first thread in the inbox
const label = GmailApp.getUserLabelByName('MyLabel');
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.addLabel(label);

פרמטרים

שםסוגתיאור
labelGmailLabelהתווית שרוצים להחיל על השרשור

חזרה

GmailThread — השרשור הזה, שימושי לשרשור

אישור

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

  • https://mail.google.com/

ראה גם


createDraftReply(body)

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

// Create a draft reply to the message author with an acknowledgement.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.createDraftReply('Got your message');

פרמטרים

שםסוגתיאור
bodyStringגוף האימייל

חזרה

GmailDraft – טיוטת ההודעה החדשה שנוצרה

אישור

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

  • https://mail.google.com/

ראה גם


createDraftReply(body, options)

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

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

// Create a draft response with an HTML text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.createDraftReply('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: 'another@example.com',
});

פרמטרים

שםסוגתיאור
bodyStringגוף האימייל
optionsObjectאובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורטים בהמשך

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

שםסוגתיאור
attachmentsBlobSource[]מערך של קבצים שרוצים לשלוח באימייל
bccStringרשימה של כתובות אימייל שמופרדות בפסיקים, לצורך שליחת עותק מוסתר
ccStringרשימה מופרדת בפסיקים של כתובות אימייל לשליחת עותק
fromStringהכתובת שממנה צריך לשלוח את האימייל, והיא חייבת להיות אחד מהערכים שמוחזרים על ידי GmailApp.getAliases()
htmlBodyStringאם השדה מוגדר, מכשירים שיכולים להציג HTML ישתמשו בו במקום בארגומנט הנדרש body. אפשר להוסיף שדה inlineImages אופציונלי בגוף ה-HTML אם יש תמונות מוטמעות באימייל.
inlineImagesObjectאובייקט JavaScript שמכיל מיפוי ממפתח תמונה (String) לנתוני תמונה (BlobSource). ההנחה היא שמשתמשים בפרמטר htmlBody והוא מכיל הפניות לתמונות האלה בפורמט <img src="cid:imageKey" />
nameStringהשם של השולח של האימייל (ברירת המחדל: שם המשתמש)
replyToStringכתובת אימייל שישמש ככתובת ברירת המחדל לתשובות (ברירת המחדל: כתובת האימייל של המשתמש)
subjectStringשורת נושא חדשה לאימייל (עד 250 תווים)

חזרה

GmailDraft – טיוטת ההודעה החדשה שנוצרה

אישור

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

  • https://mail.google.com/

ראה גם


createDraftReplyAll(body)

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

// Create a draft reply to all recipients (except those bcc'd) of the last email
// in this thread.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReplyAll('Got your message');

פרמטרים

שםסוגתיאור
bodyStringגוף האימייל

חזרה

GmailDraft – טיוטת ההודעה החדשה שנוצרה

אישור

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

  • https://mail.google.com/

ראה גם


createDraftReplyAll(body, options)

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

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

// Create a draft reply, using an HTML text body, to all recipients (except
// those bcc'd) of the last email of in this thread.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.createDraftReplyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: 'another@example.com',
});

פרמטרים

שםסוגתיאור
bodyStringגוף האימייל
optionsObjectאובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורטים בהמשך

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

שםסוגתיאור
attachmentsBlobSource[]מערך של קבצים שרוצים לשלוח באימייל
bccStringרשימה של כתובות אימייל שמופרדות בפסיקים, לצורך שליחת עותק מוסתר
ccStringרשימה מופרדת בפסיקים של כתובות אימייל לשליחת עותק
fromStringהכתובת שממנה צריך לשלוח את האימייל, והיא חייבת להיות אחד מהערכים שמוחזרים על ידי GmailApp.getAliases()
htmlBodyStringאם השדה מוגדר, מכשירים שיכולים להציג HTML ישתמשו בו במקום בארגומנט הנדרש body. אפשר להוסיף שדה inlineImages אופציונלי בגוף ה-HTML אם יש תמונות מוטמעות באימייל.
inlineImagesObjectאובייקט JavaScript שמכיל מיפוי ממפתח תמונה (String) לנתוני תמונה (BlobSource). ההנחה היא שמשתמשים בפרמטר htmlBody והוא מכיל הפניות לתמונות האלה בפורמט <img src="cid:imageKey" />
nameStringהשם של השולח של האימייל (ברירת המחדל: שם המשתמש)
replyToStringכתובת אימייל שישמש ככתובת ברירת המחדל לתשובות (ברירת המחדל: כתובת האימייל של המשתמש)
subjectStringשורת נושא חדשה לאימייל. הגודל המקסימלי הוא 250 תווים.

חזרה

GmailDraft – טיוטת ההודעה החדשה שנוצרה

אישור

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

  • https://mail.google.com/

ראה גם


getFirstMessageSubject()

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

// Log the subject of the first message in the first thread in the inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(firstThread.getFirstMessageSubject());

חזרה

String – הנושא של ההודעה הראשונה בשרשור

אישור

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

  • https://mail.google.com/

ראה גם


getId()

הפונקציה מקבלת את המזהה של השרשור. המזהה של שרשור משתנה בהתאם להודעות שהוא מכיל. כדי לקבל מזהה עקבי של הודעה מסוימת בשרשור, צריך להפעיל את הפונקציה getMessages()[0].getId() במקום זאת.

// Log the subject of the first message in the first thread in the inbox.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const id = firstThread.getId();
// Get same thread by its ID.
const thread = GmailApp.getThreadById(id);
Logger.log(
    thread.getFirstMessageSubject() === firstThread.getFirstMessageSubject(),
);  // True

חזרה

String – המזהה של השרשור הזה


getLabels()

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

// Log the names of the labels attached to the first thread in the inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const labels = firstThread.getLabels();
for (let i = 0; i < labels.length; i++) {
  Logger.log(labels[i].getName());
}

חזרה

GmailLabel[] – מערך של תוויות לשרשור הזה

אישור

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

  • https://mail.google.com/

getLastMessageDate()

הפונקציה מקבלת את התאריך של ההודעה האחרונה בשרשור הזה.

// Log the date of the most recent message on the first thread in the inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(firstThread.getLastMessageDate());

חזרה

Date — התאריך של ההודעה האחרונה בשרשור

אישור

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

  • https://mail.google.com/

ראה גם


getMessageCount()

הפונקציה מחזירה את מספר ההודעות בשרשור.

// Log the number of messages in the thread
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(firstThread.getMessageCount());

חזרה

Integer – מספר ההודעות בשרשור

אישור

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

  • https://mail.google.com/

ראה גם


getMessages()

הצגת ההודעות בשרשור הזה.

// Log the subjects of the messages in the thread
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const messages = firstThread.getMessages();
for (let i = 0; i < messages.length; i++) {
  Logger.log(messages[i].getSubject());
}

חזרה

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

אישור

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

  • https://mail.google.com/

ראה גם


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

חשוב לזכור שהאפשרות הזו פועלת רק בממשק הקלאסי של Gmail, ולא ב-Inbox.

// Logs the permalink for the first thread in the inbox
const thread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(thread.getPermalink());

חזרה

String – הקישור הקבוע לשרשור הזה


hasStarredMessages()

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

// Log if this thread has starred messages
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(`has starred : ${firstThread.hasStarredMessages()}`);

חזרה

Boolean — הערך True מוחזר אם יש בשרשור הודעות שסומנו בכוכב

אישור

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

  • https://mail.google.com/

isImportant()

הפונקציה מחזירה את הערך true אם השרשור מסומן כחשוב, או את הערך false אם לא.

// Log if this thread is marked as important
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(`Important? : ${firstThread.isImportant()}`);

חזרה

Boolean — אם השרשור מסומן כחשוב.

אישור

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

  • https://mail.google.com/

isInChats()

הפונקציה מחזירה אם השרשור מסומן כצ'אט.

// Log if this thread is a chat
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(`is in chats? : ${firstThread.isInChats()}`);

חזרה

Boolean — הערך True אם השרשור מסומן כצ'אט

אישור

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

  • https://mail.google.com/

isInInbox()

הפונקציה מחזירה את הערך true אם השרשור נמצא בתיבת הדואר הנכנס.

// Log if this thread is in the inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(`is in the inbox? : ${firstThread.isInInbox()}`);

חזרה

Boolean — הערך True אם השרשור נמצא בתיבת הדואר הנכנס

אישור

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

  • https://mail.google.com/

isInPriorityInbox()

הפונקציה מחזירה את הערך true אם השרשור נמצא בתיבת הדואר הנכנס בעדיפות גבוהה, ואת הערך false במקרים אחרים.

// Log if this thread is in the priority inbox
const firstThread = GmailApp.getPriorityInboxThreads(0, 1)[0];
Logger.log(`is in priority inbox? ${firstThread.isInPriorityInbox()}`);

חזרה

Boolean — הערך true אם השרשור נמצא בתיבת הדואר הנכנס ברשימת 'חשוב'

אישור

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

  • https://mail.google.com/

isInSpam()

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

// Log if this thread is in the spam folder
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(`Spam? ${firstThread.isInSpam()}`);

חזרה

Boolean — אם השרשור הזה סומן כספאם.

אישור

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

  • https://mail.google.com/

isInTrash()

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

// Log if this thread is in the trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(`Trashed? ${firstThread.isInTrash()}`);

חזרה

Boolean — הערך True אם השרשור נמצא באשפה

אישור

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

  • https://mail.google.com/

isUnread()

הפונקציה מחזירה את הערך True אם יש בשרשור הודעות שלא נקראו.

// Log if this thread is unread
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
Logger.log(`Unread? ${firstThread.isUnread()}`);

חזרה

Boolean — true אם יש הודעות שלא נקראו

אישור

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

  • https://mail.google.com/

markImportant()

סימון השרשור כחשוב.

// Mark first inbox thread as important
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.markImportant();

חזרה

GmailThread — השרשור הזה, שימושי לשרשור

אישור

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

  • https://mail.google.com/

ראה גם


markRead()

סימון השרשור כנקרא.

// Mark first inbox thread as read
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.markRead();

חזרה

GmailThread — השרשור הזה, שימושי לשרשור

אישור

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

  • https://mail.google.com/

ראה גם


markUnimportant()

סימון השרשור כלא חשוב.

// Mark first inbox thread as unimportant
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.markUnimportant();

חזרה

GmailThread — השרשור הזה, שימושי לשרשור

אישור

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

  • https://mail.google.com/

ראה גם


markUnread()

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

// Mark first inbox thread as unread
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.markUnread();

חזרה

GmailThread — השרשור הזה, שימושי לשרשור

אישור

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

  • https://mail.google.com/

ראה גם


moveToArchive()

העברת השרשור לארכיון.

// Archive first inbox thread
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.moveToArchive();

חזרה

GmailThread — השרשור הזה, שימושי לשרשור

אישור

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

  • https://mail.google.com/

moveToInbox()

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

// Move first non-inbox thread to inbox
const firstThread = GmailApp.search('-in:inbox')[0];
firstThread.moveToInbox();

חזרה

GmailThread — השרשור הזה, שימושי לשרשור

אישור

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

  • https://mail.google.com/

moveToSpam()

העברת השרשור הזה לספאם.

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

חזרה

GmailThread — השרשור הזה, שימושי לשרשור

אישור

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

  • https://mail.google.com/

moveToTrash()

העברת השרשור לאשפה.

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

חזרה

GmailThread — השרשור הזה, שימושי לשרשור

אישור

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

  • https://mail.google.com/

refresh()

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

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
// ...Do something that may take a while here....
firstThread.refresh();  // Make sure it's up-to-date
// ...Do more stuff with firstThread ...

חזרה

GmailThread — השרשור הזה, שימושי לשרשור

אישור

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

  • https://mail.google.com/

removeLabel(label)

הסרת התווית מהשרשור.

const myLabel = GmailApp.getUserLabelByName('<your label>');
const threads = myLabel.getThreads();
for (const thread of threads) {
  thread.removeLabel(myLabel);
}

פרמטרים

שםסוגתיאור
labelGmailLabelהתווית שרוצים להסיר מהשרשור

חזרה

GmailThread — השרשור הזה, שימושי לשרשור

אישור

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

  • https://mail.google.com/

ראה גם


reply(body)

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

לתשומת ליבכם, הגודל הכולל של האימייל (כולל כל הכותרות) לא יכול לחרוג מ-20KB.

// Respond to author of last email in thread with acknowledgment
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.reply('Got your message');

פרמטרים

שםסוגתיאור
bodyStringגוף האימייל

חזרה

GmailThread — השרשור הזה, שימושי לשרשור

אישור

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

  • https://mail.google.com/

ראה גם


reply(body, options)

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

// Respond with HTML body text.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.reply('incapable of HTML', {
  htmlBody: 'some HTML body text',
  noReply: true,
});

פרמטרים

שםסוגתיאור
bodyStringגוף האימייל
optionsObjectאובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורטים בהמשך

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

שםסוגתיאור
ccStringרשימה של כתובות אימייל לשליחת עותק, מופרדות בפסיקים
bccStringרשימה של כתובות אימייל שמופרדות בפסיקים, לצורך הוספה בשדה 'עותק מוסתר'
htmlBodyStringאם השדה מוגדר, מכשירים שיכולים להציג HTML ישתמשו בו במקום בארגומנט הנדרש body. אפשר להוסיף שדה inlineImages אופציונלי בגוף ה-HTML אם יש תמונות מוטמעות באימייל.
nameStringהשם של השולח של האימייל (ברירת המחדל: שם המשתמש)
fromStringהכתובת שממנה צריך לשלוח את האימייל, והיא חייבת להיות אחד מהערכים שמוחזרים על ידי GmailApp.getAliases()
replyToStringכתובת אימייל שישמש ככתובת ברירת המחדל לתשובות (ברירת המחדל: כתובת האימייל של המשתמש)
noReplyBooleantrue אם האימייל צריך להישלח מכתובת אימייל גנרית ללא מענה כדי למנוע מהנמענים להשיב לאימיילים. האפשרות הזו זמינה רק לחשבונות Google Workspace, ולא למשתמשי Gmail.
attachmentsBlobSource[]מערך של קבצים שרוצים לשלוח באימייל
inlineImagesObjectאובייקט JavaScript שמכיל מיפוי ממפתח תמונה (String) לנתוני תמונה (BlobSource). ההנחה היא שמשתמשים בפרמטר htmlBody והוא מכיל הפניות לתמונות האלה בפורמט <img src="cid:imageKey" />

חזרה

GmailThread — השרשור הזה, שימושי לשרשור

אישור

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

  • https://mail.google.com/

ראה גם


replyAll(body)

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

לתשומת ליבכם, הגודל הכולל של האימייל (כולל כל הכותרות) לא יכול לחרוג מ-20KB.

// Respond to all with acknowledgment to the first thread in the inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.replyAll('Got your message');

פרמטרים

שםסוגתיאור
bodyStringגוף האימייל

חזרה

GmailThread — השרשור הזה, שימושי לשרשור

אישור

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

  • https://mail.google.com/

ראה גם


replyAll(body, options)

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

// Respond with HTML body text.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
firstThread.replyAll('incapable of HTML', {
  htmlBody: 'some HTML body text',
  noReply: true,
});

פרמטרים

שםסוגתיאור
bodyStringגוף האימייל
optionsObjectאובייקט JavaScript שמציין פרמטרים מתקדמים, כפי שמפורטים בהמשך

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

שםסוגתיאור
ccStringרשימה של כתובות אימייל לשליחת עותק, מופרדות בפסיקים
bccStringרשימה של כתובות אימייל שמופרדות בפסיקים, לצורך הוספה בשדה 'עותק מוסתר'
htmlBodyStringאם השדה מוגדר, מכשירים שיכולים להציג HTML ישתמשו בו במקום בארגומנט הנדרש body. אפשר להוסיף שדה inlineImages אופציונלי בגוף ה-HTML אם יש תמונות מוטמעות באימייל.
nameStringהשם של השולח של האימייל (ברירת המחדל: שם המשתמש)
fromStringהכתובת שממנה צריך לשלוח את האימייל, והיא חייבת להיות אחד מהערכים שמוחזרים על ידי GmailApp.getAliases()
replyToStringכתובת אימייל שישמש ככתובת ברירת המחדל לתשובות (ברירת המחדל: כתובת האימייל של המשתמש)
noReplyBooleantrue אם האימייל צריך להישלח מכתובת אימייל גנרית ללא מענה כדי למנוע מהנמענים להשיב לאימיילים. האפשרות הזו אפשרית רק לחשבונות G Suite, ולא למשתמשים ב-Gmail.
attachmentsBlobSource[]מערך של קבצים שרוצים לשלוח באימייל
inlineImagesObjectאובייקט JavaScript שמכיל מיפוי ממפתח תמונה (String) לנתוני תמונה (BlobSource). ההנחה היא שמשתמשים בפרמטר htmlBody והוא מכיל הפניות לתמונות האלה בפורמט <img src="cid:imageKey" />

חזרה

GmailThread — השרשור הזה, שימושי לשרשור

אישור

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

  • https://mail.google.com/

ראה גם