Zapewniają dostęp do wątków, wiadomości i etykiet Gmaila.
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ę adresów e-mail 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 z Odebranych niezależnie od etykiet. |
getInboxThreads(start, max) | GmailThread[] | Pobiera zakres wątków z Odebranych niezależnie od etykiet. |
getInboxUnreadCount() | Integer | Pobiera liczbę nieprzeczytanych wątków w skrzynce odbiorczej. |
getMessageById(id) | GmailMessage | Pobiera 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 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 wiadomość jako przeczytaną i wymusza jej odświeżenie. |
markMessageUnread(message) | GmailApp | Oznacza wiadomość jako nieprzeczytaną i wymusza odświeżenie jej. |
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 wątek jako ważny i wymusza jego odświeżenie. |
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 wątki jako ważne i wymusza ich odświeżenie. |
markThreadsRead(threads) | GmailApp | Oznacza 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 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 jego odświeżenie. |
moveThreadToInbox(thread) | GmailApp | Przenosi ten wątek do skrzynki odbiorczej i wymusza jego odświeżenie. |
moveThreadToSpam(thread) | GmailApp | Przenosi ten wątek do spamu i wymusza jego 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 ich odświeżenie. |
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ązane z nimi stany 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 stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.). |
search(query) | GmailThread[] | Wyszukaj w Gmailu dane zapytanie. |
search(query, start, max) | GmailThread[] | Wyszukaj w Gmailu dane zapytanie. |
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 odświeżenie wiadomości. |
starMessages(messages) | GmailApp | Powoduje dodanie gwiazdek do takich wiadomości i wymusza ich odświeżenie. |
unstarMessage(message) | GmailApp | Usuwa gwiazdkę z wiadomości i wymusza odświeżenie wiadomości. |
unstarMessages(messages) | GmailApp | Usuwa gwiazdki z tych wiadomości i wymusza ich odświeżenie. |
Szczegółowa dokumentacja
createDraft(recipient, subject, body)
Tworzy wersję roboczą e-maila. Rozmiar e-maila (wraz z nagłówkami) jest ograniczony.
// The code below creates a draft email with the current date and time. var now = new Date(); GmailApp.createDraft("mike@example.com", "current time", "The time is: " + now.toString());
Parametry
Nazwa | Typ | Opis |
---|---|---|
recipient | String | lista adresów e-mail oddzielonych przecinkami |
subject | String | temat e-maila |
body | String | treść e-maila |
Powrót
GmailDraft
– nowo utworzona wersja robocza Gmaila
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
createDraft(recipient, subject, body, options)
Tworzy wersję roboczą e-maila z opcjonalnymi argumentami. Może zawierać zwykły tekst lub treść HTML. Rozmiar e-maila (z nagłówkami, ale bez załączników) jest ograniczony.
// Create a draft email with a file from Google Drive attached as a PDF. var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz'); GmailApp.createDraft('mike@example.com', 'Attachment example', 'Please see attached file.', { attachments: [file.getAs(MimeType.PDF)], name: 'Automatic Emailer Script' });
Parametry
Nazwa | Typ | Opis |
---|---|---|
recipient | String | adresy odbiorców |
subject | String | wiersz tematu |
body | String | treść e-maila |
options | Object | obiekt JavaScript określający parametry zaawansowane, wymienione poniżej. |
Parametry zaawansowane
Nazwa | Typ | Opis |
---|---|---|
attachments | BlobSource[] | tablicę plików do wysłania w e-mailu. |
bcc | String | rozdzielana przecinkami lista adresów e-mail do przekazania w polu UDW |
cc | String | rozdzielana przecinkami lista adresów e-mail, na które mają zostać wysłane wiadomości w polu DW |
from | String | Adres, z którego należy wysłać e-maila. Musi on być jedną z wartości zwróconych przez getAliases() . |
htmlBody | String | Jeśli zasada jest skonfigurowana, urządzenia z możliwością renderowania kodu HTML będą korzystać z niego zamiast wymaganego argumentu treści. Możesz dodać opcjonalne pole inlineImages w treści HTML, jeśli masz w e-mailu obrazy w treści. |
inlineImages | Object | obiekt JavaScript zawierający mapowanie z klucza obrazu (String ) na dane obrazu (BlobSource ); przyjmuje się, że używany jest parametr htmlBody i zawiera odwołania do tych obrazów w formacie <img src="cid:imageKey" /> |
name | String | nazwa nadawcy e-maila (domyślnie: nazwa użytkownika), |
replyTo | String | adres e-mail, który ma być używany jako domyślny adres zwrotny (domyślnie: adres e-mail użytkownika) |
Powrót
GmailDraft
– nowo utworzona wersja robocza Gmaila
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
createLabel(name)
Utwórz nową etykietę użytkownika o danej nazwie.
// Creates the label @FOO and logs label: FOO Logger.log("label: " + GmailApp.createLabel("FOO"));
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa nowej etykiety |
Powrót
GmailLabel
– nowo utworzona etykieta,
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
deleteLabel(label)
Usuwa określoną etykietę.
// Have to get the label by name first var label = GmailApp.getUserLabelByName("FOO"); GmailApp.deleteLabel(label);
Parametry
Nazwa | Typ | Opis |
---|---|---|
label | GmailLabel | etykietę do usunięcia |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
getAliases()
Pobiera listę adresów e-mail skonfigurowanych jako aliasy tego konta w Gmailu.
Wiadomość możesz wysłać z dowolnego z tych aliasów, używając opcjonalnego argumentu „od”.
// Log the aliases for this Gmail account and send an email as the first one. var me = Session.getActiveUser().getEmail(); var aliases = GmailApp.getAliases(); Logger.log(aliases); if (aliases.length > 0) { GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {'from': aliases[0]}); } else { GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.'); }
Powrót
String[]
– tablica aliasów dla tego konta.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
getDraft(draftId)
Pobierz wersję roboczą e-maila według identyfikatora.
Używaj tej funkcji w połączeniu z metodą getId() w wersjach roboczych Gmaila.
// Get the first draft message in your drafts folder var draft = GmailApp.getDrafts()[0]; // Get its ID var draftId = draft.getId(); // Now fetch the same draft using that ID. var draftById = GmailApp.getDraft(draftId); // Should always log true as they should be the same message Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());
Parametry
Nazwa | Typ | Opis |
---|---|---|
draftId | String | identyfikator wersji roboczej do pobrania, |
Powrót
GmailDraft
– wersja robocza o podanym identyfikatorze,
Wyrzuca
Error
– jeśli nie można znaleźć wersji roboczej o podanym identyfikatorze,
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getDraftMessages()
Pobiera wszystkie wersje robocze wiadomości.
// Logs the number of draft messages var drafts = GmailApp.getDraftMessages(); Logger.log(drafts.length);
Powrót
GmailMessage[]
– tablica wersji roboczych wiadomości z Gmaila.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getDrafts()
Pobiera wszystkie wersje robocze wiadomości z Gmaila.
var drafts = GmailApp.getDrafts(); for (var i = 0; i < drafts.length; i++) { Logger.log(drafts[i].getId()); }
Powrót
GmailDraft[]
– tablica wiadomości roboczych w Gmailu.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getInboxThreads()
Pobiera wszystkie wątki z Odebranych niezależnie od etykiet.
To wywołanie nie powiedzie się, gdy rozmiar wszystkich wątków będzie zbyt duży, aby system mógł je obsłużyć. Jeśli rozmiar wątku jest nieznany i potencjalnie bardzo duży, użyj wywołania „paged” i określ zakresy wątków do pobrania w każdym wywołaniu.
// Log the subject lines of your Inbox var threads = GmailApp.getInboxThreads(); for (var i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); }
Powrót
GmailThread[]
– tablica wątków Gmaila w skrzynce odbiorczej
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getInboxThreads(start, max)
Pobiera zakres wątków z Odebranych niezależnie od etykiet.
// Log the subject lines of up to the first 50 emails in your Inbox var threads = GmailApp.getInboxThreads(0, 50); for (var i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); }
Parametry
Nazwa | Typ | Opis |
---|---|---|
start | Integer | indeks pierwszego wątku do pobrania |
max | Integer | maksymalna liczba wątków do pobrania |
Powrót
GmailThread[]
– tablica wątków Gmaila w skrzynce odbiorczej
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getInboxUnreadCount()
Pobiera liczbę nieprzeczytanych wątków w skrzynce odbiorczej.
Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());
Powrót
Integer
– liczba wątków w skrzynce odbiorczej, które zawierają nieprzeczytane wiadomości.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getMessageById(id)
Pobiera wiadomość według identyfikatora.
Używaj tej funkcji w połączeniu z funkcją getId() w wiadomościach Gmaila.
// Get the first message in the first thread of your inbox var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; // Get its ID var messageId = message.getId(); // Now fetch the same message using that ID. var messageById = GmailApp.getMessageById(messageId); // Should always log true as they should be the same message Logger.log(message.getSubject() == messageById.getSubject());
Parametry
Nazwa | Typ | Opis |
---|---|---|
id | String | identyfikator wiadomości do pobrania |
Powrót
GmailMessage
– wiadomość o podanym identyfikatorze,
Wyrzuca
Error
– jeśli nie można znaleźć wiadomości o podanym identyfikatorze
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
getMessagesForThread(thread)
Pobierz wszystkie wiadomości w określonym wątku.
// Log all the subject lines in the first thread of your inbox var thread = GmailApp.getInboxThreads(0, 1)[0]; var messages = GmailApp.getMessagesForThread(thread); for (var i = 0 ; i < messages.length; i++) { Logger.log("subject: " + messages[i].getSubject()); }
Parametry
Nazwa | Typ | Opis |
---|---|---|
thread | GmailThread | wątek wiadomości do pobrania |
Powrót
GmailMessage[]
– tablica wiadomości odpowiadających temu wątekowi.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
getMessagesForThreads(threads)
Pobierz wszystkie wiadomości w określonych wątkach.
// Log the subject lines of all messages in the first two threads of your inbox var thread = GmailApp.getInboxThreads(0, 2); var messages = GmailApp.getMessagesForThreads(thread); for (var i = 0 ; i < messages.length; i++) { for (var j = 0; j < messages[i].length; j++) { Logger.log("subject: " + messages[i][j].getSubject()); } }
Parametry
Nazwa | Typ | Opis |
---|---|---|
threads | GmailThread[] | wątki wiadomości do pobrania |
Powrót
GmailMessage[][]
– tablica tablic wiadomości, gdzie każdy element w tablicy zewnętrznej odpowiada wątku, a tablica wewnętrzna zawiera wiadomości z tego wątku
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
getPriorityInboxThreads()
Pobiera wszystkie wątki z Priorytetów niezależnie od etykiet.
To wywołanie nie powiedzie się, gdy rozmiar wszystkich wątków będzie zbyt duży, aby system mógł je obsłużyć. Jeśli rozmiar wątku jest nieznany i potencjalnie bardzo duży, użyj wywołania „paged” i określ zakresy wątków do pobrania w każdym wywołaniu.
Logger.log("# of messages in your Priority Inbox: " + GmailApp.getPriorityInboxThreads().length);
Powrót
GmailThread[]
– tablica wątków Gmaila w Priorytetach
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getPriorityInboxThreads(start, max)
Pobiera zakres wątków z Priorytetów niezależnie od etykiet.
// Will log some number 2 or less Logger.log("# of messages in your Priority Inbox: " + GmailApp.getPriorityInboxThreads(0, 2).length);
Parametry
Nazwa | Typ | Opis |
---|---|---|
start | Integer | indeks pierwszego wątku do pobrania |
max | Integer | maksymalna liczba wątków do pobrania |
Powrót
GmailThread[]
– tablica wątków Gmaila w Priorytetach
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getPriorityInboxUnreadCount()
Pobiera liczbę nieprzeczytanych wątków w Priorytetach.
Logger.log("Number of unread emails in your Priority Inbox : " + GmailApp.getPriorityInboxUnreadCount());
Powrót
Integer
– liczba wątków w Priorytetach, które zawierają nieprzeczytane wiadomości.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getSpamThreads()
Pobiera wszystkie wątki ze spamem niezależnie od etykiet.
To wywołanie nie powiedzie się, gdy rozmiar wszystkich wątków będzie zbyt duży, aby system mógł je obsłużyć. Jeśli rozmiar wątku jest nieznany i potencjalnie bardzo duży, użyj wywołania „paged” i określ zakresy wątków do pobrania w każdym wywołaniu.
Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);
Powrót
GmailThread[]
– tablica wątków z Gmaila w folderze ze spamem.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getSpamThreads(start, max)
Pobiera różne wątki ze spamem niezależnie od etykiet.
// Will log a number at most 5 Logger.log("# of total spam threads: " + GmailApp.getSpamThreads(0, 5).length);
Parametry
Nazwa | Typ | Opis |
---|---|---|
start | Integer | indeks pierwszego wątku do pobrania |
max | Integer | maksymalna liczba wątków do pobrania |
Powrót
GmailThread[]
– tablica wątków z Gmaila w folderze ze spamem.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getSpamUnreadCount()
Pobiera liczbę nieprzeczytanych wątków, które są spamem.
// Unless you actually read stuff in your spam folder, this should be the same as // the number of messages in your spam folder. Logger.log("# unread threads that are spam: " + GmailApp.getSpamUnreadCount());
Powrót
Integer
– liczba wątków ze spamem, które mają nieprzeczytane wiadomości.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getStarredThreads()
Pobiera wszystkie wątki oznaczone gwiazdką niezależnie od etykiet.
To wywołanie nie powiedzie się, gdy rozmiar wszystkich wątków będzie zbyt duży, aby system mógł je obsłużyć. Jeśli rozmiar wątku jest nieznany i potencjalnie bardzo duży, użyj wywołania „paged” i określ zakresy wątków do pobrania w każdym wywołaniu.
// Logs the number of starred threads Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);
Powrót
GmailThread[]
– tablica wątków w Gmailu oznaczonych gwiazdką.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getStarredThreads(start, max)
Pobiera zakres wątków oznaczonych gwiazdką niezależnie od etykiet.
// Logs the number of starred threads to a maximum of 5 Logger.log("# Starred threads: " + GmailApp.getStarredThreads(0, 5).length);
Parametry
Nazwa | Typ | Opis |
---|---|---|
start | Integer | indeks pierwszego wątku do pobrania |
max | Integer | maksymalna liczba wątków do pobrania |
Powrót
GmailThread[]
– tablica wątków w Gmailu oznaczonych gwiazdką.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getStarredUnreadCount()
Pobiera liczbę nieprzeczytanych wątków oznaczonych gwiazdką.
Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());
Powrót
Integer
– liczba wątków oznaczonych gwiazdką, które zawierają nieprzeczytane wiadomości.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getThreadById(id)
Pobiera wątek według identyfikatora.
Używaj tej funkcji w połączeniu z metodą getId() w wątkach Gmaila.
// Gets the first inbox thread. const firstThread = GmailApp.getInboxThreads(0,1)[0]; // Gets the same thread by ID. const threadById = GmailApp.getThreadById(firstThread.getId()); // Verifies that they are the same. console.log(firstThread.getFirstMessageSubject() === threadById.getFirstMessageSubject());
Parametry
Nazwa | Typ | Opis |
---|---|---|
id | String | Identyfikator wątku do pobrania. |
Powrót
GmailThread
– wątek o podanym identyfikatorze lub null
, jeśli nie został znaleziony.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
getTrashThreads()
Pobiera wszystkie wątki z kosza niezależnie od etykiet.
To wywołanie nie powiedzie się, gdy rozmiar wszystkich wątków będzie zbyt duży, aby system mógł je obsłużyć. Jeśli rozmiar wątku jest nieznany i potencjalnie bardzo duży, użyj wywołania „paged” i określ zakresy wątków do pobrania w każdym wywołaniu.
Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);
Powrót
GmailThread[]
– tablica wątków Gmaila w koszu
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getTrashThreads(start, max)
Pobiera zakres wątków z kosza niezależnie od etykiet.
// Will log a number at most 5 Logger.log("# of total trash threads: " + GmailApp.getTrashThreads(0, 5).length);
Parametry
Nazwa | Typ | Opis |
---|---|---|
start | Integer | indeks pierwszego wątku do pobrania |
max | Integer | maksymalna liczba wątków do pobrania |
Powrót
GmailThread[]
– tablica wątków Gmaila w koszu
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getUserLabelByName(name)
Pobiera etykietę o jej nazwie.
var labelObject = GmailApp.getUserLabelByName("myLabel");
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa etykiety do pobrania |
Powrót
GmailLabel
– etykieta Gmaila o podanej nazwie.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
getUserLabels()
Pobiera listę etykiet utworzonych przez użytkownika.
// Logs all of the names of your labels var labels = GmailApp.getUserLabels(); for (var i = 0; i < labels.length; i++) { Logger.log("label: " + labels[i].getName()); }
Powrót
GmailLabel[]
– tablica etykiet utworzonych przez użytkowników.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
markMessageRead(message)
Oznacza wiadomość jako przeczytaną i wymusza jej odświeżenie.
// Mark the first message in the first thread of your inbox as read var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; GmailApp.markMessageRead(message);
Parametry
Nazwa | Typ | Opis |
---|---|---|
message | GmailMessage | wiadomość do oznaczenia jako przeczytana |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
markMessageUnread(message)
Oznacza wiadomość jako nieprzeczytaną i wymusza odświeżenie jej.
// Mark the first message in the first thread of your inbox as unread var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; GmailApp.markMessageUnread(message);
Parametry
Nazwa | Typ | Opis |
---|---|---|
message | GmailMessage | wiadomość do oznaczenia jako nieprzeczytana |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
markMessagesRead(messages)
Oznacza te wiadomości jako przeczytane i wymusza ich odświeżenie.
// Mark first three messages in the first inbox thread as read. // Assumes that the first inbox thread has 3 messages in it. var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages(); var messages = [threadMessages[0], threadMessages[1], threadMessages[2]]; GmailApp.markMessagesRead(thread.getMessages());
Parametry
Nazwa | Typ | Opis |
---|---|---|
messages | GmailMessage[] | tablica wiadomości do oznaczenia jako przeczytane |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
markMessagesUnread(messages)
Oznacza te wiadomości jako nieprzeczytane i wymusza ich odświeżenie.
// Mark first three messages in the first inbox thread as unread. // Assumes that the first inbox thread has 3 messages in it var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages(); var messages = [threadMessages[0], threadMessages[1], threadMessages[2]]; GmailApp.markMessagesUnread(thread.getMessages());
Parametry
Nazwa | Typ | Opis |
---|---|---|
messages | GmailMessage[] | tablica wiadomości do oznaczenia jako nieprzeczytane |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
markThreadImportant(thread)
Oznacza wątek jako ważny i wymusza jego odświeżenie.
// Marks first inbox thread as important var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadImportant(thread);
Parametry
Nazwa | Typ | Opis |
---|---|---|
thread | GmailThread | wątek do oznaczenia jako ważny. |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
markThreadRead(thread)
Oznacza wątek jako przeczytany i wymusza jego odświeżenie.
// Marks first inbox thread as read var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadRead(thread);
Parametry
Nazwa | Typ | Opis |
---|---|---|
thread | GmailThread | wątek do oznaczenia jako przeczytany |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
markThreadUnimportant(thread)
Oznacza wątek jako nieważny i wymusza jego odświeżenie.
// Marks first inbox thread as unimportant var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnimportant(thread);
Parametry
Nazwa | Typ | Opis |
---|---|---|
thread | GmailThread | wątek do oznaczenia jako nieważny |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
markThreadUnread(thread)
Oznacza wątek jako nieprzeczytany i wymusza jego odświeżenie.
// Marks first inbox thread as unread var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnread(thread);
Parametry
Nazwa | Typ | Opis |
---|---|---|
thread | GmailThread | wątek do oznaczenia jako nieprzeczytanego |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
markThreadsImportant(threads)
Oznacza wątki jako ważne i wymusza ich odświeżenie.
// Marks first two threads in inbox as important var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsImportant(threads);
Parametry
Nazwa | Typ | Opis |
---|---|---|
threads | GmailThread[] | tablicę wątków do oznaczenia jako ważne, |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
markThreadsRead(threads)
Oznacza wątki jako przeczytane i wymusza ich odświeżenie.
// Marks first two threads in inbox as read var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsRead(threads);
Parametry
Nazwa | Typ | Opis |
---|---|---|
threads | GmailThread[] | tablica wątków do oznaczenia jako przeczytane |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
markThreadsUnimportant(threads)
Oznacza wątki jako nieważne i wymusza ich odświeżenie.
// Marks first two threads in inbox as unimportant var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnimportant(threads);
Parametry
Nazwa | Typ | Opis |
---|---|---|
threads | GmailThread[] | tablicę wątków do oznaczenia jako mało ważnych |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
markThreadsUnread(threads)
Oznacza wątki jako nieprzeczytane i wymusza ich odświeżenie.
// Marks first two threads in inbox as unread var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnread(threads);
Parametry
Nazwa | Typ | Opis |
---|---|---|
threads | GmailThread[] | tablica wątków do oznaczenia jako nieprzeczytane |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
moveMessageToTrash(message)
Przenosi wiadomość do kosza i wymusza jej odświeżenie.
// Move the first message in your inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; var firstMessage = firstThread.getMessages()[0]; GmailApp.moveMessageToTrash(firstMessage);
Parametry
Nazwa | Typ | Opis |
---|---|---|
message | GmailMessage | wiadomość do przeniesienia do kosza |
Powrót
GmailApp
– usługa Gmail (przydatna przy tworzeniu łańcuszków),
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
moveMessagesToTrash(messages)
Przenosi określone wiadomości do kosza i wymusza ich odświeżenie.
// Move first two messages in your inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; var messages = firstThread.getMessages(); var toDelete = [messages[0], messages[1]]; GmailApp.moveMessagesToTrash(toDelete);
Parametry
Nazwa | Typ | Opis |
---|---|---|
messages | GmailMessage[] | wiadomości do przeniesienia do kosza |
Powrót
GmailApp
– usługa Gmail (przydatna przy tworzeniu łańcuszków),
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
moveThreadToArchive(thread)
Przenosi ten wątek do archiwum i wymusza jego odświeżenie.
// Archive the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToArchive(firstThread);
Parametry
Nazwa | Typ | Opis |
---|---|---|
thread | GmailThread | wątek do zarchiwizowania |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
moveThreadToInbox(thread)
Przenosi ten wątek do skrzynki odbiorczej i wymusza jego odświeżenie.
// Find a thread not already in your inbox var thread = GmailApp.search("-in:inbox")[0]; // Get the first one GmailApp.moveThreadToInbox(thread);
Parametry
Nazwa | Typ | Opis |
---|---|---|
thread | GmailThread | wątek do przeniesienia do skrzynki odbiorczej, |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
moveThreadToSpam(thread)
Przenosi ten wątek do spamu i wymusza jego odświeżenie.
// Tag first thread in inbox as spam var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToSpam(firstThread);
Parametry
Nazwa | Typ | Opis |
---|---|---|
thread | GmailThread | wątek, który ma zostać przeniesiony do spamu |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
moveThreadToTrash(thread)
Przenosi ten wątek do kosza i wymusza jego odświeżenie.
// Move first thread in inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToTrash(firstThread);
Parametry
Nazwa | Typ | Opis |
---|---|---|
thread | GmailThread | wątek do usunięcia do kosza |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
moveThreadsToArchive(threads)
Przenosi te wątki do archiwum i wymusza ich odświeżenie.
// Move first two threads in your inbox to the archive var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToArchive(firstTwoThreads);
Parametry
Nazwa | Typ | Opis |
---|---|---|
threads | GmailThread[] | tablica wątków do archiwizacji |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
moveThreadsToInbox(threads)
Przenosi te wątki do skrzynki odbiorczej i wymusza ich odświeżenie.
// Find two threads not already in your inbox var firstTwoThreads = GmailApp.search("-in:inbox", 0, 2); GmailApp.moveThreadsToInbox(firstTwoThreads);
Parametry
Nazwa | Typ | Opis |
---|---|---|
threads | GmailThread[] | tablica wątków do przeniesienia do skrzynki odbiorczej |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
moveThreadsToSpam(threads)
Przenosi te wątki do spamu i wymusza ich odświeżenie.
// Move first two threads in your inbox to spam var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToSpam(firstTwoThreads);
Parametry
Nazwa | Typ | Opis |
---|---|---|
threads | GmailThread[] | tablica wątków do przeniesienia do spamu |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
moveThreadsToTrash(threads)
Przenosi te wątki do kosza i wymusza ich odświeżenie.
// Move first two threads in your inbox to trash var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToTrash(firstTwoThreads);
Parametry
Nazwa | Typ | Opis |
---|---|---|
threads | GmailThread[] | tablica wątków do usunięcia |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
refreshMessage(message)
Wczytuje ponownie wiadomość i powiązany stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.).
var firstThread = GmailApp.getInboxThreads(0,1)[0]; var firstMessage = firstThread.getMessages()[0]; // ...Do something that may take a while here.... GmailApp.refreshMessage(firstMessage); // ...Do more stuff with firstMessage...
Parametry
Nazwa | Typ | Opis |
---|---|---|
message | GmailMessage | wiadomość do odświeżenia |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
refreshMessages(messages)
Wczytuje ponownie wiadomości i powiązane z nimi stany z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.).
var firstThread = GmailApp.getInboxThreads(0,1)[0]; var coupleOfMessages = firstThread.getMessages().slice(0, 2); // ...Do something that may take a while here.... GmailApp.refreshMessages(coupleOfMessages); // ...Do more stuff with coupleOfMessages...
Parametry
Nazwa | Typ | Opis |
---|---|---|
messages | GmailMessage[] | wiadomości do odświeżenia |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
refreshThread(thread)
Wczytuje ponownie wątek i powiązany stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.).
var firstThread = GmailApp.getInboxThreads(0,1)[0]; // ...Do something that may take a while here.... GmailApp.refreshThread(firstThread); // ... Do more stuff with the thread ...
Parametry
Nazwa | Typ | Opis |
---|---|---|
thread | GmailThread | wątek do odświeżenia |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
refreshThreads(threads)
Wczytuje ponownie wątki i powiązany stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.).
var threads = GmailApp.getInboxThreads(0, 3); // ...Do something that may take a while here.... GmailApp.refreshThreads(threads); // ... Do more stuff with threads ...
Parametry
Nazwa | Typ | Opis |
---|---|---|
threads | GmailThread[] | wątki do odświeżenia |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
search(query)
Wyszukaj w Gmailu dane zapytanie.
To wywołanie nie powiedzie się, gdy rozmiar wszystkich wątków będzie zbyt duży, aby system mógł je obsłużyć. Jeśli rozmiar wątku jest nieznany i potencjalnie bardzo duży, użyj wywołania „paged” i określ zakresy wątków do pobrania w każdym wywołaniu.
// Find starred messages with subject IMPORTANT var threads = GmailApp.search('is:starred subject:"IMPORTANT"');
Parametry
Nazwa | Typ | Opis |
---|---|---|
query | String | zapytania, tak jak podczas wpisywania go w Gmailu |
Powrót
GmailThread[]
– tablica wątków z Gmaila pasujących do tego zapytania
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
search(query, start, max)
Wyszukaj w Gmailu dane zapytanie.
// Find starred messages with subject IMPORTANT and return second batch of 10. // Assumes there are at least 11 of them, otherwise this will return an empty array. var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);
Parametry
Nazwa | Typ | Opis |
---|---|---|
query | String | zapytania, tak jak podczas wpisywania go w Gmailu |
start | Integer | indeks początkowego wątku |
max | Integer | maksymalna liczba wątków do zwrócenia |
Powrót
GmailThread[]
– tablica wątków z Gmaila pasujących do tego zapytania
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
sendEmail(recipient, subject, body)
Wysyła e-maila. Rozmiar e-maila (wraz z nagłówkami) jest ograniczony.
// The code below will send an email with the current date and time. var now = new Date(); GmailApp.sendEmail("mike@example.com", "current time", "The time is: " + now.toString());
Parametry
Nazwa | Typ | Opis |
---|---|---|
recipient | String | lista adresów e-mail oddzielonych przecinkami |
subject | String | temat e-maila (maksymalnie 250 znaków) |
body | String | treść e-maila |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
sendEmail(recipient, subject, body, options)
Wysyła e-maila z opcjonalnymi argumentami. Może zawierać zwykły tekst lub treść HTML. Rozmiar e-maila (z nagłówkami, ale bez załączników) jest ograniczony.
// Send an email with a file from Google Drive attached as a PDF. var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz'); GmailApp.sendEmail('mike@example.com', 'Attachment example', 'Please see the attached file.', { attachments: [file.getAs(MimeType.PDF)], name: 'Automatic Emailer Script' });
Parametry
Nazwa | Typ | Opis |
---|---|---|
recipient | String | adresy odbiorców |
subject | String | wiersz tematu (do 250 znaków) |
body | String | treść e-maila |
options | Object | obiekt JavaScript określający parametry zaawansowane, wymienione poniżej. |
Parametry zaawansowane
Nazwa | Typ | Opis |
---|---|---|
attachments | BlobSource[] | tablicę plików do wysłania w e-mailu. |
bcc | String | rozdzielana przecinkami lista adresów e-mail do przekazania w polu UDW |
cc | String | rozdzielana przecinkami lista adresów e-mail, na które mają zostać wysłane wiadomości w polu DW |
from | String | Adres, z którego należy wysłać e-maila. Musi on być jedną z wartości zwróconych przez getAliases() . |
htmlBody | String | Jeśli zasada jest skonfigurowana, urządzenia z możliwością renderowania kodu HTML będą korzystać z niego zamiast wymaganego argumentu treści. Możesz dodać opcjonalne pole inlineImages w treści HTML, jeśli masz w e-mailu obrazy w treści. |
inlineImages | Object | obiekt JavaScript zawierający mapowanie z klucza obrazu (String ) na dane obrazu (BlobSource ); przyjmuje się, że używany jest parametr htmlBody i zawiera odwołania do tych obrazów w formacie <img src="cid:imageKey" /> |
name | String | nazwa nadawcy e-maila (domyślnie: nazwa użytkownika), |
noReply | Boolean | true , jeśli e-mail powinien być wysłany z ogólnego adresu e-mail służącego do wysyłania wiadomości, który nie przyjmuje poczty przychodzącej, aby zniechęcić odbiorców do odpowiadania na e-maile. Ta opcja jest dostępna tylko na kontach Google Workspace, a nie na kontach użytkowników Gmaila. |
replyTo | String | adres e-mail, który ma być używany jako domyślny adres zwrotny (domyślnie: adres e-mail użytkownika) |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
setCurrentMessageAccessToken(accessToken)
Ustawia bieżący token dostępu do wiadomości, który umożliwia skryptowi dostęp do bieżących właściwości GmailMessage
.
Tej metody wymagają tylko projekty dodatku do Google Workspace korzystające z aktualnych zakresów wiadomości Gmaila.
function handleAddonActionEvent(e) { var accessToken = e.messageMetadata.accessToken; var messageId = e.messageMetadata.messageId; GmailApp.setCurrentMessageAccessToken(accessToken); var mailMessage = GmailApp.getMessageById(messageId); // Do something with mailMessage }
Parametry
Nazwa | Typ | Opis |
---|---|---|
accessToken | String | tymczasowy token dostępu uzyskany z obiektu zdarzenia czynności dodatku Gmail. |
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
starMessage(message)
Dodaje gwiazdkę do wiadomości i wymusza odświeżenie wiadomości.
// Stars the first message in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; GmailApp.starMessage(message);
Parametry
Nazwa | Typ | Opis |
---|---|---|
message | GmailMessage | wiadomość do oznaczenia gwiazdką |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
starMessages(messages)
Powoduje dodanie gwiazdek do takich wiadomości i wymusza ich odświeżenie.
// Stars the first three messages in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var coupleOfMessages = firstThread.getMessages().slice(0, 3); GmailApp.starMessages(coupleOfMessages);
Parametry
Nazwa | Typ | Opis |
---|---|---|
messages | GmailMessage[] | tablica wiadomości do oznaczenia gwiazdką |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
unstarMessage(message)
Usuwa gwiazdkę z wiadomości i wymusza odświeżenie wiadomości.
// Unstars the first message in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; GmailApp.unstarMessage(message);
Parametry
Nazwa | Typ | Opis |
---|---|---|
message | GmailMessage | wiadomość do usunięcia oznaczenia gwiazdką |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/
Zobacz też
unstarMessages(messages)
Usuwa gwiazdki z tych wiadomości i wymusza ich odświeżenie.
// Unstars the first three messages in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var coupleOfMessages = firstThread.getMessages().slice(0, 3); GmailApp.unstarMessages(coupleOfMessages);
Parametry
Nazwa | Typ | Opis |
---|---|---|
messages | GmailMessage[] | tablica wiadomości do usunięcia oznaczenia gwiazdką |
Powrót
GmailApp
– usługa Gmail przydatna do tworzenia łańcuszków
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:
-
https://mail.google.com/