Class GmailApp

Aplikacja Gmail

Zapewnia 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ę 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.

Wycofane metody

Metoda	Zwracany typ	Krótki opis
getChatThreads()	GmailThread[]	Przekształca wszystkie wątki z klasycznej wersji Hangouts i wątki w Google Chat do momentu przeniesienia wszystkich użytkowników klasycznej wersji Hangouts na Google Chat w tym roku.
getChatThreads(start, max)	GmailThread[]	Przekształca wiele wątków klasycznej wersji Google Hangouts i wątków Google Chat w dalszą wersję tego roku, dopóki Google nie przełączy wszystkich użytkowników klasycznej wersji Hangouts na Google Chat.

Szczegółowa dokumentacja

createDraft(recipient, subject, body)

Tworzy wersję roboczą e-maila. Rozmiar e-maila (w tym nagłówków) jest ograniczony.

// The code below creates a draft email with the current date and time.
var now = new Date();
GmailApp.createDraft("[e-mail]", "current time", "The time is: " + now.toString());

Parametry

Nazwa	Typ	Opis
recipient	String	lista adresów e-mail rozdzielonych przecinkami
subject	String	tematu e-maila
body	String	treść e-maila

Zwróć

GmailDraft – nowo utworzona wersja robocza Gmaila

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• createDraft(recipient, subject, body, options)

---

createDraft(recipient, subject, body, options)

Tworzy wersję roboczą e-maila z opcjonalnymi argumentami. E-mail może zawierać zwykły tekst lub treść HTML. Rozmiar e-maila (w tym nagłówków, ale z wyłączeniem 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('[e-mail]', 'Attachment example', 'Please see attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Parametry

Nazwa	Typ	Opis
recipient	String	i adresy odbiorców.
subject	String	wiersz tematu,
body	String	treść e-maila,
options	Object	obiekt JavaScript, który określa zaawansowane parametry, jak poniżej

Parametry zaawansowane

Nazwa	Typ	Opis
attachments	BlobSource[]	tablica plików do wysłania w wiadomości e-mail
bcc	String	oddzielona przecinkami lista adresów e-mail w polu UDW.
cc	String	oddzielona przecinkami lista adresów e-mail dla adresatów w polu DW.
from	String	adres, z którego ma zostać wysłany e-mail. Musi to być jedna z wartości zwróconych przez getAliases()
htmlBody	String	jeśli jest skonfigurowana, urządzenia, które mogą renderować kod HTML, będą go używać zamiast wymaganego argumentu „body”. Do treści HTML możesz dodać opcjonalne pole inlineImages, jeśli masz wbudowane obrazy do e-maila.
inlineImages	Object	obiekt JavaScript zawierający mapowanie z klucza obrazu (String) na dane obrazu (BlobSource). Zakładamy, że używany jest parametr htmlBody i 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);

Zwróć

GmailDraft – nowo utworzona wersja robocza Gmaila

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• createDraft(recipient, subject, body)

---

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;

Zwróć

GmailLabel – nowo utworzona etykieta

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• deleteLabel(label)

---

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	etykieta do usunięcia

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• createLabel(name)

---

getAliases()

Pobiera listę e-maili skonfigurowanych jako aliasy tego konta w Gmailu.

Wiadomości możesz wysyłać z dowolnego z tych aliasów, używając argumentu „"from"”.

// 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.');
}

Zwróć

String[] – tablica aliasów tego konta.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• sendEmail(recipient, subject, body, options)

---

getDraft(draftId)

Pobierz wersję roboczą e-maila według identyfikatora.

Używaj go w połączeniu z funkcją 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

Zwróć

GmailDraft – wersja robocza z podanym identyfikatorem

Narzuty

Error – jeśli nie można znaleźć wersji roboczej o podanym identyfikatorze,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie 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);

Zwróć

GmailMessage[] – tablica wersji wiadomości z Gmaila;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie 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());
}

Zwróć

GmailDraft[] – tablica wersji roboczych wiadomości z Gmaila;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

---

getInboxThreads()

Pobiera wszystkie wątki w Odebranych niezależnie od etykiet.

