Gmail Service

Gmail

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

שיעורים

שםתיאור קצר
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|nullמקבלים שרשור לפי מזהה.
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|nullמקבל את סוג התוכן של הבייטים ב-Blob הזה.
getDataAsString()Stringמחזירה את הנתונים של ה-blob הזה כמחרוזת עם קידוד UTF-8.
getDataAsString(charset)Stringהפונקציה מחזירה את הנתונים של ה-blob הזה כמחרוזת עם הקידוד שצוין.
getHash()Stringהפונקציה מחזירה את גיבוב התוכן SHA1 של הקובץ המצורף הזה.
getName()String|nullהפונקציה מחזירה את השם של ה-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) ולכל הנמענים של ההודעה האחרונה בשרשור הזה, עם ארגומנטים אופציונליים.