Gmail Service

Gmail

Ta usługa umożliwia wysyłanie e-maili, pisanie wersji roboczych, zarządzanie etykietami, oznaczanie wiadomości i wątków oraz wykonywanie różnych innych zadań związanych z zarządzaniem kontem Gmail. Zobacz też usługę poczty, prostszą usługę, która pozwala tylko na 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 użytkownika.
GmailLabelEtykieta utworzona przez użytkownika na koncie Gmail użytkownika.
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ą wiadomości e-mail z opcjonalnymi argumentami.
createLabel(name)GmailLabelUtwórz nową etykietę użytkownika o podanej 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ą wiadomości e-mail 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 z Odebranych niezależnie od etykiet.
getInboxThreads(start, max)GmailThread[]Pobiera zakres wątków ze skrzynki odbiorczej niezależnie od etykiet.
getInboxUnreadCount()IntegerPobiera liczbę nieprzeczytanych wątków w skrzynce odbiorczej.
getMessageById(id)GmailMessagePobiera wiadomość na podstawie identyfikatora.
getMessagesForThread(thread)GmailMessage[]Pobierz wszystkie wiadomości w określonym wątku.
getMessagesForThreads(threads)GmailMessage[][]Pobierz wszystkie wiadomości w określonych wątkach.
getPriorityInboxThreads()GmailThread[]Pobiera wszystkie wątki z Priorytetów niezależnie od etykiet.
getPriorityInboxThreads(start, max)GmailThread[]Pobiera zakres wątków z Priorytetów niezależnie od etykiet.
getPriorityInboxUnreadCount()IntegerPobiera liczbę nieprzeczytanych wątków w Priorytetach.
getSpamThreads()GmailThread[]Pobiera wszystkie wątki ze spamem niezależnie od etykiet.
getSpamThreads(start, max)GmailThread[]Pobiera różne wątki ze spamem niezależnie od etykiet.
getSpamUnreadCount()IntegerPobiera liczbę nieprzeczytanych wątków, które są spamem.
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 z kosza niezależnie od etykiet.
getTrashThreads(start, max)GmailThread[]Pobiera zakres wątków z kosza niezależnie od etykiet.
getUserLabelByName(name)GmailLabelPobiera etykietę o jej nazwie.
getUserLabels()GmailLabel[]Pobiera listę etykiet utworzonych przez użytkownika.
markMessageRead(message)GmailAppOznacza tę wiadomość jako przeczytaną i wymusza jej odświeżenie.
markMessageUnread(message)GmailAppOznacza tę 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 te wiadomości jako nieprzeczytane i wymusza ich odświeżenie.
markThreadImportant(thread)GmailAppOznacza ten wątek jako ważny i wymusza jego odświeżenie.
markThreadRead(thread)GmailAppOznacza ten 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)GmailAppOznaczy ten wątek jako nieprzeczytany i wymusza jego odświeżenie.
markThreadsImportant(threads)GmailAppOznacza 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 wątki jako nieważne i wymusza ich odświeżenie.
markThreadsUnread(threads)GmailAppOznacza takie wątki jako nieprzeczytane i wymusza ich odświeżenie.
moveMessageToTrash(message)GmailAppPrzenosi wiadomość do kosza i wymusza jej odświeżenie.
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.
moveThreadToTrash(thread)GmailAppPrzenosi ten wątek do kosza i wymusza jego odświeżenie.
moveThreadsToArchive(threads)GmailAppPrzenosi te wątki do archiwum i wymusza ich odświeżenie.
moveThreadsToInbox(threads)GmailAppPrzenosi te wątki do skrzynki odbiorczej i wymusza ich odświeżenie.
moveThreadsToSpam(threads)GmailAppPrzenosi te wątki do spamu i wymusza odświeżanie.
moveThreadsToTrash(threads)GmailAppPrzenosi te wątki do kosza i wymusza ich odświeżenie.
refreshMessage(message)GmailAppWczytuje ponownie wiadomość i powiązany stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.).
refreshMessages(messages)GmailAppWczytuje ponownie wiadomości i powiązany stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.).
refreshThread(thread)GmailAppWczytuje ponownie wątek i powiązany stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.).
refreshThreads(threads)GmailAppWczytuje ponownie wątki i powiązany z nimi stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.).
search(query)GmailThread[]przeszukiwanie Gmaila przy użyciu danego zapytania;
search(query, start, max)GmailThread[]przeszukiwanie Gmaila przy użyciu danego 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 gwiazdkę do wiadomości i wymusza jej odświeżenie.
starMessages(messages)GmailAppPowoduje dodanie gwiazdek do wiadomości i wymusza ich odświeżenie.
unstarMessage(message)GmailAppUsuwa gwiazdkę z wiadomości i wymusza jej odświeżenie.
unstarMessages(messages)GmailAppUsuwa gwiazdki z tych wiadomości i wymusza ich odświeżenie.

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 obiekcie blob.
getContentType()StringPobiera typ treści bajtów tego obiektu blob.
getDataAsString()StringPobiera dane tego obiektu blob jako ciągu znaków z kodowaniem UTF-8.
getDataAsString(charset)StringPobiera dane tego obiektu blob jako ciąg znaków o określonym kodowaniu.
getHash()StringPobiera hasz treści SHA1 dla tego załącznika.
getName()StringPobiera nazwę tego obiektu blob.
getSize()IntegerPobiera rozmiar tego załącznika.
isGoogleType()BooleanZwraca, czy dany obiekt blob jest plikiem Google Workspace (Arkuszy, Dokumentów itp.).
setBytes(data)BlobUstawia dane przechowywane w tym obiekcie blob.
setContentType(contentType)BlobUstawia typ treści bajtów w tym obiekcie blob.
setContentTypeFromExtension()BlobUstawia typ treści bajtów w tym obiekcie blobowym na podstawie rozszerzenia pliku.
setDataFromString(string)BlobUstawia dane tego obiektu blob na podstawie ciągu znaków z kodowaniem UTF-8.
setDataFromString(string, charset)BlobUstawia dane tego obiektu blob z ciągu znaków o określonym kodowaniu.
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ść GmailMessage reprezentującą tę wersję roboczą.
getMessageId()StringZwraca identyfikator elementu GmailMessage reprezentującego tę wersję roboczą.
send()GmailMessageWysyła wersję roboczą e-maila.
update(recipient, subject, body)GmailDraftZastępuje treść tej wersji roboczej wiadomości.
update(recipient, subject, body, options)GmailDraftZastępuje treść tej wersji roboczej wiadomości przy użyciu opcjonalnych argumentów.

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 ich odświeżenie.
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ątku.