To wywołanie nie powiedzie się, gdy rozmiar wszystkich wątków jest zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i potencjalnie duży, użyj wywołania „&&39;paged'” określ zakresy wątków do pobrania.

// Log the subject lines of your Inbox
var threads = GmailApp.getInboxThreads();
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Zwróć

GmailThread[] – tablica wątków w skrzynce odbiorczej w Gmailu;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

---

getInboxThreads(start, max)

Pobiera zakres wątków w Odebranych bez względu na etykiety.

// 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

Zwróć

GmailThread[] – tablica wątków w skrzynce odbiorczej w Gmailu;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

---

getInboxUnreadCount()

Pobiera liczbę nieprzeczytanych wątków w skrzynce odbiorczej.

Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());

Zwróć

Integer – liczba wątków w skrzynce odbiorczej, które zawierają nieprzeczytane wiadomości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

---

getMessageById(id)

Pobiera wiadomość na podstawie identyfikatora.

Używaj go w połączeniu z getId() w wiadomościach w Gmailu.

// 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

Zwróć

GmailMessage – wiadomość o podanym identyfikatorze,

Narzuty

Error – jeśli nie można znaleźć wiadomości o podanym identyfikatorze,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• getThreadById(id)

---

getMessagesForThread(thread)

Pobieranie wszystkich 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

Zwróć

GmailMessage[] – tablica wiadomości powiązanych z tym wątkiem.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• getMessagesForThreads(threads)

---

getMessagesForThreads(threads)

Pobieranie wszystkich wiadomości z określonych wątków.

// 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 do pobrania

Zwróć

GmailMessage[][] – tablica tablicy wiadomości, w których każdy element zewnętrzny odpowiada wątku, a wewnętrzna tablica zawiera wiadomości z tego wątku.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• getMessagesForThread(thread)

---

getPriorityInboxThreads()

Pobiera wszystkie wątki z Priorytetów niezależnie od etykiet.

To wywołanie nie powiedzie się, gdy rozmiar wszystkich wątków jest zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i potencjalnie duży, użyj wywołania „&&39;paged'” określ zakresy wątków do pobrania.

Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads().length);

Zwróć

GmailThread[] – tablica wątków w skrzynce odbiorczej Priorytety,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

---

getPriorityInboxThreads(start, max)

Pobiera zakres Priorytetów skrzynki odbiorczej 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

Zwróć

GmailThread[] – tablica wątków w skrzynce odbiorczej Priorytety,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie 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());

Zwróć

Integer – liczba wątków w Priorytetach, które zawierają nieprzeczytane wiadomości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

---

getSpamThreads()

Pobiera wszystkie wątki spamu niezależnie od etykiet.

To wywołanie nie powiedzie się, gdy rozmiar wszystkich wątków jest zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i potencjalnie duży, użyj wywołania „&&39;paged'” określ zakresy wątków do pobrania.

Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);

Zwróć

GmailThread[] – tablica wątków Gmaila w folderze ze spamem;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

---

getSpamThreads(start, max)

Pobiera zakres wątków spamu bez względu na etykiety.

// 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

Zwróć

GmailThread[] – tablica wątków Gmaila w folderze ze spamem;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

---

getSpamUnreadCount()

Pobiera liczbę nieprzeczytanych wątków jako spamu.

// 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());

Zwróć

Integer – liczba wątków spamowych z nieprzeczytanymi wiadomościami.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie 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 jest zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i potencjalnie duży, użyj wywołania „&&39;paged'” określ zakresy wątków do pobrania.

// Logs the number of starred threads
Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);

Zwróć

GmailThread[] – tablica wątków z Gmaila oznaczonych gwiazdką

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie 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

Zwróć

GmailThread[] – tablica wątków z Gmaila oznaczonych gwiazdką

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

---

getStarredUnreadCount()

Pobiera liczbę nieprzeczytanych wątków oznaczonych gwiazdką.

Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());

Zwróć

Integer – liczba wątków oznaczonych gwiazdką, które zawierają nieprzeczytane wiadomości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

---

getThreadById(id)

Pobiera wątek według identyfikatora.

