Class GmailApp

GmailApp

Zapewnia dostęp do wątków, wiadomości i etykiet w Gmailu.

Metody

Metoda	Zwracany typ	Krótki opis
createDraft(recipient, subject, body)	GmailDraft	Tworzy wersję roboczą wiadomości e-mail.
createDraft(recipient, subject, body, options)	GmailDraft	Tworzy wersję roboczą wiadomości e-mail z argumentami opcjonalnymi.
createLabel(name)	GmailLabel	Utwórz nową etykietę użytkownika o podanej 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ą wiadomości e-mail według identyfikatora.
getDraftMessages()	GmailMessage[]	Pobiera wszystkie wersje robocze wiadomości.
getDrafts()	GmailDraft[]	Pobiera wszystkie wersje robocze wiadomości w Gmailu.
getInboxThreads()	GmailThread[]	Pobiera wszystkie wątki w usłudze Inbox niezależnie od etykiet.
getInboxThreads(start, max)	GmailThread[]	Pobiera zakres wątków w skrzynce odbiorczej niezależnie od etykiet.
getInboxUnreadCount()	Integer	Pobiera liczbę nieprzeczytanych wątków w skrzynce odbiorczej.
getMessageById(id)	GmailMessage	Pobiera wiadomość według identyfikatora.
getMessagesForThread(thread)	GmailMessage[]	Pobiera wszystkie wiadomości w określonym wątku.
getMessagesForThreads(threads)	GmailMessage[][]	Pobiera wszystkie wiadomości z określonych wątków.
getPriorityInboxThreads()	GmailThread[]	Pobiera wszystkie wątki ze skrzynki priorytetowej niezależnie od etykiet.
getPriorityInboxThreads(start, max)	GmailThread[]	Pobiera zakres wątków ze skrzynki odbiorczej Priorytety niezależnie od etykiet.
getPriorityInboxUnreadCount()	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 niezależnie od etykiet.
getSpamUnreadCount()	Integer	Pobiera liczbę nieprzeczytanych wątków, które są spamem.
getStarredThreads()	GmailThread[]	Pobiera wszystkie wątki z gwiazdką niezależnie od etykiet.
getStarredThreads(start, max)	GmailThread[]	Pobiera zakres wątków oznaczonych gwiazdką niezależnie od etykiet.
getStarredUnreadCount()	Integer	Zwraca liczbę nieprzeczytanych wątków oznaczonych gwiazdką.
getThreadById(id)	GmailThread|null	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ę na podstawie jej nazwy.
getUserLabels()	GmailLabel[]	Pobiera listę etykiet utworzonych przez użytkownika.
markMessageRead(message)	GmailApp	Oznacza tę wiadomość jako przeczytaną i wymusza jej odświeżenie.
markMessageUnread(message)	GmailApp	Oznacza tę wiadomość jako nieprzeczytaną i wymusza jej odświeżenie.
markMessagesRead(messages)	GmailApp	Oznacza te wiadomości jako przeczytane i wymusza ich odświeżenie.
markMessagesUnread(messages)	GmailApp	Oznacza te wiadomości jako nieprzeczytane i wymusza ich odświeżenie.
markThreadImportant(thread)	GmailApp	Oznacza ten wątek jako ważny i wymusza jego odświeżenie.
markThreadRead(thread)	GmailApp	Oznacza ten wątek jako przeczytany i wymusza jego odświeżenie.
markThreadUnimportant(thread)	GmailApp	Oznacza ten wątek jako nieważny i wymusza jego odświeżenie.
markThreadUnread(thread)	GmailApp	Oznacza ten 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 nieważne i wymusza ich odświeżenie;
markThreadsUnread(threads)	GmailApp	Oznacza te 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 odświeżenie wiadomości.
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 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	Ponownie wczytuje wiadomość i powiązany z nią stan z Gmaila (przydatne, jeśli zmieniły się etykiety, stan odczytu itp.).
refreshMessages(messages)	GmailApp	Ponownie wczytuje wiadomości i powiązany z nimi stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.).
refreshThread(thread)	GmailApp	Ponownie wczytuje wątek i powiązany z nim stan z Gmaila (przydatne, gdy zmieniły się etykiety, stan odczytu itp.).
refreshThreads(threads)	GmailApp	Ponownie wczytuje wątki i powiązany stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.).
search(query)	GmailThread[]	Wyszukaj w Gmailu podane zapytanie.
search(query, start, max)	GmailThread[]	Wyszukaj w Gmailu podane zapytanie.
sendEmail(recipient, subject, body)	GmailApp	Wysyła e-maila.
sendEmail(recipient, subject, body, options)	GmailApp	Wysyła e-maila z argumentami opcjonalnymi.
setCurrentMessageAccessToken(accessToken)	void	Ustawia token dostępu do bieżącej wiadomości, który umożliwia skryptowi dostęp do właściwości bieżącego GmailMessage.
starMessage(message)	GmailApp	Oznacza wiadomość gwiazdką i wymusza jej odświeżenie.
starMessages(messages)	GmailApp	Oznacza te wiadomości gwiazdkami i wymusza ich odświeżenie.
unstarMessage(message)	GmailApp	Usuwa gwiazdkę z tej wiadomości i wymusza jej odświeżenie.
unstarMessages(messages)	GmailApp	Usuwa gwiazdki z tych wiadomości i wymusza ich odświeżenie.

