דף זה תורגם על ידי Cloud Translation API.

Gmail Service

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

שיעורים

שם	תיאור קצר
`GmailApp`	מספקת גישה לשרשורים, להודעות ולתוויות ב-Gmail.
`GmailAttachment`	קובץ מצורף מ-Gmail.
`GmailDraft`	טיוטת הודעה שנוצרה על ידי משתמש בחשבון Gmail שלו.
`GmailLabel`	תווית שנוצרה על ידי משתמש בחשבון Gmail שלו.
`GmailMessage`	הודעה בחשבון Gmail של משתמש.
`GmailThread`	שיחה בחשבון Gmail של משתמש.

`GmailApp`

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
`createDraft(recipient, subject, body)`	`GmailDraft`	יצירת טיוטה של הודעת אימייל.
`createDraft(recipient, subject, body, options)`	`GmailDraft`	יצירת טיוטה של הודעת אימייל עם ארגומנטים אופציונליים.
`createLabel(name)`	`GmailLabel`	יוצרים תווית משתמש חדשה בשם הנתון.
`deleteLabel(label)`	`GmailApp`	מחיקת התווית שצוינה.
`getAliases()`	`String[]`	הפונקציה מקבלת רשימה של כתובות האימייל שמוגדרות ככתובות אימייל חלופיות לחשבון הזה ב-Gmail.
`getDraft(draftId)`	`GmailDraft`	אחזור טיוטה של הודעת אימייל לפי מזהה.
`getDraftMessages()`	`GmailMessage[]`	אחזור של כל הודעות הטיוטה.
`getDrafts()`	`GmailDraft[]`	הפונקציה מקבלת את כל טיוטות ההודעות ב-Gmail.
`getInboxThreads()`	`GmailThread[]`	אחזור של כל השרשור בתיבת הדואר הנכנס, ללא קשר לתוויות.
`getInboxThreads(start, max)`	`GmailThread[]`	אחזור של טווח של שיחות בתיבת הדואר הנכנס, ללא קשר לתוויות.
`getInboxUnreadCount()`	`Integer`	הפונקציה מקבלת את מספר השרשורים שלא נקראו בתיבת הדואר הנכנס.
`getMessageById(id)`	`GmailMessage`	אחזור הודעה לפי מזהה.
`getMessagesForThread(thread)`	`GmailMessage[]`	אחזור כל ההודעות בשרשור שצוין.
`getMessagesForThreads(threads)`	`GmailMessage[][]`	אחזור כל ההודעות בשרשורים שצוינו.
`getPriorityInboxThreads()`	`GmailThread[]`	אחזור של כל השרשורים בתיבת הדואר הנכנס בעדיפות גבוהה, ללא קשר לתוויות.
`getPriorityInboxThreads(start, max)`	`GmailThread[]`	אחזור של טווח שרשורים בתיבת הדואר הממוין, ללא קשר לתוויות.
`getPriorityInboxUnreadCount()`	`Integer`	הפונקציה מקבלת את מספר השרשורים שעדיין לא נקראו ב'דואר ממוין'.
`getSpamThreads()`	`GmailThread[]`	אחזור של כל השרשורים של הספאם, ללא קשר לתוויות.
`getSpamThreads(start, max)`	`GmailThread[]`	אחזור של מגוון של שרשראות ספאם, ללא קשר לתוויות.
`getSpamUnreadCount()`	`Integer`	הפונקציה מקבלת את מספר השרשורים שסומנו כספאם ושעדיין לא קראתם.
`getStarredThreads()`	`GmailThread[]`	אחזור של כל השרשורים שמסומנים בכוכב, ללא קשר לתוויות.
`getStarredThreads(start, max)`	`GmailThread[]`	אחזור של טווח של שרשורים שמסומנים בכוכב, ללא קשר לתוויות.
`getStarredUnreadCount()`	`Integer`	הפונקציה מקבלת את מספר השרשור שלא נקראו עם כוכב.
`getThreadById(id)`	`GmailThread`	אחזור שרשור לפי מזהה.
`getTrashThreads()`	`GmailThread[]`	אחזור של כל השרשורים שנמצאים בפח, ללא קשר לתוויות.
`getTrashThreads(start, max)`	`GmailThread[]`	מאחזר מגוון של חוטי אשפה ללא קשר לתוויות.
`getUserLabelByName(name)`	`GmailLabel`	אחזור תווית לפי שם התווית.
`getUserLabels()`	`GmailLabel[]`	אחזור רשימה של תוויות שנוצרו על ידי משתמשים.
`markMessageRead(message)`	`GmailApp`	סימון ההודעה כ'נקראה' ואילץ רענון של ההודעה.
`markMessageUnread(message)`	`GmailApp`	הסימון מגדיר את ההודעה כהודעה שלא נקראת ומאלץ את הרענון שלה.
`markMessagesRead(messages)`	`GmailApp`	סימון ההודעות האלה כ'נקראו' ואילץ את ההודעות להתעדכן.
`markMessagesUnread(messages)`	`GmailApp`	ההודעות האלה מסומנות כ'לא נקראו' והן מתעדכנות באופן אוטומטי.
`markThreadImportant(thread)`	`GmailApp`	סימון השרשור כחשוב ואילץ את השרשור להתעדכן.
`markThreadRead(thread)`	`GmailApp`	סימון השרשור כשרשור שנקרא ואילץ את השרשור להתעדכן.
`markThreadUnimportant(thread)`	`GmailApp`	סימון השרשור כ'לא חשוב' ואילץ את השרשור להתעדכן.
`markThreadUnread(thread)`	`GmailApp`	הסימון הזה מתייג את השרשור כשרשור שלא נקרא ומאלץ את השרשור להתעדכן.
`markThreadsImportant(threads)`	`GmailApp`	הסימון כחשוב יגרום לרענון של השרשורים האלה.
`markThreadsRead(threads)`	`GmailApp`	הסימון הזה יסמן את השרשורים האלה כנקראו ויאילץ את השרשורים להתעדכן.
`markThreadsUnimportant(threads)`	`GmailApp`	הסימון הזה יסמן את השרשורים האלה כלא חשובים ויאלץ אותם להתעדכן.
`markThreadsUnread(threads)`	`GmailApp`	הסימון הזה יסמן את השרשורים האלה כ'לא נקראו' ויביא לרענון שלהם.
`moveMessageToTrash(message)`	`GmailApp`	ההודעה תועבר לאשפה ותתבצע הפעלה מחדש שלה.
`moveMessagesToTrash(messages)`	`GmailApp`	ההודעות שצוינו מועברות לאשפה וההודעות מתעדכנות.
`moveThreadToArchive(thread)`	`GmailApp`	העברת השרשור הזה לארכיון ואילץ את השרשור להתעדכן.
`moveThreadToInbox(thread)`	`GmailApp`	ההודעה תועבר לתיבת הדואר הנכנס והשרשור ירענן.
`moveThreadToSpam(thread)`	`GmailApp`	העברת השרשור הזה לספאם ואילץ את השרשור להתעדכן.
`moveThreadToTrash(thread)`	`GmailApp`	העברת השרשור לאשפה ואילץ את השרשור להתעדכן.
`moveThreadsToArchive(threads)`	`GmailApp`	השרשור יועבר לארכיון והשרשורים ירעננו.
`moveThreadsToInbox(threads)`	`GmailApp`	השרשורים האלה יועברו לתיבת הדואר הנכנס ויחויבו לרענון.
`moveThreadsToSpam(threads)`	`GmailApp`	ההגדרה הזו מעבירה את השרשורים האלה לתיקיית הספאם ומאלצת את השרשורים להתעדכן.
`moveThreadsToTrash(threads)`	`GmailApp`	השרשור יועבר לאשפה והשרשורים ירעננו.
`refreshMessage(message)`	`GmailApp`	טעינת מחדש של ההודעה והמצב המשויך מ-Gmail (שימושי במקרה שהתוויות, מצב הקריאה וכו' השתנו).
`refreshMessages(messages)`	`GmailApp`	טעינת מחדש של ההודעות והמצב המשויך מ-Gmail (שימושי במקרה שהתוויות, מצב הקריאה וכו' השתנו).
`refreshThread(thread)`	`GmailApp`	טעינת מחדש של השרשור והמצב המשויך מ-Gmail (שימושי במקרה שהתוויות, מצב הקריאה וכו' השתנו).
`refreshThreads(threads)`	`GmailApp`	טעינת מחדש של השרשור והמצב המשויך מ-Gmail (שימושי במקרה שהתוויות, מצב הקריאה וכו' השתנו).
`search(query)`	`GmailThread[]`	מחפשים ב-Gmail באמצעות השאילתה שצוינה.
`search(query, start, max)`	`GmailThread[]`	מחפשים ב-Gmail באמצעות השאילתה שצוינה.
`sendEmail(recipient, subject, body)`	`GmailApp`	שליחת הודעת אימייל.
`sendEmail(recipient, subject, body, options)`	`GmailApp`	שליחת הודעת אימייל עם ארגומנטים אופציונליים.
`setCurrentMessageAccessToken(accessToken)`	`void`	מגדיר את הטוקן הנוכחי של הגישה להודעה שמאפשר לסקריפט לגשת לנכסי `GmailMessage` הנוכחיים.
`starMessage(message)`	`GmailApp`	הוספת כוכב להודעה הזו ואילץ את ההודעה להתעדכן.
`starMessages(messages)`	`GmailApp`	המערכת תוסיף כוכב להודעות האלה ותאלץ את ההודעות להתעדכן.
`unstarMessage(message)`	`GmailApp`	הסרת הכוכב מההודעה הזו ואילץ את ההודעה להתעדכן.
`unstarMessages(messages)`	`GmailApp`	הסרת הכוכבים מההודעות האלה ואילוץ הרענון שלהן.

`GmailAttachment`

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
`copyBlob()`	`Blob`	הפונקציה מחזירה עותק של ה-blob הזה.
`getAs(contentType)`	`Blob`	החזרת הנתונים שבתוך האובייקט הזה כ-blob שהומר לסוג התוכן שצוין.
`getBytes()`	`Byte[]`	אחזור הנתונים שמאוחסנים ב-blob הזה.
`getContentType()`	`String`	הפונקציה מקבלת את סוג התוכן של הבייטים ב-blob הזה.
`getDataAsString()`	`String`	הפונקציה מקבלת את הנתונים של ה-blob הזה כמחרוזת עם קידוד UTF-8.
`getDataAsString(charset)`	`String`	הפונקציה מקבלת את הנתונים של ה-blob הזה כמחרוזת עם הקידוד שצוין.
`getHash()`	`String`	הפונקציה מקבלת את גיבוב התוכן של SHA1 עבור הקובץ המצורף הזה.
`getName()`	`String`	הצגת השם של ה-blob.
`getSize()`	`Integer`	הפונקציה מקבלת את הגודל של הקובץ המצורף.
`isGoogleType()`	`Boolean`	הפונקציה מחזירה אם ה-blob הזה הוא קובץ Google Workspace (Sheets,‏ Docs וכו').
`setBytes(data)`	`Blob`	הגדרת הנתונים שמאוחסנים ב-blob הזה.
`setContentType(contentType)`	`Blob`	הגדרת סוג התוכן של הבייטים ב-blob הזה.
`setContentTypeFromExtension()`	`Blob`	הגדרת סוג התוכן של הבייטים ב-blob הזה על סמך סיומת הקובץ.
`setDataFromString(string)`	`Blob`	הגדרת הנתונים של ה-blob הזה ממחרוזת עם קידוד UTF-8.
`setDataFromString(string, charset)`	`Blob`	הגדרת הנתונים של ה-blob הזה ממחרוזת עם הקידוד שצוין.
`setName(name)`	`Blob`	הגדרת השם של ה-blob הזה.

`GmailDraft`

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
`deleteDraft()`	`void`	מחיקת הטיוטה של ההודעה.
`getId()`	`String`	הפונקציה מקבלת את המזהה של טיוטת ההודעה הזו.
`getMessage()`	`GmailMessage`	הפונקציה מחזירה GmailMessage שמייצג את הטיוטה הזו.
`getMessageId()`	`String`	הפונקציה מחזירה את המזהה של `GmailMessage` שמייצג את הטיוטה הזו.
`send()`	`GmailMessage`	שליחת טיוטת האימייל.
`update(recipient, subject, body)`	`GmailDraft`	הפעולה הזו תחליף את התוכן של טיוטת ההודעה הזו.
`update(recipient, subject, body, options)`	`GmailDraft`	מחליפה את התוכן של טיוטת ההודעה הזו באמצעות ארגומנטים אופציונליים.

`GmailLabel`

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
`addToThread(thread)`	`GmailLabel`	הוספת התווית הזו לשרשור הנתון ואילץ את השרשור להתעדכן (`GmailThread.refresh()`).
`addToThreads(threads)`	`GmailLabel`	הוספת התווית הזו לשרשור הנתון ואילץ את השרשור להתעדכן.
`deleteLabel()`	`void`	מחיקת התווית הזו.
`getName()`	`String`	הפונקציה מקבלת את השם של התווית הזו.
`getThreads()`	`GmailThread[]`	הפונקציה מקבלת את השרשורים שסומנו בתווית הזו.
`getThreads(start, max)`	`GmailThread[]`	הפונקציה מקבלת טווח של שרשורים שמסומנים בתווית הזו.
`getUnreadCount()`	`Integer`	הפונקציה מקבלת את מספר השרשור שלא נקראו שסומנו בתג הזה.
`removeFromThread(thread)`	`GmailLabel`	הסרת התווית הזו מהשרשור הנתון ואילץ את השרשור להתעדכן.
`removeFromThreads(threads)`	`GmailLabel`	הסרת התווית הזו מהשרשורים הרלוונטיים ואילץ את השרשורים להתעדכן.

`GmailMessage`

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
`createDraftReply(body)`	`GmailDraft`	יצירת טיוטה של הודעה שתישלח לשולח ההודעה הזו באמצעות כתובת התשובה.
`createDraftReply(body, options)`	`GmailDraft`	יצירת טיוטה של הודעה שתישלח בתשובה לשולח ההודעה הזו באמצעות כתובת התשובה, עם ארגומנטים אופציונליים.
`createDraftReplyAll(body)`	`GmailDraft`	יצירת טיוטה של הודעה שתישלח כתגובה לשולח באמצעות כתובת התשובה וכל הנמענים של ההודעה הזו.
`createDraftReplyAll(body, options)`	`GmailDraft`	יצירת טיוטה של תשובה לשולח ההודעה הזו באמצעות כתובת התשובה וכל הנמענים, עם ארגומנטים אופציונליים.
`forward(recipient)`	`GmailMessage`	העברת ההודעה הזו לנמענים חדשים.
`forward(recipient, options)`	`GmailMessage`	העברה של ההודעה הזו לנמענים חדשים, עם ארגומנטים אופציונליים.
`getAttachments()`	`GmailAttachment[]`	הפונקציה מקבלת את כל הקבצים המצורפים להודעה הזו.
`getAttachments(options)`	`GmailAttachment[]`	הפונקציה מקבלת את כל הקבצים המצורפים להודעה הזו.
`getBcc()`	`String`	הפונקציה מקבלת את הנמענים שמפורטים בפסיקים, שמוגדרים כעותק מוסתר בהודעה הזו.
`getBody()`	`String`	הפונקציה מקבלת את תוכן ה-HTML של גוף ההודעה.
`getCc()`	`String`	הפונקציה מקבלת את הנמענים שנוספו בשדה 'עותק' של ההודעה הזו, מופרדים בפסיקים.
`getDate()`	`Date`	הפונקציה מקבלת את התאריך והשעה של ההודעה הזו.
`getFrom()`	`String`	הפונקציה מקבלת את השולח של ההודעה.
`getHeader(name)`	`String`	הפונקציה מקבלת את השם של כותרת RFC 2822 ומציגה את הערך שלה.
`getId()`	`String`	הפונקציה מקבלת את המזהה של ההודעה הזו.
`getPlainBody()`	`String`	הפונקציה מקבלת את תוכן גוף ההודעה הזו ללא עיצוב HTML.
`getRawContent()`	`String`	הפונקציה מקבלת את התוכן הגולמי של ההודעה.
`getReplyTo()`	`String`	הפונקציה מקבלת את כתובת התשובה של ההודעה הזו (בדרך כלל זו כתובת השולח).
`getSubject()`	`String`	הפונקציה מקבלת את נושא ההודעה.
`getThread()`	`GmailThread`	הפונקציה מקבלת את השרשור שמכיל את ההודעה הזו.
`getTo()`	`String`	הפונקציה מקבלת את הנמענים של ההודעה הזו, שמופרדים בפסיקים.
`isDraft()`	`Boolean`	הפונקציה מקבלת את הערך 'כן' אם ההודעה היא טיוטה.
`isInChats()`	`Boolean`	הפונקציה מקבלת את ההודעה ומציינת אם היא צ'אט.
`isInInbox()`	`Boolean`	הפונקציה מקבלת את הערך 'true' אם ההודעה הזו נמצאת בתיבת הדואר הנכנס.
`isInPriorityInbox()`	`Boolean`	הפונקציה מחזירה את הערך `true` אם ההודעה הזו נמצאת בתיבת הדואר הנכנס בעדיפות גבוהה, ואת הערך `false` במקרים אחרים.
`isInTrash()`	`Boolean`	הפונקציה מקבלת את הערך 'true' אם ההודעה נמצאת באשפה.
`isStarred()`	`Boolean`	הפונקציה מקבלת את הערך שמציין אם ההודעה מסומנת בכוכב.
`isUnread()`	`Boolean`	הפונקציה מקבלת את הסטטוס של ההודעה – אם היא נקראת או לא.
`markRead()`	`GmailMessage`	סימון ההודעה כהודעה ש'כבר קראתי'.
`markUnread()`	`GmailMessage`	סימון ההודעה כהודעה שלא נקראה.
`moveToTrash()`	`GmailMessage`	ההודעה מועברת לאשפה.
`refresh()`	`GmailMessage`	טעינת מחדש של ההודעה הזו והמצב המשויך מ-Gmail (שימושי במקרה שהתוויות, מצב הקריאה וכו' השתנו).
`reply(body)`	`GmailMessage`	משיבים לשולח ההודעה הזו באמצעות כתובת התשובה.
`reply(body, options)`	`GmailMessage`	שליחת תשובה לשולח ההודעה הזו באמצעות כתובת התשובה, עם ארגומנטים אופציונליים.
`replyAll(body)`	`GmailMessage`	התשובות יישלחו לשולח באמצעות כתובת האימייל ל'תשובה אל' ולכל הנמענים של ההודעה הזו.
`replyAll(body, options)`	`GmailMessage`	שליחת תשובה לשולח ההודעה הזו באמצעות כתובת התשובה לכל הנמענים, עם ארגומנטים אופציונליים.
`star()`	`GmailMessage`	סימון ההודעה בכוכב.
`unstar()`	`GmailMessage`	הסרת הכוכב מההודעה.

`GmailThread`

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`) לכל הנמענים של ההודעה האחרונה בשרשור הזה, עם ארגומנטים אופציונליים.