Gmail Service

Gmail

Ta usługa pozwala wysyłać e-maile, tworzyć wersje robocze, zarządzać etykietami, oznaczać wiadomości i wątki oraz wykonywać różne inne zadania związane z zarządzaniem kontem Gmail. Zobacz też usługę poczty, która umożliwia tylko wysyłanie e-maili.

Zajęcia

NazwaKrótki opis
GmailAppZapewnia dostęp do wątków, wiadomości i etykiet Gmaila.
GmailAttachmentZałącznik z Gmaila.
GmailDraftWersja robocza wiadomości utworzona przez użytkownika na koncie Gmail.
GmailLabelEtykieta utworzona przez użytkownika na koncie Gmail.
GmailMessageWiadomość na koncie Gmail użytkownika.
GmailThreadWątek na koncie Gmail użytkownika.

GmailApp

Metody

MetodaZwracany typKrótki opis
createDraft(recipient, subject, body)GmailDraftTworzy wersję roboczą e-maila.
createDraft(recipient, subject, body, options)GmailDraftTworzy wersję roboczą e-maila z opcjonalnymi argumentami.
createLabel(name)GmailLabelUtwórz nową etykietę użytkownika o danej nazwie.
deleteLabel(label)GmailAppUsuwa określoną etykietę.
getAliases()String[]Pobiera listę e-maili skonfigurowanych jako aliasy tego konta w Gmailu.
getDraft(draftId)GmailDraftPobierz wersję roboczą e-maila według identyfikatora.
getDraftMessages()GmailMessage[]Pobiera wszystkie wersje robocze wiadomości.
getDrafts()GmailDraft[]Pobiera wszystkie wersje robocze wiadomości z Gmaila.
getInboxThreads()GmailThread[]Pobiera wszystkie wątki w Odebranych niezależnie od etykiet.
getInboxThreads(start, max)GmailThread[]Pobiera zakres wątków w Odebranych bez względu na etykiety.
getInboxUnreadCount()IntegerPobiera liczbę nieprzeczytanych wątków w skrzynce odbiorczej.
getMessageById(id)GmailMessagePobiera wiadomość na podstawie identyfikatora.
getMessagesForThread(thread)GmailMessage[]Pobieranie wszystkich wiadomości w określonym wątku.
getMessagesForThreads(threads)GmailMessage[][]Pobieranie wszystkich wiadomości z określonych wątków.
getPriorityInboxThreads()GmailThread[]Pobiera wszystkie wątki z Priorytetów niezależnie od etykiet.
getPriorityInboxThreads(start, max)GmailThread[]Pobiera zakres Priorytetów skrzynki odbiorczej niezależnie od etykiet.
getPriorityInboxUnreadCount()IntegerPobiera liczbę nieprzeczytanych wątków w Priorytetach.
getSpamThreads()GmailThread[]Pobiera wszystkie wątki spamu niezależnie od etykiet.
getSpamThreads(start, max)GmailThread[]Pobiera zakres wątków spamu bez względu na etykiety.
getSpamUnreadCount()IntegerPobiera liczbę nieprzeczytanych wątków jako spamu.
getStarredThreads()GmailThread[]Pobiera wszystkie wątki oznaczone gwiazdką niezależnie od etykiet.
getStarredThreads(start, max)GmailThread[]Pobiera zakres wątków oznaczonych gwiazdką niezależnie od etykiet.
getStarredUnreadCount()IntegerPobiera liczbę nieprzeczytanych wątków oznaczonych gwiazdką.
getThreadById(id)GmailThreadPobiera wątek według identyfikatora.
getTrashThreads()GmailThread[]Pobiera wszystkie wątki kosza niezależnie od etykiet.
getTrashThreads(start, max)GmailThread[]Pobiera zakres wątków kosza niezależnie od etykiet.
getUserLabelByName(name)GmailLabelPobiera etykietę o nazwie.
getUserLabels()GmailLabel[]Pobiera listę etykiet utworzonych przez użytkowników.
markMessageRead(message)GmailAppOznacza wiadomość jako przeczytaną i wymusza jej odświeżenie.
markMessageUnread(message)GmailAppOznacza wiadomość jako nieprzeczytaną i wymusza jej odświeżenie.
markMessagesRead(messages)GmailAppOznacza te wiadomości jako przeczytane i wymusza ich odświeżenie.
markMessagesUnread(messages)GmailAppOznacza wiadomości jako nieprzeczytane i wymuszają ich odświeżenie.
markThreadImportant(thread)GmailAppOznacza wątek jako ważny i wymusza odświeżenie wątku.
markThreadRead(thread)GmailAppOznacza wątek jako przeczytany i wymusza jego odświeżenie.
markThreadUnimportant(thread)GmailAppOznacza wątek jako nieważny i wymusza jego odświeżenie.
markThreadUnread(thread)GmailAppOznacza wątek jako nieprzeczytany i wymusza jego odświeżenie.
markThreadsImportant(threads)GmailAppOznacza te wątki jako ważne i wymusza ich odświeżenie.
markThreadsRead(threads)GmailAppOznacza te wątki jako przeczytane i wymusza ich odświeżenie.
markThreadsUnimportant(threads)GmailAppOznacza te wątki jako nieistotne i wymusza ich odświeżenie.
markThreadsUnread(threads)GmailAppOznaczy te wątki jako nieprzeczytane i wymusi odświeżenie wątków.
moveMessageToTrash(message)GmailAppPrzeniesienie wiadomości do kosza i wymuszanie jej odświeżenia.
moveMessagesToTrash(messages)GmailAppPrzenosi określone wiadomości do kosza i wymusza ich odświeżenie.
moveThreadToArchive(thread)GmailAppPrzenosi ten wątek do archiwum i wymusza odświeżenie wątku.
moveThreadToInbox(thread)GmailAppPrzenosi ten wątek do skrzynki odbiorczej i wymusza odświeżenie wątku.
moveThreadToSpam(thread)GmailAppPrzenosi ten wątek do spamu i wymusza odświeżenie wątku.
moveThreadToTrash(thread)GmailAppPrzenosi ten wątek do kosza i wymusza odświeżenie wątku.
moveThreadsToArchive(threads)GmailAppSłuży do przenoszenia tych wątków do archiwum i wymusza odświeżenie wątków.
moveThreadsToInbox(threads)GmailAppPrzenosi te wątki do skrzynki odbiorczej i wymusza odświeżenie wątków.
moveThreadsToSpam(threads)GmailAppPowoduje przeniesienie tych wątków do spamu i wymusza odświeżenie wątków.
moveThreadsToTrash(threads)GmailAppPrzenosi te wątki do kosza i wymusza ich odświeżenie.
refreshMessage(message)GmailAppWczytuje ponownie wiadomość i powiązany z nią stan w Gmailu (jest to przydatne w przypadku zmiany etykiet, stanu odczytu itp.).
refreshMessages(messages)GmailAppWczytuje wiadomości i powiązany stan z Gmaila (jest to przydatne w przypadku zmiany etykiet, stanu odczytu itp.).
refreshThread(thread)GmailAppWczytuje wątek i powiązany stan z Gmaila (jest to przydatne w przypadku zmiany etykiet, stanu odczytu itp.).
refreshThreads(threads)GmailAppPonownie ładuje wątki i powiązany stan z Gmaila (przydatne na wypadek zmiany etykiet, stanu odczytu itp.).
search(query)GmailThread[]Wyszukaj Gmaila przy użyciu tego zapytania.
search(query, start, max)GmailThread[]Wyszukaj Gmaila przy użyciu tego zapytania.
sendEmail(recipient, subject, body)GmailAppWysyła e-maila.
sendEmail(recipient, subject, body, options)GmailAppWysyła e-maila z opcjonalnymi argumentami.
setCurrentMessageAccessToken(accessToken)voidUstawia bieżący token dostępu do wiadomości, który umożliwia skryptowi dostęp do bieżących właściwości GmailMessage.
starMessage(message)GmailAppDodaje do wiadomości gwiazdkę i wymusza odświeżenie wiadomości.
starMessages(messages)GmailAppDodaje do tych wiadomości gwiazdki i wymusza odświeżenie wiadomości.
unstarMessage(message)GmailAppUsunięcie gwiazdki z tej wiadomości i wymusza jej odświeżenie.
unstarMessages(messages)GmailAppUsuwa te wiadomości i wymusza odświeżenie wiadomości.

