Gmail Service

Gmail

Ta usługa umożliwia wysyłanie e-maili, tworzenie wersji roboczych, zarządzanie etykietami, oznaczanie wiadomości i wątków oraz wykonywanie różnych innych czynności związanych z zarządzaniem kontem Gmail. Zobacz też Usługę poczty, która jest prostszą usługą umożliwiającą 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 utworzonej przez użytkownika na jego koncie Gmail.
GmailLabelEtykieta utworzona przez użytkownika na jego 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ą wiadomości e-mail.
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)GmailAppUsunięcie określonej etykiety.
getAliases()String[]Pobiera listę adresów e-mail 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 w Gmailu.
getInboxThreads()GmailThread[]Pobiera wszystkie wątki w skrzynce odbiorczej niezależnie od etykiet.
getInboxThreads(start, max)GmailThread[]Pobiera zakres wątków w skrzynce odbiorczej niezależnie od etykiet.
getInboxUnreadCount()IntegerPobiera liczbę nieprzeczytanych wątków w skrzynce odbiorczej.
getMessageById(id)GmailMessagePobiera wiadomość według 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 w skrzynce Priorytety bez względu na etykiety.
getPriorityInboxThreads(start, max)GmailThread[]Pobiera zakres wątków Priorytetów niezależnie od etykiet.
getPriorityInboxUnreadCount()IntegerPobiera liczbę nieprzeczytanych wątków w skrzynce Priorytety.
getSpamThreads()GmailThread[]Pobiera wszystkie wątki spamu niezależnie od etykiet.
getSpamThreads(start, max)GmailThread[]Pobiera zakres wątków spamu niezależnie od etykiet.
getSpamUnreadCount()IntegerPobiera liczbę nieprzeczytanych wątków, które są spamem.
getStarredThreads()GmailThread[]Pobiera wszystkie wątki z gwiazdką bez względu na etykiety.
getStarredThreads(start, max)GmailThread[]Pobiera zakres wątków oznaczonych gwiazdką bez względu na etykiety.
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ę na podstawie jej nazwy.
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 powoduje jej odświeżenie.
markMessagesRead(messages)GmailAppOznacza te wiadomości jako przeczytane i wymusza ich odświeżenie.
markMessagesUnread(messages)GmailAppOznaczy te wiadomości jako nieprzeczytane i wymusi ich odświeżenie.
markThreadImportant(thread)GmailAppOznacza ten wątek jako ważny i powoduje jego odświeżenie.
markThreadRead(thread)GmailAppOznacza ten wątek jako przeczytany i wymusza jego odświeżenie.
markThreadUnimportant(thread)GmailAppOznacza ten wątek jako mało ważny i powoduje jego odświeżenie.
markThreadUnread(thread)GmailAppOznacza ten 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 mało ważne i wymusza ich odświeżenie.
markThreadsUnread(threads)GmailAppOznacza te 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 jego odświeżenie.
moveThreadToInbox(thread)GmailAppPrzenosi ten wątek do skrzynki odbiorczej i wymusza jego odświeżenie.
moveThreadToSpam(thread)GmailAppPrzenosi ten wątek do folderu spamu i wymusza jego odświeżenie.
moveThreadToTrash(thread)GmailAppPrzenosi 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 ich odświeżenie.
moveThreadsToTrash(threads)GmailAppPrzenosi te wątki do kosza i wymusza ich odświeżenie.
refreshMessage(message)GmailAppPonowne załadowanie wiadomości i powiązanego stanu z Gmaila (przydatne, gdy zmieniły się etykiety, stan odczytania itp.).
refreshMessages(messages)GmailAppPonowne załadowanie wiadomości i powiązanego stanu z Gmaila (przydatne, gdy zmieniły się etykiety, stan odczytania itp.).
refreshThread(thread)GmailAppPonownie wczytuje wątek i powiązany stan z Gmaila (przydatne, gdy zmienią się etykiety, stan odczytania itp.).
refreshThreads(threads)GmailAppPonownie wczytuje wątki i powiązane stany z Gmaila (przydatne, gdy zmieniły się etykiety, stan odczytania itp.).
search(query)GmailThread[]Przeszukaj Gmaila za pomocą podanego zapytania.
search(query, start, max)GmailThread[]Przeszukaj Gmaila za pomocą podanego zapytania.
sendEmail(recipient, subject, body)GmailAppwysyła e-maile;
sendEmail(recipient, subject, body, options)GmailAppWysyła wiadomość e-mail z opcjonalnymi argumentami.
setCurrentMessageAccessToken(accessToken)voidUstawia bieżący token dostępu do wiadomości, który umożliwia skryptowi dostęp do bieżących usług GmailMessage.
starMessage(message)GmailAppDodaje gwiazdkę do tej wiadomości i wymusza jej odświeżenie.
starMessages(messages)GmailAppDodaje gwiazdki do tych wiadomości i wymusza ich odświeżenie.
unstarMessage(message)GmailAppUsuwa gwiazdkę z tej wiadomości i powoduje jej odświeżenie.
unstarMessages(messages)GmailAppusuwa gwiazdki z tych wiadomości i powoduje ich odświeżenie.

