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
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. |
GmailLabel | Etykieta utworzona przez użytkownika na koncie Gmail. |
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ą e-maila z opcjonalnymi argumentami. |
createLabel(name) | GmailLabel | Utwórz nową etykietę użytkownika o danej 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ą 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() | Integer | Pobiera liczbę nieprzeczytanych wątków w skrzynce odbiorczej. |
getMessageById(id) | GmailMessage | Pobiera 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() | Integer | Pobiera 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() | Integer | Pobiera 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() | Integer | Pobiera liczbę nieprzeczytanych wątków oznaczonych gwiazdką. |
getThreadById(id) | GmailThread | Pobiera 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) | GmailLabel | Pobiera etykietę o nazwie. |
getUserLabels() | GmailLabel[] | Pobiera listę etykiet utworzonych przez użytkowników. |
markMessageRead(message) | GmailApp | Oznacza wiadomość jako przeczytaną i wymusza jej odświeżenie. |
markMessageUnread(message) | GmailApp | Oznacza 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 wiadomości jako nieprzeczytane i wymuszają ich odświeżenie. |
markThreadImportant(thread) | GmailApp | Oznacza wątek jako ważny i wymusza odświeżenie wątku. |
markThreadRead(thread) | GmailApp | Oznacza 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 | Oznacza wątek jako nieprzeczytany i wymusza jego odświeżenie. |
markThreadsImportant(threads) | GmailApp | Oznacza te 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 te wątki jako nieistotne i wymusza ich odświeżenie. |
markThreadsUnread(threads) | GmailApp | Oznaczy te wątki jako nieprzeczytane i wymusi odświeżenie wątków. |
moveMessageToTrash(message) | GmailApp | Przeniesienie wiadomości do kosza i wymuszanie jej odświeżenia. |
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 wątku. |
moveThreadToTrash(thread) | GmailApp | Przenosi ten wątek do kosza i wymusza odświeżenie wątku. |
moveThreadsToArchive(threads) | GmailApp | Służy do przenoszenia tych wątków do archiwum i wymusza odświeżenie wątków. |
moveThreadsToInbox(threads) | GmailApp | Przenosi te wątki do skrzynki odbiorczej i wymusza odświeżenie wątków. |
moveThreadsToSpam(threads) | GmailApp | Powoduje przeniesienie tych wątków do spamu i wymusza odświeżenie wątków. |
moveThreadsToTrash(threads) | GmailApp | Przenosi te wątki do kosza i wymusza ich odświeżenie. |
refreshMessage(message) | GmailApp | Wczytuje ponownie wiadomość i powiązany z nią stan w Gmailu (jest to przydatne w przypadku zmiany etykiet, stanu odczytu itp.). |
refreshMessages(messages) | GmailApp | Wczytuje wiadomości i powiązany stan z Gmaila (jest to przydatne w przypadku zmiany etykiet, stanu odczytu itp.). |
refreshThread(thread) | GmailApp | Wczytuje wątek i powiązany stan z Gmaila (jest to przydatne w przypadku zmiany etykiet, stanu odczytu itp.). |
refreshThreads(threads) | GmailApp | Ponownie ł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) | 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 do wiadomości gwiazdkę i wymusza odświeżenie wiadomości. |
starMessages(messages) | GmailApp | Dodaje do tych wiadomości gwiazdki i wymusza odświeżenie wiadomości. |
unstarMessage(message) | GmailApp | Usunięcie gwiazdki z tej wiadomości i wymusza jej odświeżenie. |
unstarMessages(messages) | GmailApp | Usuwa te wiadomości i wymusza odświeżenie wiadomości. |
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 blobie. |
getContentType() | String | Pobiera typ zawartości bajtów w tym blobie. |
getDataAsString() | String | Pobiera dane tego obiektu blob jako ciąg tekstowy z kodowaniem UTF-8. |
getDataAsString(charset) | String | Pobiera dane tego obiektu blob w postaci ciągu znaków z określonym kodowaniem. |
getHash() | String | Pobiera identyfikator treści SHA1 tego załącznika. |
getName() | String | Pobiera nazwę tego obiektu blob. |
getSize() | Integer | Pobiera rozmiar tego załącznika. |
isGoogleType() | Boolean | Zwraca, czy ten obiekt blob jest plikiem Google Workspace (Arkusze, Dokumenty itp.). |
setBytes(data) | Blob | Ustawia dane przechowywane w tym blobie. |
setContentType(contentType) | Blob | Ustawia typ treści w bajtach w tym blobie. |
setContentTypeFromExtension() | Blob | Ustawia typ zawartości bajtów w tym blobie na podstawie rozszerzenia pliku. |
setDataFromString(string) | Blob | Ustawia dane tego obiektu blob z ciągu znaków z kodowaniem UTF-8. |
setDataFromString(string, charset) | Blob | Ustawia dane tego obiektu blob z ciągu znaków z określonym kodowaniem. |
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ść Gmail odpowiadającą tej wersji roboczej. |
getMessageId() | String | Zwraca identyfikator elementu GmailMessage reprezentującego wersję roboczą. |
send() | GmailMessage | Wysyła tę wersję roboczą e-maila. |
update(recipient, subject, body) | GmailDraft | Zastępuje zawartość tej wersji roboczej wiadomości. |
update(recipient, subject, body, options) | GmailDraft | Zastępuje zawartość tej wersji roboczej wiadomości, podając opcjonalne argumenty. |
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 odświeżenie wątków. |
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ątków. |
GmailMessage
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
createDraftReply(body) | GmailDraft | Tworzy wersję roboczą wiadomości, która odpowiada na wiadomość nadawcy, używając adresu zwrotnego. |
createDraftReply(body, options) | GmailDraft | Tworzy wersję roboczą wiadomości wysyłanej do nadawcy tej wiadomości z użyciem adresu zwrotnego z opcjonalnymi argumentami. |
createDraftReplyAll(body) | GmailDraft | Tworzy wersję roboczą wiadomości skierowanej do nadawcy, używając adresu zwrotnego i wszystkich adresatów tej wiadomości. |
createDraftReplyAll(body, options) | GmailDraft | Tworzy 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) | GmailMessage | Przekazuje tę wiadomość do nowych odbiorców. |
forward(recipient, options) | GmailMessage | Powoduje 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() | String | Pobiera odbiorców UDW dla tej wiadomości. |
getBody() | String | Pobiera treść HTML treści wiadomości. |
getCc() | String | Pobiera adresatów wiadomości rozdzielonych przecinkami (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 po nazwie. |
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 (zazwyczaj nadawcy). |
getSubject() | String | Pobiera temat tej wiadomości. |
getThread() | GmailThread | Pobiera wątek zawierający tę wiadomość. |
getTo() | String | Pobiera odbiorców wiadomości rozdzielonych przecinkami. |
isDraft() | Boolean | Określa, czy wiadomość jest wersją roboczą. |
isInChats() | Boolean | Sprawdza, czy ta wiadomość jest czatem. |
isInInbox() | Boolean | Sprawdza, czy ta wiadomość jest w skrzynce odbiorczej. |
isInPriorityInbox() | Boolean | Zwraca wartość true , jeśli ta wiadomość znajduje się w folderze Priorytety. W przeciwnym razie zwraca false . |
isInTrash() | Boolean | Sprawdza, czy wiadomość jest w koszu. |
isStarred() | Boolean | Określa, czy wiadomość jest oznaczona gwiazdką. |
isUnread() | Boolean | Określa, czy wiadomość jest nieprzeczytana. |
markRead() | GmailMessage | Oznacza wiadomość jako przeczytaną. |
markUnread() | GmailMessage | Oznacza wiadomość jako nieprzeczytaną. |
moveToTrash() | GmailMessage | Powoduje przeniesienie wiadomości do kosza. |
refresh() | GmailMessage | Wczytuje ponownie tę wiadomość i powiązany stan z Gmaila (na wypadek, gdyby etykiety, stan odczytu itp. uległy zmianie). |
reply(body) | GmailMessage | Odpowiedzi do nadawcy tej wiadomości z wykorzystaniem adresu zwrotnego. |
reply(body, options) | GmailMessage | Odpowiedzi do nadawcy tej wiadomości z adresem zwrotnym i opcjonalnymi argumentami. |
replyAll(body) | GmailMessage | Odpowiedzi do nadawcy przy użyciu adresu zwrotnego i wszystkich odbiorców wiadomości. |
replyAll(body, options) | GmailMessage | Odpowiedzi dla nadawcy tej wiadomości z wykorzystaniem adresu zwrotnego i wszystkich adresatów oraz opcjonalnych argumentów. |
star() | GmailMessage | Oznaczy wiadomość gwiazdką. |
unstar() | GmailMessage | Oznaczenie wiadomości gwiazdką zostanie usunięte. |
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ącej nadawcy ostatniej wiadomości w tym wątku, używając adresu zwrotnego. |
createDraftReply(body, options) | GmailDraft | Tworzy 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) | GmailDraft | Tworzy 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) | GmailDraft | Tworzy 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() | String | Pobiera temat pierwszej wiadomości w wątku. |
getId() | String | Pobiera identyfikator tego wątku. |
getLabels() | GmailLabel[] | Zwraca etykiety utworzone przez użytkowników w tym wątku. |
getLastMessageDate() | Date | Pobiera datę ostatniej wiadomości w tym wątku. |
getMessageCount() | Integer | Zwraca liczbę wiadomości w wątku. |
getMessages() | GmailMessage[] | Pobiera wiadomości z tego 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 | Zwraca informację, czy wątek jest oznaczony jako ważny. |
isInChats() | Boolean | Wskazuje, czy wątek jest oznaczony jako czat. |
isInInbox() | Boolean | Zwraca, czy wątek jest w Odebranych. |
isInPriorityInbox() | Boolean | Zwraca „TRUE”, jeśli ten wątek znajduje się w priorytetowej skrzynce odbiorczej. W przeciwnym wypadku zwraca „FALSE”. |
isInSpam() | Boolean | Wskazuje, czy wątek jest oznaczony jako spam. |
isInTrash() | Boolean | Zwraca, czy wątek jest w koszu. |
isUnread() | Boolean | Wskazuje, 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 | Przeniesienie tego wątku do archiwum. |
moveToInbox() | GmailThread | Przenosi ten wątek do skrzynki odbiorczej. |
moveToSpam() | GmailThread | Powoduje przeniesienie tego wątku do spamu. |
moveToTrash() | GmailThread | Powoduje przeniesienie tego wątku do kosza. |
refresh() | GmailThread | Wczytuje ponownie ten wątek i powiązany stan z Gmaila (jest to przydatne w przypadku zmiany etykiet, stanu odczytu itp.). |
removeLabel(label) | GmailThread | Usunięcie tej etykiety z wątku. |
reply(body) | GmailThread | Odpowiedz nadawcy nadawcy ostatniej wiadomości w tym wątku, podając adres responseTo. |
reply(body, options) | GmailThread | Odpowiedz nadawcy ostatniej wiadomości w tym wątku, podając adres responseTo i opcjonalnie argumenty. |
replyAll(body) | GmailThread | Odpowiedz nadawcy (korzystając z adresu responseTo) i wszystkim odbiorcom ostatniej wiadomości w tym wątku. |
replyAll(body, options) | GmailThread | Odpowiedz nadawcy (za pomocą adresu replyTo ) i wszystkim odbiorcom ostatniej wiadomości w tym wątku, podając opcjonalne argumenty. |