Wycofane metody

Metoda	Zwracany typ	Krótki opis
getChatThreads()	GmailThread[]	Pobiera wszystkie wątki klasycznej wersji Google Hangouts i Google Chat, dopóki Google nie przełączy wszystkich użytkowników klasycznej wersji Hangouts na Google Chat w dalszej części tego roku.
getChatThreads(start, max)	GmailThread[]	Pobiera zakres wątków z klasycznej wersji Google Hangouts i Google Chat, dopóki Google nie przełączy wszystkich użytkowników klasycznej wersji Hangouts na Chat w dalszej części tego roku.

Szczegółowa dokumentacja

createDraft(recipient, subject, body)

Tworzy wersję roboczą wiadomości e-mail. Rozmiar e-maila (wraz z nagłówkami) przekracza limit.

// The code below creates a draft email with the current date and time.
const 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	temat e-maila,
body	String	treść e-maila,

Powrót

GmailDraft – nowo utworzona wersja robocza Gmaila.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego 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)

---

createDraft(recipient, subject, body, options)

Tworzy wersję roboczą e-maila z argumentami opcjonalnymi. E-mail może zawierać zwykły tekst lub treść w formacie HTML. Rozmiar e-maila (wraz z nagłówkami, ale bez załączników) jest ograniczony limitem.

// Create a draft email with a file from Google Drive attached as a PDF.
const 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	adresy odbiorcy;
subject	String	temat,
body	String	treść e-maila,
options	Object	obiekt JavaScriptu, który określa parametry zaawansowane wymienione poniżej;

Parametry zaawansowane

Nazwa	Typ	Opis
attachments	BlobSource[]	tablicę plików do wysłania z e-mailem.
bcc	String	lista adresów e-mail do pola UDW rozdzielona przecinkami;
cc	String	lista adresów e-mail, na które należy wysłać kopię wiadomości, rozdzielona przecinkami;
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 ustawiony, urządzenia obsługujące HTML będą go używać zamiast wymaganego argumentu body; w treści HTML możesz dodać opcjonalne pole inlineImages, jeśli masz wstawione obrazy w e-mailu
inlineImages	Object	obiekt JavaScript zawierający mapowanie klucza obrazu (String) na dane obrazu (BlobSource); zakłada się, że używany jest parametr htmlBody, który 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 w Gmailu.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• createDraft(recipient, subject, body)

---

createLabel(name)

Utwórz nową etykietę użytkownika o podanej nazwie.

// Creates the label @FOO and logs label: FOO
Logger.log(`label: ${GmailApp.createLabel('FOO')}`);

Parametry

Nazwa	Typ	Opis
name	String	nazwę nowej etykiety;

Powrót

GmailLabel – nowo utworzona etykieta.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• deleteLabel(label)

---

deleteLabel(label)

Usuwa określoną etykietę.

// Have to get the label by name first
const label = GmailApp.getUserLabelByName('FOO');
GmailApp.deleteLabel(label);

Parametry