GmailAttachment

Metody

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

GmailDraft

Metody

MetodaZwracany typKrótki opis
deleteDraft()voidUsuwa tę wersję roboczą wiadomości.
getId()StringPobiera identyfikator tej wiadomości w wersji roboczej.
getMessage()GmailMessageZwraca GmailMessage reprezentujący tę wersję roboczą.
getMessageId()StringZwraca identyfikator GmailMessage reprezentujący ten projekt.
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 zawartość tego szkicu wiadomości za pomocą opcjonalnych argumentów.

GmailLabel

Metody

MetodaZwracany typKrótki opis
addToThread(thread)GmailLabelDodaje tę etykietę do danego wątku i wymusza jego odświeżenie (GmailThread.refresh()).
addToThreads(threads)GmailLabelDodaje tę etykietę do określonych 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 jego odświeżenie.
removeFromThreads(threads)GmailLabelUsuwa tę etykietę z określonych wątków i wymusza ich odświeżenie.

GmailMessage

Metody

MetodaZwracany typKrótki opis
createDraftReply(body)GmailDraftTworzy wersję roboczą wiadomości, która odpowiada nadawcy tej wiadomości, używając adresu zwrotnego.
createDraftReply(body, options)GmailDraftTworzy wersję roboczą wiadomości, która jest odpowiedzią na wiadomość nadawcy, z adresem zwrotnym i opcjonalnymi argumentami.
createDraftReplyAll(body)GmailDraftTworzy wersję roboczą wiadomości, która jest odpowiedzią na wiadomość nadawcy, i wysyła ją na adres zwrotny oraz do wszystkich adresató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 adresatów z opcjonalnymi argumentami.
forward(recipient)GmailMessagePrzesyła tę wiadomość do nowych odbiorców.
forward(recipient, options)GmailMessagePrzesyła 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 listę adresatów UDW oddzielonych przecinkami, którzy otrzymają tę wiadomość.
getBody()StringPobiera zawartość HTML treści wiadomości.
getCc()StringPobiera listę adresatów w polu DW, oddzielonych przecinkami.
getDate()DatePobiera datę i godzinę tego komunikatu.
getFrom()StringZwraca nadawcę tej wiadomości.
getHeader(name)StringPobiera wartość nagłówka RFC 2822 na podstawie jego nazwy.
getId()StringPobiera identyfikator tej wiadomości.
getPlainBody()StringPobiera treść treści wiadomości bez formatowania HTML.
getRawContent()StringPobiera surową treść wiadomości.
getReplyTo()StringPobiera adres zwrotny tej wiadomości (zwykle nadawcy).
getSubject()StringPobiera temat wiadomości.
getThread()GmailThreadPobiera wątku zawierającego tę wiadomość.
getTo()StringPobiera listę adresatów tej wiadomości, rozdzielonych przecinkami.
isDraft()BooleanOkreśla, czy wiadomość jest wersją roboczą.
isInChats()BooleanOkreśla, czy wiadomość jest czatem.
isInInbox()BooleanOkreśla, czy wiadomość znajduje się w skrzynce odbiorczej.
isInPriorityInbox()BooleanZwraca wartość true, jeśli wiadomość znajduje się w skrzynce priorytetowej, w przeciwnym razie zwraca wartość false.
isInTrash()BooleanOkreśla, czy wiadomość znajduje się 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()GmailMessagePrzenosi wiadomość do kosza.
refresh()GmailMessagePonowne załadowanie tej wiadomości i powiązanego stanu z Gmaila (przydatne, gdy zmieniły się etykiety, stan odczytania itp.).
reply(body)GmailMessageOdpowiedzi na wiadomość wysłane do nadawcy za pomocą adresu „Na adres”
reply(body, options)GmailMessageOdpowiedź dla nadawcy tej wiadomości z adresem zwrotnym i opcjonalnymi argumentami.
replyAll(body)GmailMessageOdpowiedzi na wiadomość są wysyłane do nadawcy i wszystkich adresatów, korzystając z adresu zwrotnego.
replyAll(body, options)GmailMessageOdpowiedzi na wiadomość wysłane do nadawcy przy użyciu adresu zwrotnego i wszystkich adresatów z opcjonalnymi argumentami.
star()GmailMessageOznaczy 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, która jest odpowiedzią na ostatnią wiadomość w wątku, z wykorzystaniem adresu e-mail w polu „adres do odpowiedzi”.
createDraftReply(body, options)GmailDraftTworzy wersję roboczą wiadomości, która odpowiada nadawcy ostatniej wiadomości w tym wątku, korzystając z adresu e-mail w polu „Na adres” (opcjonalnie z argumentami).
createDraftReplyAll(body)GmailDraftTworzy wersję roboczą wiadomości, która jest odpowiedzią na ostatnią wiadomość w tym wątku, z wykorzystaniem adresu zwrotnego i wszystkich adresatów tej wiadomości.
createDraftReplyAll(body, options)GmailDraftTworzy wersję roboczą wiadomości, która jest odpowiedzią na ostatniego nadawcę w tym wątku, przy użyciu adresu zwrotnego i wszystkich adresató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ę ostatniej wiadomości w wątku.
getMessageCount()IntegerZwraca liczbę wiadomości w wątku.
getMessages()GmailMessage[]Pobiera wiadomości z tego wątku.
getPermalink()StringPobiera link stały do tego wątku.
hasStarredMessages()BooleanZwraca informację, czy wątek zawiera wiadomości oznaczone gwiazdką.
isImportant()BooleanZwraca informację, czy wątek jest oznaczony jako ważny.
isInChats()BooleanZwraca informację, czy wątek jest oznaczony jako czat.
isInInbox()BooleanZwraca informację, czy wątek znajduje się w skrzynce odbiorczej.
isInPriorityInbox()BooleanZwraca wartość „prawda”, jeśli ten wątek znajduje się w skrzynce odbiorczej priorytetowej; w przeciwnym wypadku zwraca wartość „fałsz”.
isInSpam()BooleanZwraca informację, czy wątek jest oznaczony jako spam.
isInTrash()BooleanZwraca informację, 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 mało ważny.
markUnread()GmailThreadOznacza ten wątek jako nieprzeczytany.
moveToArchive()GmailThreadPrzenosi ten wątek do archiwum.
moveToInbox()GmailThreadPrzenosi ten wątek do skrzynki odbiorczej.
moveToSpam()GmailThreadPrzenosi ten wątek do spamu.
moveToTrash()GmailThreadPrzenosi ten wątek do kosza.
refresh()GmailThreadPonownie wczytuje ten wątek i powiązany stan z Gmaila (przydatne, gdy zmieniły się etykiety, stan odczytania itp.).
removeLabel(label)GmailThreadUsuwa tę etykietę z wątku.
reply(body)GmailThreadOdpowiedz nadawcy ostatniej wiadomości w tym wątku, używając adresu replyTo.
reply(body, options)GmailThreadOdpowiedz nadawcy ostatniej wiadomości w tym wątku, używając adresu replyTo z opcjonalnymi argumentami.
replyAll(body)GmailThreadOdpowiedz nadawcy (korzystając z adresu replyTo) oraz wszystkim odbiorcom ostatniej wiadomości w tym wątku.
replyAll(body, options)GmailThreadOdpowiedz nadawcy (za pomocą adresu replyTo) oraz wszystkim odbiorcom ostatniej wiadomości w tym wątku, z opcjonalnymi argumentami.