GmailMessage

Metody

MetodaZwracany typKrótki opis
createDraftReply(body)GmailDraftTworzy wersję roboczą wiadomości, odpowiadając nadawcy na tę wiadomość przy użyciu adresu zwrotnego.
createDraftReply(body, options)GmailDraftTworzy wersję roboczą wiadomości, która odpowiada nadawcy tej wiadomości, używając adresu zwrotnego z opcjonalnymi argumentami.
createDraftReplyAll(body)GmailDraftTworzy wersję roboczą wiadomości, która odpowiada nadawcy z użyciem adresu zwrotnego i wszystkich odbiorców tej wiadomości.
createDraftReplyAll(body, options)GmailDraftTworzy wersję roboczą wiadomości, która odpowiada nadawcy tej wiadomości, używając adresu zwrotnego i wszystkich odbiorców z opcjonalnymi argumentami.
forward(recipient)GmailMessagePrzekazuje tę wiadomość do nowych odbiorców.
forward(recipient, options)GmailMessagePrzekazuje tę wiadomość do nowych adresatów z opcjonalnymi argumentami.
getAttachments()GmailAttachment[]Pobiera wszystkie załączniki do tej wiadomości.
getAttachments(options)GmailAttachment[]Pobiera wszystkie załączniki do tej wiadomości.
getBcc()StringPobiera adresatów, którzy zostali dodani do wiadomości (UDW).
getBody()StringPobiera treść HTML tej wiadomości.
getCc()StringPobiera adresatów rozdzielonych przecinkami, których kopia została utworzona w polu 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 z nazwą nagłówka.
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 (zwykle nadawcy).
getSubject()StringPobiera temat tej wiadomości.
getThread()GmailThreadPobiera wątek zawierający tę wiadomość.
getTo()StringPobiera adresatów tej wiadomości rozdzielonych przecinkami.
isDraft()BooleanWskazuje, czy wiadomość jest wersją roboczą.
isInChats()BooleanSprawdza, czy wiadomość jest czatem.
isInInbox()BooleanWskazuje, czy wiadomość znajduje się w skrzynce odbiorczej.
isInPriorityInbox()BooleanZwraca wartość true, jeśli ta wiadomość znajduje się w skrzynce odbiorczej Priorytety. W przeciwnym razie zwraca wartość false.
isInTrash()BooleanSprawdza, czy wiadomość znajduje się w koszu.
isStarred()BooleanWskazuje, czy wiadomość jest oznaczona gwiazdką.
isUnread()BooleanWskazuje, czy wiadomość jest nieprzeczytana.
markRead()GmailMessageOznacza wiadomość jako przeczytaną.
markUnread()GmailMessageOznacza wiadomość jako nieprzeczytaną.
moveToTrash()GmailMessagePrzenosi wiadomość do kosza.
refresh()GmailMessageWczytuje ponownie tę wiadomość i powiązany stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.).
reply(body)GmailMessageOdpowiada nadawcy tej wiadomości przy użyciu adresu zwrotnego.
reply(body, options)GmailMessageOdpowiada nadawcy tej wiadomości przy użyciu adresu zwrotnego z opcjonalnymi argumentami.
replyAll(body)GmailMessageOdpowiada nadawcy, używając adresu zwrotnego i wszystkich odbiorców tej wiadomości.
replyAll(body, options)GmailMessageOdpowiada nadawcy tej wiadomości z użyciem adresu zwrotnego i wszystkich odbiorców z opcjonalnymi argumentami.
star()GmailMessageoznacza wiadomość gwiazdką.
unstar()GmailMessageUsuwa gwiazdkę z wiadomości.