Nazwa	Typ	Opis
label	GmailLabel	etykieta do usunięcia;

Powrót

GmailApp – usługa Gmail, przydatna do łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• createLabel(name)

---

getAliases()

Pobiera listę adresów e-mail skonfigurowanych jako aliasy tego konta w Gmailu.

Możesz wysłać wiadomość z dowolnego z tych aliasów, używając opcjonalnego argumentu „from”.

// Log the aliases for this Gmail account and send an email as the first one.
const me = Session.getActiveUser().getEmail();
const 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 tego konta.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego 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)

---

getDraft(draftId)

Pobierz wersję roboczą wiadomości e-mail według identyfikatora.

Używaj tej metody w połączeniu z getId() w przypadku wersji roboczych Gmaila.

// Get the first draft message in your drafts folder
const draft = GmailApp.getDrafts()[0];
// Get its ID
const draftId = draft.getId();
// Now fetch the same draft using that ID.
const 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;

Rzuty

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

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego 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
const drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

Powrót

GmailMessage[] – tablica roboczych wiadomości Gmaila.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego 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 w Gmailu.

const drafts = GmailApp.getDrafts();
for (let i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

Powrót

GmailDraft[] – tablica wersji roboczych wiadomości w Gmailu.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

---

getInboxThreads()

Pobiera wszystkie wątki w usłudze Inbox niezależnie od etykiet.

To wywołanie zakończy się niepowodzeniem, gdy rozmiar wszystkich wątków będzie zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i może być bardzo duży, użyj wywołania „stronicowanego” i określ zakresy wątków do pobrania w każdym wywołaniu.

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

Powrót

GmailThread[] – tablica wątków Gmaila w skrzynce odbiorczej.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego 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 w skrzynce odbiorczej niezależnie od etykiet.

// Log the subject lines of up to the first 50 emails in your Inbox
const threads = GmailApp.getInboxThreads(0, 50);
for (let 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.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego 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.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego 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 metody w połączeniu z metodą getId() w przypadku wiadomości Gmaila.

// Get the first message in the first thread of your inbox
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
const messageId = message.getId();
// Now fetch the same message using that ID.
const 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 – komunikat o podanym identyfikatorze.

Rzuty

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

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• getThreadById(id)

---

getMessagesForThread(thread)

Pobiera wszystkie wiadomości w określonym wątku.

// Log all the subject lines in the first thread of your inbox
const thread = GmailApp.getInboxThreads(0, 1)[0];
const messages = GmailApp.getMessagesForThread(thread);
for (let 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ątkowi.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• getMessagesForThreads(threads)

---

getMessagesForThreads(threads)

Pobiera wszystkie wiadomości z określonych wątków.

// Log the subject lines of all messages in the first two threads of your inbox
const thread = GmailApp.getInboxThreads(0, 2);
const messages = GmailApp.getMessagesForThreads(thread);
for (let i = 0; i < messages.length; i++) {
  for (let 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 tablicy zewnętrznej odpowiada wątkowi, a tablica wewnętrzna zawiera wiadomości w tym wątku.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• getMessagesForThread(thread)

---

getPriorityInboxThreads()

Pobiera wszystkie wątki ze skrzynki priorytetowej niezależnie od etykiet.

To wywołanie zakończy się niepowodzeniem, gdy rozmiar wszystkich wątków będzie zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i może być bardzo duży, użyj wywołania „stronicowanego” 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 skrzynce Priorytety.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego 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 ze skrzynki odbiorczej Priorytety 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 skrzynce Priorytety.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego 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 skrzynce priorytetowej, które zawierają nieprzeczytane wiadomości.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

---

getSpamThreads()

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

To wywołanie zakończy się niepowodzeniem, gdy rozmiar wszystkich wątków będzie zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i może być bardzo duży, użyj wywołania „stronicowanego” 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 Gmaila w folderze ze spamem.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

---

getSpamThreads(start, max)

Pobiera zakres wątków spamu 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 Gmaila w folderze ze spamem.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego 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 spamu, które zawierają nieprzeczytane wiadomości.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

---

getStarredThreads()

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

To wywołanie zakończy się niepowodzeniem, gdy rozmiar wszystkich wątków będzie zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i może być bardzo duży, użyj wywołania „stronicowanego” 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 Gmaila oznaczonych gwiazdką.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego 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 Gmaila oznaczonych gwiazdką.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

---

getStarredUnreadCount()

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

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego 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 metody 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|null – wątek o podanym identyfikatorze lub null, jeśli nie został znaleziony.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• getMessageById(id)

---

getTrashThreads()

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

To wywołanie zakończy się niepowodzeniem, gdy rozmiar wszystkich wątków będzie zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i może być bardzo duży, użyj wywołania „stronicowanego” 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.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego 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.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

---

getUserLabelByName(name)

Pobiera etykietę na podstawie jej nazwy.

const labelObject = GmailApp.getUserLabelByName('myLabel');

Parametry

Nazwa	Typ	Opis
name	String	nazwa etykiety do pobrania;

Powrót

GmailLabel – etykieta Gmaila o podanej nazwie.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego 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
const labels = GmailApp.getUserLabels();
for (let i = 0; i < labels.length; i++) {
  Logger.log(`label: ${labels[i].getName()}`);
}

Powrót

GmailLabel[] – tablica etykiet utworzonych przez użytkownika.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

---

markMessageRead(message)

Oznacza tę wiadomość jako przeczytaną i wymusza jej odświeżenie.

// Mark the first message in the first thread of your inbox as read
const 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 łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• markMessageUnread(message)

---

markMessageUnread(message)

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

// Mark the first message in the first thread of your inbox as unread
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

Parametry

Nazwa	Typ	Opis
message	GmailMessage	wiadomość, którą chcesz oznaczyć jako nieprzeczytaną;

Powrót

GmailApp – usługa Gmail, przydatna do łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu 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.
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(messages);

Parametry

Nazwa	Typ	Opis
messages	GmailMessage[]	tablica wiadomości do oznaczenia jako przeczytane;

Powrót

GmailApp – usługa Gmail, przydatna do łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• markMessagesUnread(messages)

---

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
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(messages);

Parametry

Nazwa	Typ	Opis
messages	GmailMessage[]	tablica wiadomości do oznaczenia jako nieprzeczytanych;

Powrót

GmailApp – usługa Gmail, przydatna do łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• markMessagesRead(messages)

---

markThreadImportant(thread)

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

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

Parametry

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

Powrót

GmailApp – usługa Gmail, przydatna do łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• markThreadUnimportant(thread)

---

markThreadRead(thread)

Oznacza ten wątek jako przeczytany i wymusza jego odświeżenie.

// Marks first inbox thread as read
const 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 łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• markThreadUnread(thread)

---

markThreadUnimportant(thread)

Oznacza ten wątek jako nieważny i wymusza jego odświeżenie.

// Marks first inbox thread as unimportant
const 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 łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• markThreadImportant(thread)

---

markThreadUnread(thread)

Oznacza ten wątek jako nieprzeczytany i wymusza jego odświeżenie.

// Marks first inbox thread as unread
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnread(thread);

Parametry

Nazwa	Typ	Opis
thread	GmailThread	wątek do oznaczenia jako nieprzeczytany;

Powrót

GmailApp – usługa Gmail, przydatna do łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu 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
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

Parametry

Nazwa	Typ	Opis
threads	GmailThread[]	tablica wątków do oznaczenia jako ważne;

Powrót

GmailApp – usługa Gmail, przydatna do łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu 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
const 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 łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• markThreadsUnread(threads)

---

markThreadsUnimportant(threads)

oznacza te wątki jako nieważne i wymusza ich odświeżenie;

// Marks first two threads in inbox as unimportant
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnimportant(threads);

Parametry

Nazwa	Typ	Opis
threads	GmailThread[]	tablica wątków do oznaczenia jako nieważne;

Powrót

GmailApp – usługa Gmail, przydatna do łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• markThreadsImportant(threads)

---

markThreadsUnread(threads)

Oznacza te wątki jako nieprzeczytane i wymusza ich odświeżenie.

// Marks first two threads in inbox as unread
const 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 łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• markThreadsRead(threads)

---

moveMessageToTrash(message)

Przenosi wiadomość do kosza i wymusza jej odświeżenie.

// Move the first message in your inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

Parametry

Nazwa	Typ	Opis
message	GmailMessage	wiadomość, którą chcesz przenieść do kosza;

Powrót

GmailApp – usługa Gmail (przydatna do łączenia).

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• moveMessagesToTrash(messages)

---

moveMessagesToTrash(messages)

Przenosi określone wiadomości do kosza i wymusza odświeżenie wiadomości.

// Move first two messages in your inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const messages = firstThread.getMessages();
const 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 do łączenia).

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• moveMessageToTrash(message)

---

moveThreadToArchive(thread)

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

// Archive the first thread in your inbox
const 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 łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu 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 jego odświeżenie.

// Find a thread not already in your inbox
const 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;

Powrót

GmailApp – usługa Gmail, przydatna do łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

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

---

moveThreadToSpam(thread)

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

// Tag first thread in inbox as spam
const 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 łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

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

---

moveThreadToTrash(thread)

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

// Move first thread in inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToTrash(firstThread);

Parametry

Nazwa	Typ	Opis
thread	GmailThread	wątek do przeniesienia do kosza;

Powrót

GmailApp – usługa Gmail, przydatna do łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

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

---

moveThreadsToArchive(threads)

Przenosi te wątki do archiwum i wymusza ich odświeżenie.

// Move first two threads in your inbox to the archive
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToArchive(firstTwoThreads);

Parametry

Nazwa	Typ	Opis
threads	GmailThread[]	tablica wątków do zarchiwizowania.

Powrót

GmailApp – usługa Gmail, przydatna do łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu 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 ich odświeżenie.

// Find two threads not already in your inbox
const 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 łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

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

---

moveThreadsToSpam(threads)

Przenosi te wątki do spamu i wymusza ich odświeżenie.

// Move first two threads in your inbox to spam
const 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 łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu 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
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

Parametry

Nazwa	Typ	Opis
threads	GmailThread[]	tablica wątków do przeniesienia do kosza;

Powrót

GmailApp – usługa Gmail, przydatna do łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

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

---

refreshMessage(message)

Ponownie wczytuje wiadomość i powiązany z nią stan z Gmaila (przydatne, jeśli zmieniły się etykiety, stan odczytu itp.).

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• refreshMessages(messages)

---

refreshMessages(messages)

Ponownie wczytuje wiadomości i powiązany z nimi stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.).

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• refreshMessage(message)

---

refreshThread(thread)

Ponownie wczytuje wątek i powiązany z nim stan z Gmaila (przydatne, gdy zmieniły się etykiety, stan odczytu itp.).

const 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 łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• refreshThreads(threads)

---

refreshThreads(threads)

Ponownie wczytuje wątki i powiązany stan z Gmaila (przydatne w przypadku zmiany etykiet, stanu odczytu itp.).

const 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 łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• refreshThread(thread)

---

search(query)

Wyszukaj w Gmailu podane zapytanie.

To wywołanie zakończy się niepowodzeniem, gdy rozmiar wszystkich wątków będzie zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i może być bardzo duży, użyj wywołania „stronicowanego” i określ zakresy wątków do pobrania w każdym wywołaniu.

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

Parametry

Nazwa	Typ	Opis
query	String	zapytanie wyszukiwania, tak jak wpisujesz je w Gmailu;

Powrót

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

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego 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 podane 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.
const threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

Parametry

Nazwa	Typ	Opis
query	String	zapytanie wyszukiwania, tak jak wpisujesz je w Gmailu;
start	Integer	indeks wątku początkowego,
max	Integer	maksymalna liczba wątków do zwrócenia;

Powrót

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

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego 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) przekracza limit.

// The code below will send an email with the current date and time.
const 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,

Powrót

GmailApp – usługa Gmail, przydatna do łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego 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)

---

sendEmail(recipient, subject, body, options)

Wysyła e-maila z argumentami opcjonalnymi. E-mail może zawierać zwykły tekst lub treść w formacie HTML. Rozmiar e-maila (wraz z nagłówkami, ale bez załączników) jest ograniczony limitem.

// Send an email with a file from Google Drive attached as a PDF.
const 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	adresy odbiorcy;
subject	String	wiersz tematu (maksymalnie 250 znaków);
body	String	treść e-maila,
options	Object	obiekt JavaScriptu, który określa parametry zaawansowane wymienione poniżej;

Parametry zaawansowane

Nazwa	Typ	Opis
attachments	BlobSource[]	tablicę plików do wysłania z e-mailem.
bcc	String	lista adresów e-mail do pola UDW rozdzielona przecinkami;
cc	String	lista adresów e-mail, na które należy wysłać kopię wiadomości, rozdzielona przecinkami;
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 ustawiony, urządzenia obsługujące HTML będą go używać zamiast wymaganego argumentu body; w treści HTML możesz dodać opcjonalne pole inlineImages, jeśli masz wstawione obrazy w e-mailu
inlineImages	Object	obiekt JavaScript zawierający mapowanie klucza obrazu (String) na dane obrazu (BlobSource); zakłada się, że używany jest parametr htmlBody, który 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 czy e-mail powinien być wysyłany z ogólnego adresu e-mail, na który nie można odpowiadać, aby zniechęcić odbiorców do odpowiadania na e-maile; ta opcja jest dostępna tylko w przypadku kont Google Workspace, a nie 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 łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• sendEmail(recipient, subject, body)

---

setCurrentMessageAccessToken(accessToken)

Ustawia token dostępu do bieżącej wiadomości, który umożliwia skryptowi dostęp do właściwości bieżącego GmailMessage.

Tego sposobu wymagają tylko projekty dodatków do Google Workspace, które korzystają z zakresów bieżącej wiadomości w Gmailu.

function handleAddonActionEvent(e) {
  GmailApp.setCurrentMessageAccessToken(e.messageMetadata.accessToken);
  const mailMessage = GmailApp.getMessageById(e.messageMetadata.messageId);
  // Do something with mailMessage
}

Parametry

Nazwa	Typ	Opis
accessToken	String	tymczasowy token dostępu uzyskany z obiektu zdarzenia działania Dodatku w Gmailu.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

---

starMessage(message)

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

// Stars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

Parametry

Nazwa	Typ	Opis
message	GmailMessage	wiadomość, którą chcesz oznaczyć gwiazdką;

Powrót

GmailApp – usługa Gmail, przydatna do łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• starMessages(messages)

---

starMessages(messages)

Oznacza te wiadomości gwiazdkami i wymusza ich odświeżenie.

// Stars the first three messages in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• starMessage(message)

---

unstarMessage(message)

Usuwa gwiazdkę z tej wiadomości i wymusza jej odświeżenie.

// Unstars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

Parametry

Nazwa	Typ	Opis
message	GmailMessage	wiadomość, z której chcesz usunąć oznaczenie gwiazdką;

Powrót

GmailApp – usługa Gmail, przydatna do łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• unstarMessages(messages)

---

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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

Parametry

Nazwa	Typ	Opis
messages	GmailMessage[]	tablica wiadomości, z których chcesz usunąć oznaczenie gwiazdką;

Powrót

GmailApp – usługa Gmail, przydatna do łączenia w łańcuch

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• unstarMessage(message)

Wycofane metody

getChatThreads()

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

Pobiera wszystkie wątki klasycznej wersji Google Hangouts i Google Chat, dopóki Google nie przełączy wszystkich użytkowników klasycznej wersji Hangouts na Google Chat w dalszej części tego roku. Więcej informacji znajdziesz w artykule Więcej informacji o przechodzeniu 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 może być bardzo duży, użyj wywołania „stronicowanego” i określ zakresy wątków do pobrania w każdym wywołaniu.

const threads = GmailApp.getChatThreads();
Logger.log(`# of chat threads: ${threads.length}`);

Powrót

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

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

---

getChatThreads(start, max)

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

Pobiera zakres wątków z klasycznej wersji Google Hangouts i Google Chat, dopóki Google nie przełączy wszystkich użytkowników klasycznej wersji Hangouts na Chat w dalszej części tego roku. Więcej informacji znajdziesz w artykule Więcej informacji o przechodzeniu z klasycznej wersji Hangouts na Google Chat.

// Get first 50 chat threads
const 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;

Powrót

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

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/