GmailAttachment

Metody

MetodaZwracany typKrótki opis
copyBlob()BlobZwraca kopię tego obiektu blob.
getAs(contentType)BlobZwraca dane wewnątrz tego obiektu jako obiekt blob przekonwertowany na określony typ treści.
getBytes()Byte[]Pobiera dane przechowywane w tym blobie.
getContentType()StringPobiera typ zawartości bajtów w tym blobie.
getDataAsString()StringPobiera dane tego obiektu blob jako ciąg tekstowy z kodowaniem UTF-8.
getDataAsString(charset)StringPobiera dane tego obiektu blob w postaci ciągu znaków z określonym kodowaniem.
getHash()StringPobiera identyfikator treści SHA1 tego załącznika.
getName()StringPobiera nazwę tego obiektu blob.
getSize()IntegerPobiera rozmiar tego załącznika.
isGoogleType()BooleanZwraca, czy ten obiekt blob jest plikiem Google Workspace (Arkusze, Dokumenty itp.).
setBytes(data)BlobUstawia dane przechowywane w tym blobie.
setContentType(contentType)BlobUstawia typ treści w bajtach w tym blobie.
setContentTypeFromExtension()BlobUstawia typ zawartości bajtów w tym blobie na podstawie rozszerzenia pliku.
setDataFromString(string)BlobUstawia dane tego obiektu blob z ciągu znaków z kodowaniem UTF-8.
setDataFromString(string, charset)BlobUstawia dane tego obiektu blob z ciągu znaków z określonym kodowaniem.
setName(name)BlobUstawia nazwę tego obiektu blob.