GmailThread

Metody

MetodaZwracany typKrótki opis
addLabel(label)GmailThreadDodaje tę etykietę do wątku.
createDraftReply(body)GmailDraftTworzy wersję roboczą wiadomości, odpowiadając nadawcy ostatniej wiadomości w tym wątku przy użyciu adresu zwrotnego.
createDraftReply(body, options)GmailDraftTworzy wersję roboczą wiadomości, która odpowiada nadawcy ostatniej wiadomości w tym wątku, korzystając z adresu zwrotnego z opcjonalnymi argumentami.
createDraftReplyAll(body)GmailDraftTworzy wersję roboczą wiadomości, która jest wysyłana do nadawcy ostatniej wiadomości w tym wątku, przy użyciu adresu zwrotnego i wszystkich adresatów tej wiadomości.
createDraftReplyAll(body, options)GmailDraftTworzy wersję roboczą wiadomości, która odpowiada nadawcy ostatniej wiadomości w tym wątku, przy użyciu adresu zwrotnego i wszystkich odbiorców z opcjonalnymi argumentami.
getFirstMessageSubject()StringPobiera temat pierwszej wiadomości w wątku.
getId()StringPobiera identyfikator tego wątku.
getLabels()GmailLabel[]Zwraca etykiety utworzone przez użytkownika w tym wątku.
getLastMessageDate()DatePobiera datę najnowszej wiadomości w tym wątku.
getMessageCount()IntegerZwraca liczbę wiadomości w wątku.
getMessages()GmailMessage[]Pobiera wiadomości w tym wątku.
getPermalink()StringPobiera link bezpośredni do tego wątku.
hasStarredMessages()BooleanWskazuje, czy wątek zawiera wiadomości oznaczone gwiazdką.
isImportant()BooleanWskazuje, czy wątek jest oznaczony jako ważny.
isInChats()BooleanWskazuje, czy wątek jest oznaczony etykietą czatu.
isInInbox()BooleanWskazuje, czy wątek znajduje się w skrzynce odbiorczej.
isInPriorityInbox()BooleanZwraca wartość „true” (prawda), jeśli wątek znajduje się w skrzynce odbiorczej Priorytetów. W przeciwnym razie zwraca wartość „false” (fałsz).
isInSpam()BooleanWskazuje, czy wątek jest oznaczony jako spam.
isInTrash()BooleanWskazuje, czy wątek znajduje się w koszu.
isUnread()BooleanZwraca, 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()GmailThreadPrzenosi ten wątek do archiwum.
moveToInbox()GmailThreadPrzenosi ten wątek do skrzynki odbiorczej.
moveToSpam()GmailThreadPrzeniesienie tego wątku do spamu.
moveToTrash()GmailThreadPrzenosi ten wątek do kosza.
refresh()GmailThreadPonownie wczytuje ten wątek i powiązany stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.).
removeLabel(label)GmailThreadUsuwa tę etykietę z wątku.
reply(body)GmailThreadOdpowiedz nadawcy ostatniej wiadomości w tym wątku, korzystając z adresu „ReplyTo”.
reply(body, options)GmailThreadOdpowiedz nadawcy ostatniej wiadomości w tym wątku, korzystając z adresu zwrotnego z opcjonalnymi argumentami.
replyAll(body)GmailThreadOdpowiedz nadawcy (przy użyciu adresu zwrotnego) i wszystkich odbiorców ostatniej wiadomości w tym wątku.
replyAll(body, options)GmailThreadOdpowiedz nadawcy (używając adresu replyTo) i wszystkich odbiorców ostatniej wiadomości w tym wątku, używając opcjonalnych argumentów.