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
Nazwa | Krótki opis |
---|---|
GmailApp | Zapewnia dostęp do wątków, wiadomości i etykiet Gmaila. |
GmailAttachment | Załącznik z Gmaila. |
GmailDraft | Wersja robocza wiadomości utworzona przez użytkownika na koncie Gmail użytkownika. |
GmailLabel | Etykieta utworzona przez użytkownika na koncie Gmail użytkownika. |
GmailMessage | Wiadomość na koncie Gmail użytkownika. |
GmailThread | Wątek na koncie Gmail użytkownika. |
GmailApp
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
createDraft(recipient, subject, body) | GmailDraft | Tworzy wersję roboczą e-maila. |
createDraft(recipient, subject, body, options) | GmailDraft | Tworzy wersję roboczą wiadomości e-mail z opcjonalnymi argumentami. |
createLabel(name) | GmailLabel | Utwórz nową etykietę użytkownika o podanej nazwie. |
deleteLabel(label) | GmailApp | Usuwa określoną etykietę. |
getAliases() | String[] | Pobiera listę e-maili skonfigurowanych jako aliasy tego konta w Gmailu. |
getDraft(draftId) | GmailDraft | Pobierz 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() | Integer | Pobiera liczbę nieprzeczytanych wątków w skrzynce odbiorczej. |
getMessageById(id) | GmailMessage | Pobiera 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() | Integer | Pobiera 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() | Integer | Pobiera 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() | Integer | Pobiera liczbę nieprzeczytanych wątków oznaczonych gwiazdką. |
getThreadById(id) | GmailThread | Pobiera 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) | GmailLabel | Pobiera etykietę o jej nazwie. |
getUserLabels() | GmailLabel[] | Pobiera listę etykiet utworzonych przez użytkownika. |
markMessageRead(message) | GmailApp | Oznacza tę wiadomość jako przeczytaną i wymusza jej odświeżenie. |
markMessageUnread(message) | GmailApp | Oznacza tę wiadomość jako nieprzeczytaną i wymusza jej odświeżenie. |
markMessagesRead(messages) | GmailApp | Oznacza te wiadomości jako przeczytane i wymusza ich odświeżenie. |
markMessagesUnread(messages) | GmailApp | Oznacza te wiadomości jako nieprzeczytane i wymusza ich odświeżenie. |
markThreadImportant(thread) | GmailApp | Oznacza ten wątek jako ważny i wymusza jego odświeżenie. |
markThreadRead(thread) | GmailApp | Oznacza ten wątek jako przeczytany i wymusza jego odświeżenie. |
markThreadUnimportant(thread) | GmailApp | Oznacza wątek jako nieważny i wymusza jego odświeżenie. |
markThreadUnread(thread) | GmailApp | Oznaczy ten wątek jako nieprzeczytany i wymusza jego odświeżenie. |
markThreadsImportant(threads) | GmailApp | Oznacza wątki jako ważne i wymusza ich odświeżenie. |
markThreadsRead(threads) | GmailApp | Oznacza te wątki jako przeczytane i wymusza ich odświeżenie. |
markThreadsUnimportant(threads) | GmailApp | Oznacza wątki jako nieważne i wymusza ich odświeżenie. |
markThreadsUnread(threads) | GmailApp | Oznacza takie wątki jako nieprzeczytane i wymusza ich odświeżenie. |
moveMessageToTrash(message) | GmailApp | Przenosi wiadomość do kosza i wymusza jej odświeżenie. |
moveMessagesToTrash(messages) | GmailApp | Przenosi określone wiadomości do kosza i wymusza ich odświeżenie. |
moveThreadToArchive(thread) | GmailApp | Przenosi ten wątek do archiwum i wymusza odświeżenie wątku. |
moveThreadToInbox(thread) | GmailApp | Przenosi ten wątek do skrzynki odbiorczej i wymusza odświeżenie wątku. |
moveThreadToSpam(thread) | GmailApp | Przenosi ten wątek do spamu i wymusza odświeżenie. |
moveThreadToTrash(thread) | GmailApp | Przenosi ten wątek do kosza i wymusza jego odświeżenie. |
moveThreadsToArchive(threads) | GmailApp | Przenosi te wątki do archiwum i wymusza ich odświeżenie. |
moveThreadsToInbox(threads) | GmailApp | Przenosi te wątki do skrzynki odbiorczej i wymusza ich odświeżenie. |
moveThreadsToSpam(threads) | GmailApp | Przenosi te wątki do spamu i wymusza odświeżanie. |
moveThreadsToTrash(threads) | GmailApp | Przenosi te wątki do kosza i wymusza ich odświeżenie. |
refreshMessage(message) | GmailApp | Wczytuje ponownie wiadomość i powiązany stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.). |
refreshMessages(messages) | GmailApp | Wczytuje ponownie wiadomości i powiązany stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.). |
refreshThread(thread) | GmailApp | Wczytuje ponownie wątek i powiązany stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.). |
refreshThreads(threads) | GmailApp | Wczytuje 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) | GmailApp | Wysyła e-maila. |
sendEmail(recipient, subject, body, options) | GmailApp | Wysyła e-maila z opcjonalnymi argumentami. |
setCurrentMessageAccessToken(accessToken) | void | Ustawia 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) | GmailApp | Dodaje gwiazdkę do wiadomości i wymusza jej odświeżenie. |
starMessages(messages) | GmailApp | Powoduje dodanie gwiazdek do wiadomości i wymusza ich odświeżenie. |
unstarMessage(message) | GmailApp | Usuwa gwiazdkę z wiadomości i wymusza jej odświeżenie. |
unstarMessages(messages) | GmailApp | Usuwa gwiazdki z tych wiadomości i wymusza ich odświeżenie. |
GmailAttachment
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
copyBlob() | Blob | Zwraca kopię tego obiektu blob. |
getAs(contentType) | Blob | Zwraca 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() | String | Pobiera typ treści bajtów tego obiektu blob. |
getDataAsString() | String | Pobiera dane tego obiektu blob jako ciągu znaków z kodowaniem UTF-8. |
getDataAsString(charset) | String | Pobiera dane tego obiektu blob jako ciąg znaków o określonym kodowaniu. |
getHash() | String | Pobiera hasz treści SHA1 dla tego załącznika. |
getName() | String | Pobiera nazwę tego obiektu blob. |
getSize() | Integer | Pobiera rozmiar tego załącznika. |
isGoogleType() | Boolean | Zwraca, czy dany obiekt blob jest plikiem Google Workspace (Arkuszy, Dokumentów itp.). |
setBytes(data) | Blob | Ustawia dane przechowywane w tym obiekcie blob. |
setContentType(contentType) | Blob | Ustawia typ treści bajtów w tym obiekcie blob. |
setContentTypeFromExtension() | Blob | Ustawia typ treści bajtów w tym obiekcie blobowym na podstawie rozszerzenia pliku. |
setDataFromString(string) | Blob | Ustawia dane tego obiektu blob na podstawie ciągu znaków z kodowaniem UTF-8. |
setDataFromString(string, charset) | Blob | Ustawia dane tego obiektu blob z ciągu znaków o określonym kodowaniu. |
setName(name) | Blob | Ustawia nazwę tego obiektu blob. |
GmailDraft
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
deleteDraft() | void | Usuwa tę wersję roboczą wiadomości. |
getId() | String | Pobiera identyfikator tej wersji roboczej wiadomości. |
getMessage() | GmailMessage | Zwraca wiadomość GmailMessage reprezentującą tę wersję roboczą. |
getMessageId() | String | Zwraca identyfikator elementu GmailMessage reprezentującego tę wersję roboczą. |
send() | GmailMessage | Wysyła wersję roboczą e-maila. |
update(recipient, subject, body) | GmailDraft | Zastępuje treść tej wersji roboczej wiadomości. |
update(recipient, subject, body, options) | GmailDraft | Zastępuje treść tej wersji roboczej wiadomości przy użyciu opcjonalnych argumentów. |
GmailLabel
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addToThread(thread) | GmailLabel | Dodaje tę etykietę do danego wątku i wymusza odświeżenie wątku (GmailThread.refresh() ). |
addToThreads(threads) | GmailLabel | Dodaje tę etykietę do podanych wątków i wymusza ich odświeżenie. |
deleteLabel() | void | Usuwa tę etykietę. |
getName() | String | Pobiera nazwę tej etykiety. |
getThreads() | GmailThread[] | Pobiera wątki oznaczone tą etykietą. |
getThreads(start, max) | GmailThread[] | Pobiera zakres wątków oznaczonych tą etykietą. |
getUnreadCount() | Integer | Pobiera liczbę nieprzeczytanych wątków oznaczonych tą etykietą. |
removeFromThread(thread) | GmailLabel | Usuwa tę etykietę z danego wątku i wymusza odświeżenie wątku. |
removeFromThreads(threads) | GmailLabel | Usuwa tę etykietę z podanych wątków i wymusza odświeżenie wątku. |
GmailMessage
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
createDraftReply(body) | GmailDraft | Tworzy wersję roboczą wiadomości, odpowiadając nadawcy na tę wiadomość przy użyciu adresu zwrotnego. |
createDraftReply(body, options) | GmailDraft | Tworzy wersję roboczą wiadomości, która odpowiada nadawcy tej wiadomości, używając adresu zwrotnego z opcjonalnymi argumentami. |
createDraftReplyAll(body) | GmailDraft | Tworzy wersję roboczą wiadomości, która odpowiada nadawcy z użyciem adresu zwrotnego i wszystkich odbiorców tej wiadomości. |
createDraftReplyAll(body, options) | GmailDraft | Tworzy 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) | GmailMessage | Przekazuje tę wiadomość do nowych odbiorców. |
forward(recipient, options) | GmailMessage | Przekazuje 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() | String | Pobiera adresatów, którzy zostali dodani do wiadomości (UDW). |
getBody() | String | Pobiera treść HTML tej wiadomości. |
getCc() | String | Pobiera adresatów rozdzielonych przecinkami, których kopia została utworzona w polu DW tej wiadomości. |
getDate() | Date | Pobiera datę i godzinę tej wiadomości. |
getFrom() | String | Pobiera nadawcę tej wiadomości. |
getHeader(name) | String | Pobiera wartość nagłówka RFC 2822 z nazwą nagłówka. |
getId() | String | Pobiera identyfikator tej wiadomości. |
getPlainBody() | String | Pobiera treść tej wiadomości bez formatowania HTML. |
getRawContent() | String | Pobiera nieprzetworzoną treść tej wiadomości. |
getReplyTo() | String | Pobiera adres zwrotny tej wiadomości (zwykle nadawcy). |
getSubject() | String | Pobiera temat tej wiadomości. |
getThread() | GmailThread | Pobiera wątek zawierający tę wiadomość. |
getTo() | String | Pobiera adresatów tej wiadomości rozdzielonych przecinkami. |
isDraft() | Boolean | Wskazuje, czy wiadomość jest wersją roboczą. |
isInChats() | Boolean | Sprawdza, czy wiadomość jest czatem. |
isInInbox() | Boolean | Wskazuje, czy wiadomość znajduje się w skrzynce odbiorczej. |
isInPriorityInbox() | Boolean | Zwraca wartość true , jeśli ta wiadomość znajduje się w skrzynce odbiorczej Priorytety. W przeciwnym razie zwraca wartość false . |
isInTrash() | Boolean | Sprawdza, czy wiadomość znajduje się w koszu. |
isStarred() | Boolean | Wskazuje, czy wiadomość jest oznaczona gwiazdką. |
isUnread() | Boolean | Wskazuje, czy wiadomość jest nieprzeczytana. |
markRead() | GmailMessage | Oznacza wiadomość jako przeczytaną. |
markUnread() | GmailMessage | Oznacza wiadomość jako nieprzeczytaną. |
moveToTrash() | GmailMessage | Przenosi wiadomość do kosza. |
refresh() | GmailMessage | Wczytuje ponownie tę wiadomość i powiązany stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.). |
reply(body) | GmailMessage | Odpowiada nadawcy tej wiadomości przy użyciu adresu zwrotnego. |
reply(body, options) | GmailMessage | Odpowiada nadawcy tej wiadomości przy użyciu adresu zwrotnego z opcjonalnymi argumentami. |
replyAll(body) | GmailMessage | Odpowiada nadawcy, używając adresu zwrotnego i wszystkich odbiorców tej wiadomości. |
replyAll(body, options) | GmailMessage | Odpowiada nadawcy tej wiadomości z użyciem adresu zwrotnego i wszystkich odbiorców z opcjonalnymi argumentami. |
star() | GmailMessage | oznacza wiadomość gwiazdką. |
unstar() | GmailMessage | Usuwa gwiazdkę z wiadomości. |
GmailThread
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addLabel(label) | GmailThread | Dodaje tę etykietę do wątku. |
createDraftReply(body) | GmailDraft | Tworzy wersję roboczą wiadomości, odpowiadając nadawcy ostatniej wiadomości w tym wątku przy użyciu adresu zwrotnego. |
createDraftReply(body, options) | GmailDraft | Tworzy 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) | GmailDraft | Tworzy 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) | GmailDraft | Tworzy 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() | String | Pobiera temat pierwszej wiadomości w wątku. |
getId() | String | Pobiera identyfikator tego wątku. |
getLabels() | GmailLabel[] | Zwraca etykiety utworzone przez użytkownika w tym wątku. |
getLastMessageDate() | Date | Pobiera datę najnowszej wiadomości w tym wątku. |
getMessageCount() | Integer | Zwraca liczbę wiadomości w wątku. |
getMessages() | GmailMessage[] | Pobiera wiadomości w tym wątku. |
getPermalink() | String | Pobiera link bezpośredni do tego wątku. |
hasStarredMessages() | Boolean | Wskazuje, czy wątek zawiera wiadomości oznaczone gwiazdką. |
isImportant() | Boolean | Wskazuje, czy wątek jest oznaczony jako ważny. |
isInChats() | Boolean | Wskazuje, czy wątek jest oznaczony etykietą czatu. |
isInInbox() | Boolean | Wskazuje, czy wątek znajduje się w skrzynce odbiorczej. |
isInPriorityInbox() | Boolean | Zwraca wartość „true” (prawda), jeśli wątek znajduje się w skrzynce odbiorczej Priorytetów. W przeciwnym razie zwraca wartość „false” (fałsz). |
isInSpam() | Boolean | Wskazuje, czy wątek jest oznaczony jako spam. |
isInTrash() | Boolean | Wskazuje, czy wątek znajduje się w koszu. |
isUnread() | Boolean | Zwraca, czy wątek zawiera nieprzeczytane wiadomości. |
markImportant() | GmailThread | Oznacza ten wątek jako ważny. |
markRead() | GmailThread | Oznacza ten wątek jako przeczytany. |
markUnimportant() | GmailThread | Oznacza ten wątek jako nieważny. |
markUnread() | GmailThread | Oznacza ten wątek jako nieprzeczytany. |
moveToArchive() | GmailThread | Przenosi ten wątek do archiwum. |
moveToInbox() | GmailThread | Przenosi ten wątek do skrzynki odbiorczej. |
moveToSpam() | GmailThread | Przeniesienie tego wątku do spamu. |
moveToTrash() | GmailThread | Przenosi ten wątek do kosza. |
refresh() | GmailThread | Ponownie wczytuje ten wątek i powiązany stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.). |
removeLabel(label) | GmailThread | Usuwa tę etykietę z wątku. |
reply(body) | GmailThread | Odpowiedz nadawcy ostatniej wiadomości w tym wątku, korzystając z adresu „ReplyTo”. |
reply(body, options) | GmailThread | Odpowiedz nadawcy ostatniej wiadomości w tym wątku, korzystając z adresu zwrotnego z opcjonalnymi argumentami. |
replyAll(body) | GmailThread | Odpowiedz nadawcy (przy użyciu adresu zwrotnego) i wszystkich odbiorców ostatniej wiadomości w tym wątku. |
replyAll(body, options) | GmailThread | Odpowiedz nadawcy (używając adresu replyTo ) i wszystkich odbiorców ostatniej wiadomości w tym wątku, używając opcjonalnych argumentów. |