GmailDraft

Metody

MetodaZwracany typKrótki opis
deleteDraft()voidUsuwa tę wersję roboczą wiadomości.
getId()StringPobiera identyfikator tej wersji roboczej wiadomości.
getMessage()GmailMessageZwraca wiadomość Gmail odpowiadającą tej wersji roboczej.
getMessageId()StringZwraca identyfikator elementu GmailMessage reprezentującego wersję roboczą.
send()GmailMessageWysyła tę wersję roboczą e-maila.
update(recipient, subject, body)GmailDraftZastępuje zawartość tej wersji roboczej wiadomości.
update(recipient, subject, body, options)GmailDraftZastępuje zawartość tej wersji roboczej wiadomości, podając opcjonalne argumenty.

GmailLabel

Metody

MetodaZwracany typKrótki opis
addToThread(thread)GmailLabelDodaje tę etykietę do danego wątku i wymusza odświeżenie wątku (GmailThread.refresh()).
addToThreads(threads)GmailLabelDodaje tę etykietę do podanych wątków i wymusza odświeżenie wątków.
deleteLabel()voidUsuwa tę etykietę.
getName()StringPobiera nazwę tej etykiety.
getThreads()GmailThread[]Pobiera wątki oznaczone tą etykietą.
getThreads(start, max)GmailThread[]Pobiera zakres wątków oznaczonych tą etykietą.
getUnreadCount()IntegerPobiera liczbę nieprzeczytanych wątków oznaczonych tą etykietą.
removeFromThread(thread)GmailLabelUsuwa tę etykietę z danego wątku i wymusza odświeżenie wątku.
removeFromThreads(threads)GmailLabelUsuwa tę etykietę z podanych wątków i wymusza odświeżenie wątków.

GmailMessage

Metody

