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

Gmail Service

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

מחלקות

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

`GmailApp`

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`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[]`	מאחזר מגוון של שרשורים ב-Inbox, ללא קשר לתוויות.
`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`

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`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`

שיטות

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

`GmailLabel`

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`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`

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`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`	מציין אם ההודעה נמצאת בתיבת הדואר הנכנס.
`isInPriorityInbox()`	`Boolean`	הפונקציה מחזירה את הערך `true` אם ההודעה הזו נמצאת בתיבת הדואר הנכנס בעדיפות גבוהה. אחרת, היא מחזירה את הערך `false`.
`isInTrash()`	`Boolean`	הפונקציה בודקת אם ההודעה נמצאת באשפה.
`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`

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`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`	מחזירה אם השרשור מסומן כחשוב.
`isInChats()`	`Boolean`	פונקציה זו מחזירה את הסימון אם השרשור מסומן כצ'אט.
`isInInbox()`	`Boolean`	מחזירה אם השרשור נמצא בתיבת הדואר הנכנס.
`isInPriorityInbox()`	`Boolean`	הפונקציה מחזירה את הערך True אם השרשור הזה נמצא בתיבת הדואר הנכנס בעדיפות גבוהה. אחרת, היא מחזירה את הערך false.
`isInSpam()`	`Boolean`	מראה אם השרשור מסומן כספאם.
`isInTrash()`	`Boolean`	מראה אם השרשור נמצא באשפה.
`isUnread()`	`Boolean`	מחזירה אם יש בשרשור הודעות שלא נקראו.
`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`	להשיב לשולח של ההודעה האחרונה בשרשור הזה באמצעות הכתובת לתשובה.
`reply(body, options)`	`GmailThread`	להשיב לשולח של ההודעה האחרונה בשרשור הזה באמצעות הכתובת responseTo, עם ארגומנטים אופציונליים.
`replyAll(body)`	`GmailThread`	שליחת תשובה לשולח (באמצעות הכתובת לתשובה) ולכל הנמענים של ההודעה האחרונה בשרשור הזה.
`replyAll(body, options)`	`GmailThread`	כתיבת תשובה לשולח (באמצעות הכתובת `replyTo`) ולכל הנמענים של ההודעה האחרונה בשרשור, עם ארגומנטים אופציונליים.