Używaj go w połączeniu z funkcją getId() w wątkach Gmaila.

// Thread IDs can also be found in the location bar when you have a thread open in Gmail
// get first inbox thread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
// Get the same thread by ID
var threadById = GmailApp.getThreadById(firstThread.getId());
// Verify they are the same
Logger.log(firstThread.getFirstMessageSubject() == threadById.getFirstMessageSubject());

Parametry

Nazwa	Typ	Opis
id	String	identyfikator wątku do pobrania

Zwróć

GmailThread – wątek o podanym identyfikatorze lub wartość null (nie znaleziono)

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• getMessageById(id)

---

getTrashThreads()

Pobiera wszystkie wątki kosza niezależnie od etykiet.

To wywołanie nie powiedzie się, gdy rozmiar wszystkich wątków jest zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i potencjalnie duży, użyj wywołania „&&39;paged'” określ zakresy wątków do pobrania.

Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);

Zwróć

GmailThread[] – tablica wątków w Gmailu w koszu.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

---

getTrashThreads(start, max)

Pobiera zakres wątków 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

Zwróć

GmailThread[] – tablica wątków w Gmailu w koszu.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

---

getUserLabelByName(name)

Pobiera etykietę o nazwie.

var labelObject = GmailApp.getUserLabelByName("myLabel");

Parametry

Nazwa	Typ	Opis
name	String	nazwa etykiety do pobrania

Zwróć

GmailLabel – etykieta Gmaila o podanej nazwie,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

---

getUserLabels()

Pobiera listę etykiet utworzonych przez użytkowników.

// 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());
}

Zwróć

GmailLabel[] – tablica etykiet utworzonych przez użytkowników;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie 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

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• markMessageUnread(message)

---

markMessageUnread(message)

Oznacza wiadomość jako nieprzeczytaną i wymusza jej odświeżenie.

// 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

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• markMessageRead(message)

---

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 przeczytanej

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• markMessagesUnread(messages)

---

markMessagesUnread(messages)

Oznacza wiadomości jako nieprzeczytane i wymuszają 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 oznaczonych jako nieprzeczytane

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• markMessagesRead(messages)

---

markThreadImportant(thread)

Oznacza wątek jako ważny i wymusza odświeżenie wątku.

// Marks first inbox thread as important
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

Parametry

Nazwa	Typ	Opis
thread	GmailThread	wątek, który chcesz oznaczyć jako ważny;

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• markThreadUnimportant(thread)

---

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, który chcesz oznaczyć jako przeczytany.

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• markThreadUnread(thread)

---

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, który trzeba oznaczyć jako nieważny;

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• markThreadImportant(thread)

---

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, który chcesz oznaczyć jako nieprzeczytane.

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• markThreadRead(thread)

---

markThreadsImportant(threads)

Oznacza te 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[]	szereg wątków do oznaczenia jako ważne

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• markThreadsUnimportant(threads)

---

markThreadsRead(threads)

Oznacza te 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 oznaczonych jako przeczytane.

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• markThreadsUnread(threads)

---

markThreadsUnimportant(threads)

Oznacza te wątki jako nieistotne 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[]	tablica wątków oznaczonych jako nieważne

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• markThreadsImportant(threads)

---

markThreadsUnread(threads)

Oznaczy te wątki jako nieprzeczytane i wymusi odświeżenie wątków.

// 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 oznaczonych jako nieprzeczytane

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• markThreadsRead(threads)

---

moveMessageToTrash(message)

Przeniesienie wiadomości do kosza i wymuszanie jej odświeżenia.

// 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 usunięcia;

Zwróć

GmailApp – usługa Gmail (przydatna do tworzenia łańcuchów)

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• moveMessagesToTrash(messages)

---

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 kosza.

Zwróć

GmailApp – usługa Gmail (przydatna do tworzenia łańcuchów)

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• moveMessageToTrash(message)

---

moveThreadToArchive(thread)

Przenosi ten wątek do archiwum i wymusza odświeżenie wątku.

// 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, który ma zostać zarchiwizowany;

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToTrash(thread)

---

moveThreadToInbox(thread)