MetodaZwracany typKrótki opis
createDraftReply(body)GmailDraftTworzy wersję roboczą wiadomości, która odpowiada na wiadomość nadawcy, używając adresu zwrotnego.
createDraftReply(body, options)GmailDraftTworzy wersję roboczą wiadomości wysyłanej do nadawcy tej wiadomości z użyciem adresu zwrotnego z opcjonalnymi argumentami.
createDraftReplyAll(body)GmailDraftTworzy wersję roboczą wiadomości skierowanej do nadawcy, używając adresu zwrotnego i wszystkich adresatów tej wiadomości.
createDraftReplyAll(body, options)GmailDraftTworzy wersję roboczą wiadomości wysyłanej do nadawcy tej wiadomości z użyciem adresu zwrotnego i wszystkich adresatów oraz opcjonalnych argumentów.
forward(recipient)GmailMessagePrzekazuje tę wiadomość do nowych odbiorców.
forward(recipient, options)GmailMessagePowoduje przekazanie tej wiadomości do nowych odbiorców i opcjonalnych argumentów.
getAttachments()GmailAttachment[]Pobiera wszystkie załączniki do tej wiadomości.
getAttachments(options)GmailAttachment[]Pobiera wszystkie załączniki do tej wiadomości.
getBcc()StringPobiera odbiorców UDW dla tej wiadomości.
getBody()StringPobiera treść HTML treści wiadomości.
getCc()StringPobiera adresatów wiadomości rozdzielonych przecinkami (DW) tej wiadomości.
getDate()DatePobiera datę i godzinę tej wiadomości.
getFrom()StringPobiera nadawcę tej wiadomości.
getHeader(name)StringPobiera wartość nagłówka RFC 2822 po nazwie.
getId()StringPobiera identyfikator tej wiadomości.
getPlainBody()StringPobiera treść tej wiadomości bez formatowania HTML.
getRawContent()StringPobiera nieprzetworzoną treść tej wiadomości.
getReplyTo()StringPobiera adres zwrotny tej wiadomości (zazwyczaj nadawcy).
getSubject()StringPobiera temat tej wiadomości.
getThread()GmailThreadPobiera wątek zawierający tę wiadomość.
getTo()StringPobiera odbiorców wiadomości rozdzielonych przecinkami.
isDraft()BooleanOkreśla, czy wiadomość jest wersją roboczą.
isInChats()BooleanSprawdza, czy ta wiadomość jest czatem.
isInInbox()BooleanSprawdza, czy ta wiadomość jest w skrzynce odbiorczej.
isInPriorityInbox()BooleanZwraca wartość true, jeśli ta wiadomość znajduje się w folderze Priorytety. W przeciwnym razie zwraca false.
isInTrash()BooleanSprawdza, czy wiadomość jest w koszu.
isStarred()BooleanOkreśla, czy wiadomość jest oznaczona gwiazdką.
isUnread()BooleanOkreśla, czy wiadomość jest nieprzeczytana.
markRead()GmailMessageOznacza wiadomość jako przeczytaną.
markUnread()GmailMessageOznacza wiadomość jako nieprzeczytaną.
moveToTrash()GmailMessagePowoduje przeniesienie wiadomości do kosza.
refresh()GmailMessageWczytuje ponownie tę wiadomość i powiązany stan z Gmaila (na wypadek, gdyby etykiety, stan odczytu itp. uległy zmianie).
reply(body)GmailMessageOdpowiedzi do nadawcy tej wiadomości z wykorzystaniem adresu zwrotnego.
reply(body, options)GmailMessageOdpowiedzi do nadawcy tej wiadomości z adresem zwrotnym i opcjonalnymi argumentami.
replyAll(body)GmailMessageOdpowiedzi do nadawcy przy użyciu adresu zwrotnego i wszystkich odbiorców wiadomości.
replyAll(body, options)GmailMessageOdpowiedzi dla nadawcy tej wiadomości z wykorzystaniem adresu zwrotnego i wszystkich adresatów oraz opcjonalnych argumentów.
star()GmailMessageOznaczy wiadomość gwiazdką.
unstar()GmailMessageOznaczenie wiadomości gwiazdką zostanie usunięte.

