Gmail Service

Gmail

השירות הזה מאפשר לכם לשלוח אימייל, לכתוב טיוטות, לנהל תוויות, לסמן הודעות ושרשורים ולבצע מגוון משימות אחרות לניהול חשבון 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מחיקת התווית הזו.
getId()Stringמחזירה את המזהה של התווית.
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מחזירה אם ההודעה הזו נמצאת בתיבת הדואר הנכנס.
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

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הפונקציה מחזירה תשובה אם השרשור מסומן כחשוב.
isInChats()Booleanהפונקציה מחזירה תשובה אם השרשור מסומן כצ'אט.
isInInbox()Booleanהפונקציה מחזירה תשובה אם השרשור נמצא בתיבת הדואר הנכנס.
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) ולכל הנמענים של ההודעה האחרונה בשרשור הזה, עם ארגומנטים אופציונליים.