Przenosi ten wątek do skrzynki odbiorczej i wymusza odświeżenie wątku.

// 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, który ma zostać przeniesiony do skrzynki odbiorczej

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• moveThreadToTrash(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

---

moveThreadToSpam(thread)

Przenosi ten wątek do spamu i wymusza odświeżenie wątku.

// 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

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• moveThreadToTrash(thread)
• moveThreadToInbox(thread)
• moveThreadToArchive(thread)

---

moveThreadToTrash(thread)

Przenosi ten wątek do kosza i wymusza odświeżenie wątku.

// 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 przeniesienia do kosza,

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

---

moveThreadsToArchive(threads)

Służy do przenoszenia tych wątków do archiwum i wymusza odświeżenie wątków.

// 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 zarchiwizowania

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToTrash(threads)

---

moveThreadsToInbox(threads)

Przenosi te wątki do skrzynki odbiorczej i wymusza odświeżenie wątków.

// 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

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• moveThreadsToTrash(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

---

moveThreadsToSpam(threads)

Powoduje przeniesienie tych wątków do spamu i wymusza odświeżenie wątków.

// 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 folderu spamu

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• moveThreadsToInbox(threads)
• moveThreadsToTrash(threads)
• moveThreadsToArchive(threads)

---

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 przeniesienia do kosza

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

---

refreshMessage(message)

Wczytuje ponownie wiadomość i powiązany z nią stan w Gmailu (jest to 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

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• refreshMessages(messages)

---

refreshMessages(messages)

Wczytuje wiadomości i powiązany stan z Gmaila (jest to 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.

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• refreshMessage(message)

---

refreshThread(thread)

Wczytuje wątek i powiązany stan z Gmaila (jest to 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, który ma zostać odświeżony;

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• refreshThreads(threads)

---

refreshThreads(threads)

Ponownie ładuje wątki i powiązany stan z Gmaila (przydatne na wypadek 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

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• refreshThread(thread)

---

search(query)

Wyszukaj Gmaila przy użyciu tego zapytania.

To wywołanie nie powiedzie się, gdy rozmiar wszystkich wątków jest zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i potencjalnie duży, użyj wywołania „&&39;paged'” określ zakresy wątków do pobrania.

// Find starred messages with subject IMPORTANT
var threads = GmailApp.search('is:starred subject:"IMPORTANT"');

Parametry

Nazwa	Typ	Opis
query	String	wpisanego hasła w Gmailu.

Zwróć

GmailThread[] – tablica wątków Gmaila pasujących do tego zapytania

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

---

search(query, start, max)

Wyszukaj Gmaila przy użyciu tego zapytania.

// 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	wpisanego hasła w Gmailu.
start	Integer	indeks wątku początkowego
max	Integer	maksymalna liczba wątków do zwrócenia,

Zwróć

GmailThread[] – tablica wątków Gmaila pasujących do tego zapytania

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

---

sendEmail(recipient, subject, body)

Wysyła e-maila. Rozmiar e-maila (w tym nagłówków) jest ograniczony.

// The code below will send an email with the current date and time.
var now = new Date();
GmailApp.sendEmail("[e-mail]", "current time", "The time is: " + now.toString());

Parametry

Nazwa	Typ	Opis
recipient	String	lista adresów e-mail rozdzielonych przecinkami
subject	String	temat e-maila (maksymalnie 250 znaków),
body	String	treść e-maila

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• sendEmail(recipient, subject, body, options)

---

sendEmail(recipient, subject, body, options)

Wysyła e-maila z opcjonalnymi argumentami. E-mail może zawierać zwykły tekst lub treść HTML. Rozmiar e-maila (w tym nagłówków, ale z wyłączeniem 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('[e-mail]', 'Attachment example', 'Please see the attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Parametry

Nazwa	Typ	Opis
recipient	String	i adresy odbiorców.
subject	String	wiersz tematu (maksymalnie 250 znaków),
body	String	treść e-maila,
options	Object	obiekt JavaScript, który określa zaawansowane parametry, jak poniżej

Parametry zaawansowane

Nazwa	Typ	Opis
attachments	BlobSource[]	tablica plików do wysłania w wiadomości e-mail
bcc	String	oddzielona przecinkami lista adresów e-mail w polu UDW.
cc	String	oddzielona przecinkami lista adresów e-mail dla adresatów w polu DW.
from	String	adres, z którego ma zostać wysłany e-mail. Musi to być jedna z wartości zwróconych przez getAliases()
htmlBody	String	jeśli jest skonfigurowana, urządzenia, które mogą renderować kod HTML, będą go używać zamiast wymaganego argumentu „body”. Do treści HTML możesz dodać opcjonalne pole inlineImages, jeśli masz wbudowane obrazy do e-maila.
inlineImages	Object	obiekt JavaScript zawierający mapowanie z klucza obrazu (String) na dane obrazu (BlobSource). Zakładamy, że używany jest parametr htmlBody i 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 chcesz, by e-maile były wysyłane z ogólnego adresu e-mail, który ma zniechęcać odbiorców do odpowiadania na e-maile. Ta opcja jest dostępna tylko na kontach Google Workspace, a nie na kontach Gmail.
replyTo	String	adres e-mail, który ma być używany jako domyślny adres zwrotny (domyślnie: adres e-mail użytkownika);

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• sendEmail(recipient, subject, body)

---

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.

Ta metoda jest wymagana tylko w przypadku dodatków do Google Workspace korzystających z obecnych zakresów wiadomości w Gmailu.

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	tokenu tymczasowego dostępu uzyskanego z obiektu zdarzenia działania dodatku w Gmailu.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

---

starMessage(message)

Dodaje do wiadomości gwiazdkę 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ść oznaczona gwiazdką

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• starMessages(messages)

---

starMessages(messages)

Dodaje do tych wiadomości gwiazdki i wymusza odświeżenie wiadomości.

// 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 oznaczonych gwiazdką

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• starMessage(message)

---

unstarMessage(message)

Usunięcie gwiazdki z tej wiadomości i wymusza jej odświeżenie.

// 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 gwiazdki

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• unstarMessages(messages)

---

unstarMessages(messages)

Usuwa te wiadomości i wymusza odświeżenie wiadomości.

// 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

Zwróć

GmailApp – usługa Gmail przydatna w łańcuchach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

Zobacz też

• unstarMessage(message)

Wycofane metody

getChatThreads()

Wycofane. Ta funkcja została wycofana i nie należy jej używać w nowych skryptach.

Przekształca wszystkie wątki z klasycznej wersji Hangouts i wątki w Google Chat do momentu przeniesienia wszystkich użytkowników klasycznej wersji Hangouts na Google Chat w tym roku. Więcej informacji znajdziesz w artykule Przejście z klasycznej wersji Hangouts na Google Chat.

To wywołanie kończy się niepowodzeniem, gdy rozmiar wszystkich wątków jest zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i potencjalnie duży, użyj wywołania „'paged'” i określ zakresy wątków do pobrania w poszczególnych wywołaniach.

var threads = GmailApp.getChatThreads();
Logger.log("# of chat threads: " + threads.length);

Zwróć

GmailThread[] – tablica wątków z Gmaila.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/

---

getChatThreads(start, max)

Wycofane. Ta funkcja została wycofana i nie należy jej używać w nowych skryptach.

Przekształca wiele wątków klasycznej wersji Google Hangouts i wątków Google Chat w dalszą wersję tego roku, dopóki Google nie przełączy wszystkich użytkowników klasycznej wersji Hangouts na Google Chat. Więcej informacji znajdziesz w artykule Przejście z klasycznej wersji Hangouts na Google Chat.

// Get first 50 chat threads
var threads = GmailApp.getChatThreads(0,50);
// Will log no more than 50.0
Logger.log(threads.length);
Logger.log(threads[0].getFirstMessageSubject());

Parametry

Nazwa	Typ	Opis
start	Integer	indeks pierwszego wątku do pobrania
max	Integer	maksymalna liczba wątków do pobrania

Zwróć

GmailThread[] – tablica wątków na czacie w Gmailu

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów lub odpowiednich zakresów w powiązanym interfejsie API REST:

• https://mail.google.com/