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 zadań związanych z zarządzaniem kontem Gmail. Zobacz też Usługę poczty, prostszą usługę, 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 w Gmailu.
GmailAttachmentZałącznik z Gmaila.
GmailDraftWersja robocza wiadomości utworzona 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 argumentami opcjonalnymi.
createLabel(name)GmailLabelUtwórz nową etykietę użytkownika o podanej nazwie.
deleteLabel(label)GmailAppUsuwa określoną etykietę.
getAliases()String[]Pobiera listę adresów e-mail skonfigurowanych jako aliasy na tym koncie 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 usłudze Inbox 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[]Pobiera wszystkie wiadomości w określonym wątku.
getMessagesForThreads(threads)GmailMessage[][]Pobiera wszystkie wiadomości z określonych wątków.
getPriorityInboxThreads()GmailThread[]Pobiera wszystkie wątki ze skrzynki priorytetowej niezależnie od etykiet.
getPriorityInboxThreads(start, max)GmailThread[]Pobiera zakres wątków ze skrzynki odbiorczej Priorytety 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 niezależnie od etykiet.
getSpamUnreadCount()IntegerPobiera liczbę nieprzeczytanych wątków, które są spamem.
getStarredThreads()GmailThread[]Pobiera wszystkie wątki z gwiazdką niezależnie od etykiet.
getStarredThreads(start, max)GmailThread[]Pobiera zakres wątków oznaczonych gwiazdką niezależnie od etykiet.
getStarredUnreadCount()IntegerZwraca 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 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 ten wątek jako nieważny i wymusza 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 nieważ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 wątek do skrzynki odbiorczej i wymusza jego odświeżenie.
moveThreadToSpam(thread)GmailAppPrzenosi wątek do 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)GmailAppPonownie wczytuje wiadomość i powiązany z nią stan z Gmaila (przydatne, jeśli zmieniły się etykiety, stan odczytu itp.).
refreshMessages(messages)GmailAppPonownie wczytuje wiadomości i powiązany z nimi stan z Gmaila (przydatne, jeśli zmieniły się etykiety, stan odczytania itp.).
refreshThread(thread)GmailAppPonownie wczytuje wątek i powiązany z nim stan z Gmaila (przydatne, jeśli zmieniły się etykiety, stan odczytu itp.).
refreshThreads(threads)GmailAppPonownie wczytuje wątki i powiązany z nimi stan z Gmaila (przydatne, gdy zmieniły się etykiety, stan odczytu itp.).
search(query)GmailThread[]Wyszukaj w Gmailu za pomocą podanego zapytania.
search(query, start, max)GmailThread[]Wyszukaj w Gmailu za pomocą podanego 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)GmailAppOznacza wiadomość gwiazdką i wymusza jej odświeżenie.
starMessages(messages)GmailAppOznacza te wiadomości gwiazdkami i wymusza ich odświeżenie.
unstarMessage(message)GmailAppUsuwa gwiazdkę z tej 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 w tym obiekcie jako obiekt blob przekonwertowany na określony typ treści.
getBytes()Byte[]Pobiera dane przechowywane w tym obiekcie blob.
getContentType()StringPobiera typ zawartości bajtów w tym obiekcie blob.
getDataAsString()StringPobiera dane tego obiektu blob jako ciąg znaków z kodowaniem UTF-8.
getDataAsString(charset)StringPobiera dane tego obiektu blob jako ciąg znaków z określonym kodowaniem.
getHash()StringPobiera identyfikator SHA1 treści tego załącznika.
getName()StringPobiera nazwę tego obiektu blob.
getSize()IntegerPobiera rozmiar tego załącznika.
isGoogleType()BooleanZwraca informację, czy ten obiekt blob jest plikiem Google Workspace (Arkuszami, Dokumentami 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 blob na podstawie rozszerzenia pliku.
setDataFromString(string)BlobUstawia dane tego obiektu blob na podstawie ciągu znaków zakodowanego w UTF-8.
setDataFromString(string, charset)BlobUstawia dane tego obiektu blob na podstawie ciągu znaków z określonym kodowaniem.
setName(name)BlobUstawia nazwę tego obiektu blob.

GmailDraft

Metody

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

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 podanych wątków i wymusza ich odświeżenie.
deleteLabel()voidUsuwa tę etykietę.
getId()StringPobiera identyfikator tej etykiety.
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 podanych wątków i wymusza ich odświeżenie.

GmailMessage

Metody

MetodaZwracany typKrótki opis
createDraftReply(body)GmailDraftTworzy wersję roboczą wiadomości z odpowiedzią do nadawcy tej wiadomości, używając adresu zwrotnego.
createDraftReply(body, options)GmailDraftTworzy wersję roboczą wiadomości z odpowiedzią do nadawcy tej wiadomości, używając adresu do odpowiedzi, z argumentami opcjonalnymi.
createDraftReplyAll(body)GmailDraftTworzy wersję roboczą wiadomości z odpowiedzią do nadawcy, używając adresu do odpowiedzi i wszystkich odbiorców tej wiadomości.
createDraftReplyAll(body, options)GmailDraftTworzy wersję roboczą wiadomości z odpowiedzią do nadawcy tej wiadomości, używając adresu do odpowiedzi i wszystkich odbiorców, z argumentami opcjonalnymi.
forward(recipient)GmailMessageprzekazuje tę wiadomość do nowych odbiorców.
forward(recipient, options)GmailMessagePrzekazuje tę wiadomość do nowych odbiorców z argumentami opcjonalnymi.
getAttachments()GmailAttachment[]Pobiera wszystkie załączniki do tej wiadomości.
getAttachments(options)GmailAttachment[]Pobiera wszystkie załączniki do tej wiadomości.
getBcc()StringPobiera adresy odbiorców, którzy otrzymali tę wiadomość w polu UDW, rozdzielone przecinkami.
getBody()StringPobiera zawartość HTML treści tej wiadomości.
getCc()StringPobiera adresy odbiorców w polu DW tej wiadomości rozdzielone przecinkami.
getDate()DatePobiera datę i godzinę tej wiadomości.
getFrom()StringPobiera nadawcę tej wiadomości.
getHeader(name)StringPobiera wartość nagłówka RFC 2822 na podstawie nazwy nagłówka.
getId()StringPobiera identyfikator tej wiadomości.
getPlainBody()StringPobiera treść 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()BooleanOkreśla, czy ta wiadomość jest wersją roboczą.
isInChats()BooleanSprawdza, czy ta wiadomość jest czatem.
isInInbox()BooleanSprawdza, czy ta wiadomość znajduje się w skrzynce odbiorczej.
isInPriorityInbox()BooleanZwraca true, jeśli ta wiadomość znajduje się w skrzynce priorytetowej, a w przeciwnym razie zwraca false.
isInTrash()BooleanOkreśla, czy wiadomość znajduje się w koszu.
isStarred()BooleanOkreśla, czy wiadomość jest oznaczona gwiazdką.
isUnread()BooleanSprawdza, czy wiadomość jest nieprzeczytana.
markRead()GmailMessageOznacza wiadomość jako przeczytaną.
markUnread()GmailMessageOznacza wiadomość jako nieprzeczytaną.
moveToTrash()GmailMessagePrzenosi wiadomość do kosza.
refresh()GmailMessagePonownie wczytuje tę wiadomość i powiązany z nią stan z Gmaila (przydatne, jeśli zmieniły się etykiety, stan odczytu itp.).
reply(body)GmailMessageOdpowiedzi do nadawcy tej wiadomości są wysyłane na adres odpowiedzi.
reply(body, options)GmailMessageOdpowiada nadawcy tej wiadomości, używając adresu do odpowiedzi, z opcjonalnymi argumentami.
replyAll(body)GmailMessageOdpowiedzi do nadawcy przy użyciu adresu do odpowiedzi i wszystkich odbiorców tej wiadomości.
replyAll(body, options)GmailMessageOdpowiada nadawcy tej wiadomości, używając adresu do odpowiedzi i wszystkich odbiorców, z argumentami opcjonalnymi.
star()GmailMessageoznacza wiadomość gwiazdką,
unstar()GmailMessageUsuwa oznaczenie wiadomości gwiazdką.

GmailThread

Metody

MetodaZwracany typKrótki opis
addLabel(label)GmailThreadDodaje tę etykietę do wątku.
createDraftReply(body)GmailDraftTworzy roboczą wiadomość z odpowiedzią do nadawcy ostatniej wiadomości w tym wątku, używając adresu do odpowiedzi.
createDraftReply(body, options)GmailDraftTworzy wersję roboczą wiadomości z odpowiedzią do nadawcy ostatniej wiadomości w tym wątku, używając adresu do odpowiedzi, z argumentami opcjonalnymi.
createDraftReplyAll(body)GmailDraftTworzy wersję roboczą wiadomości z odpowiedzią do nadawcy ostatniej wiadomości w tym wątku, używając adresu odpowiedzi i wszystkich odbiorców tej wiadomości.
createDraftReplyAll(body, options)GmailDraftTworzy wersję roboczą wiadomości z odpowiedzią do nadawcy ostatniej wiadomości w tym wątku, używając adresu do odpowiedzi i wszystkich odbiorców, z argumentami opcjonalnymi.
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 tym wątku.
getMessageCount()IntegerZwraca liczbę wiadomości w wątku.
getMessages()GmailMessage[]Pobiera wiadomości w tym wątku.
getPermalink()StringPobiera trwały link 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 wątek znajduje się w skrzynce odbiorczej priorytetowej, w przeciwnym razie zwraca wartość „fałsz”.
isInSpam()BooleanZwraca informację, czy wątek jest oznaczony jako spam.
isInTrash()BooleanZwraca informację o tym, czy wątek znajduje się w koszu.
isUnread()BooleanZwraca informację, 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 wątek do archiwum.
moveToInbox()GmailThreadPrzenosi wątek do skrzynki odbiorczej.
moveToSpam()GmailThreadPrzenosi ten wątek do spamu.
moveToTrash()GmailThreadPrzenosi wątek do kosza.
refresh()GmailThreadPonownie wczytuje ten wątek i powiązany stan z Gmaila (przydatne, jeśli zmieniły się etykiety, stan odczytu 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 (używając adresu replyTo) i wszystkim odbiorcom ostatniej wiadomości w tym wątku.
replyAll(body, options)GmailThreadOdpowiedz nadawcy (używając adresu replyTo) i wszystkim odbiorcom ostatniej wiadomości w tym wątku, z argumentami opcjonalnymi.