GmailThread

Metody

MetodaZwracany typKrótki opis
addLabel(label)GmailThreadDodaje tę etykietę do wątku.
createDraftReply(body)GmailDraftTworzy wersję roboczą wiadomości odpowiadającej nadawcy ostatniej wiadomości w tym wątku, używając adresu zwrotnego.
createDraftReply(body, options)GmailDraftTworzy wersję roboczą wiadomości wysyłanej do nadawcy ostatniej wiadomości w tym wątku za pomocą adresu zwrotnego i opcjonalnych argumentów.
createDraftReplyAll(body)GmailDraftTworzy wersję roboczą wiadomości odpowiadającej nadawcy ostatniej wiadomości w tym wątku, używając adresu zwrotnego i wszystkich adresatów tej wiadomości.
createDraftReplyAll(body, options)GmailDraftTworzy wersję roboczą wiadomości odpowiadającej nadawcy ostatniej wiadomości w tym wątku, używając adresu zwrotnego i wszystkich adresatów oraz opcjonalnych argumentów.
getFirstMessageSubject()StringPobiera temat pierwszej wiadomości w wątku.
getId()StringPobiera identyfikator tego wątku.
getLabels()GmailLabel[]Zwraca etykiety utworzone przez użytkowników w tym wątku.
getLastMessageDate()DatePobiera datę ostatniej wiadomości w tym wątku.
getMessageCount()IntegerZwraca liczbę wiadomości w wątku.
getMessages()GmailMessage[]Pobiera wiadomości z tego wątku.
getPermalink()StringPobiera link bezpośredni do tego wątku.
hasStarredMessages()BooleanWskazuje, czy wątek zawiera wiadomości oznaczone gwiazdką.
isImportant()BooleanZwraca informację, czy wątek jest oznaczony jako ważny.
isInChats()BooleanWskazuje, czy wątek jest oznaczony jako czat.
isInInbox()BooleanZwraca, czy wątek jest w Odebranych.
isInPriorityInbox()BooleanZwraca „TRUE”, jeśli ten wątek znajduje się w priorytetowej skrzynce odbiorczej. W przeciwnym wypadku zwraca „FALSE”.
isInSpam()BooleanWskazuje, czy wątek jest oznaczony jako spam.
isInTrash()BooleanZwraca, czy wątek jest w koszu.
isUnread()BooleanWskazuje, czy wątek zawiera nieprzeczytane wiadomości.
markImportant()GmailThreadOznacza ten wątek jako ważny.
markRead()GmailThreadOznacza ten wątek jako przeczytany.
markUnimportant()GmailThreadOznacza ten wątek jako nieważny.
markUnread()GmailThreadOznacza ten wątek jako nieprzeczytany.
moveToArchive()GmailThreadPrzeniesienie tego wątku do archiwum.
moveToInbox()GmailThreadPrzenosi ten wątek do skrzynki odbiorczej.
moveToSpam()GmailThreadPowoduje przeniesienie tego wątku do spamu.
moveToTrash()GmailThreadPowoduje przeniesienie tego wątku do kosza.
refresh()GmailThreadWczytuje ponownie ten wątek i powiązany stan z Gmaila (jest to przydatne w przypadku zmiany etykiet, stanu odczytu itp.).
removeLabel(label)GmailThreadUsunięcie tej etykiety z wątku.
reply(body)GmailThreadOdpowiedz nadawcy nadawcy ostatniej wiadomości w tym wątku, podając adres responseTo.
reply(body, options)GmailThreadOdpowiedz nadawcy ostatniej wiadomości w tym wątku, podając adres responseTo i opcjonalnie argumenty.
replyAll(body)GmailThreadOdpowiedz nadawcy (korzystając z adresu responseTo) i wszystkim odbiorcom ostatniej wiadomości w tym wątku.
replyAll(body, options)GmailThreadOdpowiedz nadawcy (za pomocą adresu replyTo) i wszystkim odbiorcom ostatniej wiadomości w tym wątku, podając opcjonalne argumenty.