Class GmailApp

GmailApp

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

Metody

MetodaZwracany typKrótki opis
createDraft(recipient, subject, body)GmailDraftTworzy wersję roboczą e-maila.
createDraft(recipient, subject, body, options)GmailDraftTworzy wersję roboczą e-maila z opcjonalnymi argumentami.
createLabel(name)GmailLabelUtwórz nową etykietę użytkownika z podaną nazwą.
deleteLabel(label)GmailAppUsuwa określoną etykietę.
getAliases()String[]Pobiera listę e-maili skonfigurowanych jako aliasy tego konta w Gmailu.
getDraft(draftId)GmailDraftPobierz 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 ze skrzynki odbiorczej niezależnie od etykiet.
getInboxUnreadCount()IntegerPobiera liczbę nieprzeczytanych wątków w skrzynce odbiorczej.
getMessageById(id)GmailMessagePobiera wiadomość według identyfikatora.
getMessagesForThread(thread)GmailMessage[]Pobierz wszystkie wiadomości z określonego wątku.
getMessagesForThreads(threads)GmailMessage[][]Pobierz wszystkie wiadomości z określonych wątków.
getPriorityInboxThreads()GmailThread[]Pobiera wszystkie wątki w Priorytetach niezależnie od etykiet.
getPriorityInboxThreads(start, max)GmailThread[]Pobiera zakres wątków ze skrzynki odbiorczej Priorytety niezależnie od etykiet.
getPriorityInboxUnreadCount()IntegerPobiera liczbę nieprzeczytanych wątków w Priorytetach.
getSpamThreads()GmailThread[]Pobiera wszystkie wątki ze spamem niezależnie od etykiet.
getSpamThreads(start, max)GmailThread[]Pobiera zakres wątków spamu niezależnie od etykiet.
getSpamUnreadCount()IntegerPobiera liczbę nieprzeczytanych wątków, które są spamem.
getStarredThreads()GmailThread[]Pobiera wszystkie wątki oznaczone gwiazdką niezależnie od etykiet.
getStarredThreads(start, max)GmailThread[]Pobiera zakres wątków oznaczonych gwiazdką niezależnie od etykiet.
getStarredUnreadCount()IntegerPobiera liczbę nieprzeczytanych wątków oznaczonych gwiazdką.
getThreadById(id)GmailThreadPobiera 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)GmailLabelPobiera etykietę o nazwie.
getUserLabels()GmailLabel[]Pobiera listę etykiet utworzonych przez użytkowników.
markMessageRead(message)GmailAppOznacza wiadomość jako przeczytaną i wymusza jej odświeżenie.
markMessageUnread(message)GmailAppOznacza tę wiadomość jako nieprzeczytaną i wymusza jej odświeżenie.
markMessagesRead(messages)GmailAppOznacza te wiadomości jako przeczytane i wymusza ich odświeżenie.
markMessagesUnread(messages)GmailAppOznacza te wiadomości jako nieprzeczytane i wymusza ich odświeżenie.
markThreadImportant(thread)GmailAppOznacza wątek jako ważny i wymusza jego odświeżenie.
markThreadRead(thread)GmailAppOznacza wątek jako przeczytany i wymusza jego odświeżenie.
markThreadUnimportant(thread)GmailAppOznacza wątek jako nieważny i wymusza jego odświeżenie.
markThreadUnread(thread)GmailAppOznacza wątek jako nieprzeczytany i wymusza jego odświeżenie.
markThreadsImportant(threads)GmailAppOznacza te wątki jako ważne i wymusza ich odświeżenie.
markThreadsRead(threads)GmailAppOznacza te wątki jako przeczytane i wymusza ich odświeżenie.
markThreadsUnimportant(threads)GmailAppOznacza wątki jako nieważne i wymusza ich odświeżenie.
markThreadsUnread(threads)GmailAppOznacza te wątki jako nieprzeczytane i wymusza ich odświeżenie.
moveMessageToTrash(message)GmailAppPrzenosi wiadomość do kosza i wymusza jej odświeżenie.
moveMessagesToTrash(messages)GmailAppPrzenosi określone wiadomości do kosza i wymusza ich odświeżenie.
moveThreadToArchive(thread)GmailAppPrzenosi ten wątek do archiwum i wymusza jego odświeżenie.
moveThreadToInbox(thread)GmailAppPrzenosi ten wątek do skrzynki odbiorczej i wymusza jego odświeżenie.
moveThreadToSpam(thread)GmailAppPrzenosi ten wątek do spamu i wymusza jego odświeżenie.
moveThreadToTrash(thread)GmailAppPrzenosi ten wątek do kosza i wymusza jego odświeżenie.
moveThreadsToArchive(threads)GmailAppPrzenosi te wątki do archiwum i wymusza ich odświeżenie.
moveThreadsToInbox(threads)GmailAppPowoduje przeniesienie tych wątków do skrzynki odbiorczej i wymusza ich odświeżenie.
moveThreadsToSpam(threads)GmailAppPrzenosi te wątki do spamu i wymusza ich odświeżenie.
moveThreadsToTrash(threads)GmailAppPowoduje przeniesienie tych wątków do kosza i wymusza ich odświeżenie.
refreshMessage(message)GmailAppPonownie wczytuje wiadomość i powiązany z nią stan z Gmaila (przydatne w przypadku, gdy etykiety, stan odczytu itp., uległy zmianie).
refreshMessages(messages)GmailAppPonownie wczytuje wiadomości i powiązany stan z Gmaila (przydatne w przypadku, gdy etykiety, stan odczytu itp., uległy zmianie).
refreshThread(thread)GmailAppPonownie wczytuje wątek i powiązany stan z Gmaila (przydatne w przypadku, gdy etykiety, stan odczytu itp., uległy zmianie).
refreshThreads(threads)GmailAppPonownie wczytuje wątki i powiązane stany z Gmaila (przydatne, gdy etykiety, stan odczytu itp., uległy zmianie).
search(query)GmailThread[]Wyszukaj w Gmailu dane zapytanie.
search(query, start, max)GmailThread[]Wyszukaj w Gmailu dane zapytanie.
sendEmail(recipient, subject, body)GmailAppWysyła e-maila.
sendEmail(recipient, subject, body, options)GmailAppWysyła e-maila z opcjonalnymi argumentami.
setCurrentMessageAccessToken(accessToken)voidUstawia bieżącą wiadomość token dostępu, który umożliwia skryptowi dostęp do bieżących właściwości GmailMessage.
starMessage(message)GmailAppDodaje gwiazdkę do wiadomości i wymusza jej odświeżenie.
starMessages(messages)GmailAppOznacza te wiadomości gwiazdką i wymusza ich odświeżenie.
unstarMessage(message)GmailAppUsuwa gwiazdkę z wiadomości i wymusza jej odświeżenie.
unstarMessages(messages)GmailAppUsuwa gwiazdki z tych wiadomości i wymusza ich odświeżenie.

Szczegółowa dokumentacja

createDraft(recipient, subject, body)

Tworzy wersję roboczą e-maila. Rozmiar e-maila (wraz z nagłówkami) jest ograniczony.

// The code below creates a draft email with the current date and time.
var now = new Date();
GmailApp.createDraft("mike@example.com", "current time", "The time is: " + now.toString());

Parametry

NazwaTypOpis
recipientStringrozdzielana przecinkami lista adresów e-mail
subjectStringtemat e-maila
bodyStringtreść e-maila

Powrót

GmailDraft – nowo utworzona wersja robocza Gmaila

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


createDraft(recipient, subject, body, options)

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

// Create a draft email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft('mike@example.com', 'Attachment example', 'Please see attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Parametry

NazwaTypOpis
recipientStringadresy odbiorcy,
subjectStringwiersz tematu
bodyStringtreść e-maila
optionsObjectobiekt JavaScript, który określa zaawansowane parametry, jak pokazano poniżej.

Parametry zaawansowane

NazwaTypOpis
attachmentsBlobSource[] tablica plików do wysłania e-mailem
bccStringrozdzielana przecinkami lista adresów e-mail do pola UDW
ccStringrozdzielana przecinkami lista adresów e-mail, na które należy wysłać kopie wiadomości
fromStringadres, z którego ma zostać wysłany e-mail (musi to być jeden z nich) wartości zwróconych przez funkcję getAliases()
htmlBodyStringJeśli jest ustawiony, będą go używać urządzenia, które potrafią renderować kod HTML wymaganego argumentu body; opcjonalne pole inlineImages można dodać w kodzie HTML treść, jeśli e-mail zawiera obrazy w tekście.
inlineImagesObjectobiekt JavaScript zawierający mapowanie z klucza obrazu (String) do danych zdjęcia (BlobSource); przy założeniu, że używany jest parametr htmlBody, który zawiera odwołania do tych obrazów w formacie <img src="cid:imageKey" />
nameStringnazwa nadawcy e-maila (domyślnie jest to nazwa użytkownika);
replyToStringadres e-mail, który ma być używany jako domyślny adres zwrotny (domyślnie: adres e-mail użytkownika)

Powrót

GmailDraft – nowo utworzona wersja robocza Gmaila

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


createLabel(name)

Utwórz nową etykietę użytkownika z podaną nazwą.

// Creates the label @FOO and logs label: FOO
Logger.log("label: " + GmailApp.createLabel("FOO"));

Parametry

NazwaTypOpis
nameStringnazwa nowej etykiety

Powrót

GmailLabel – nowo utworzona etykieta,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


deleteLabel(label)

Usuwa określoną etykietę.

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

Parametry

NazwaTypOpis
labelGmailLabeletykieta do usunięcia

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


getAliases()

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

Aby wysłać wiadomość z dowolnego z tych aliasów, użyj pola „Od” opcjonalny.

// Log the aliases for this Gmail account and send an email as the first one.
var me = Session.getActiveUser().getEmail();
var aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {'from': aliases[0]});
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

Powrót

String[] – tablica aliasów tego konta.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


getDraft(draftId)

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

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

NazwaTypOpis
draftIdStringidentyfikator 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 korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

getDraftMessages()

Pobiera wszystkie wersje robocze wiadomości.

// Logs the number of draft messages
var drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

Powrót

GmailMessage[] – tablica wersji roboczych wiadomości w Gmailu

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

getDrafts()

Pobiera wszystkie wersje robocze wiadomości z Gmaila.

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

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu 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 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, należy użyć atrybutu „paged” połączenia i określać zakresy wątków do pobrania w przypadku każdego wywołania.

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

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

getInboxThreads(start, max)

Pobiera zakres wątków ze skrzynki odbiorczej niezależnie od etykiet.

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

Parametry

NazwaTypOpis
startIntegerindeks pierwszego wątku do pobrania
maxIntegermaksymalna liczba wątków do pobrania

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami 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 korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

getMessageById(id)

Pobiera wiadomość według identyfikatora.

Używaj tej funkcji w połączeniu z funkcją getId() w przypadku wiadomości 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

NazwaTypOpis
idStringidentyfikator wiadomości do pobrania

Powrót

GmailMessage – wiadomość o podanym identyfikatorze,

Rzuty

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


getMessagesForThread(thread)

Pobierz wszystkie wiadomości z określonego 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

NazwaTypOpis
threadGmailThreadwątek wiadomości do pobrania

Powrót

GmailMessage[] – tablica wiadomości odpowiadających temu wątkowi

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


getMessagesForThreads(threads)

Pobierz wszystkie 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

NazwaTypOpis
threadsGmailThread[]wątki wiadomości do pobrania

Powrót

GmailMessage[][] – tablica tablic komunikatów, gdzie każdy element tablicy zewnętrznej odpowiada , a tablica wewnętrzna zawiera wiadomości w tym wątku

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


getPriorityInboxThreads()

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

To wywołanie nie powiedzie się, gdy rozmiar wszystkich wątków będzie zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i może być bardzo duży, należy użyć atrybutu „paged” połączenia i określać zakresy wątków do pobrania w przypadku każdego wywołania.

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

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami 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

NazwaTypOpis
startIntegerindeks pierwszego wątku do pobrania
maxIntegermaksymalna liczba wątków do pobrania

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

getPriorityInboxUnreadCount()

Pobiera liczbę nieprzeczytanych wątków w Priorytetach.

Logger.log("Number of unread emails in your Priority Inbox : " +
           GmailApp.getPriorityInboxUnreadCount());

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

getSpamThreads()

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

To wywołanie nie powiedzie się, gdy rozmiar wszystkich wątków będzie zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i może być bardzo duży, należy użyć atrybutu „paged” połączenia i określać zakresy wątków do pobrania w przypadku każdego wywołania.

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

Powrót

GmailThread[] – tablica wątków Gmaila w folderze spamu

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami 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

NazwaTypOpis
startIntegerindeks pierwszego wątku do pobrania
maxIntegermaksymalna liczba wątków do pobrania

Powrót

GmailThread[] – tablica wątków Gmaila w folderze spamu

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

getSpamUnreadCount()

Pobiera liczbę nieprzeczytanych wątków, które są spamem.

// Unless you actually read stuff in your spam folder, this should be the same as
// the number of messages in your spam folder.
Logger.log("# unread threads that are spam: " + GmailApp.getSpamUnreadCount());

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

getStarredThreads()

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

To wywołanie nie powiedzie się, gdy rozmiar wszystkich wątków będzie zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i może być bardzo duży, należy użyć atrybutu „paged” połączenia i określać zakresy wątków do pobrania w przypadku każdego wywołania.

// 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 korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami 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

NazwaTypOpis
startIntegerindeks pierwszego wątku do pobrania
maxIntegermaksymalna liczba wątków do pobrania

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

getStarredUnreadCount()

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

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

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

getThreadById(id)

Pobiera wątek według identyfikatora.

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

NazwaTypOpis
idStringIdentyfikator wątku do pobrania.

Powrót

GmailThread – wątek o podanym identyfikatorze lub null, jeśli nie został znaleziony.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


getTrashThreads()

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

To wywołanie nie powiedzie się, gdy rozmiar wszystkich wątków będzie zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i może być bardzo duży, należy użyć atrybutu „paged” połączenia i określać zakresy wątków do pobrania w przypadku każdego wywołania.

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

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu 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

NazwaTypOpis
startIntegerindeks pierwszego wątku do pobrania
maxIntegermaksymalna liczba wątków do pobrania

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

getUserLabelByName(name)

Pobiera etykietę o nazwie.

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

Parametry

NazwaTypOpis
nameStringnazwa etykiety do pobrania

Powrót

GmailLabel – etykieta Gmaila o podanej nazwie.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu 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());
}

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

markMessageRead(message)

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

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

Parametry

NazwaTypOpis
messageGmailMessagewiadomość, którą chcesz oznaczyć jako przeczytaną

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


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
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

Parametry

NazwaTypOpis
messageGmailMessagewiadomość, którą chcesz oznaczyć jako nieprzeczytaną

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


markMessagesRead(messages)

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

// Mark first three messages in the first inbox thread as read.
// Assumes that the first inbox thread has 3 messages in it.
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(thread.getMessages());

Parametry

NazwaTypOpis
messagesGmailMessage[]tablica wiadomości do oznaczenia jako przeczytane

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


markMessagesUnread(messages)

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

// Mark first three messages in the first inbox thread as unread.
// Assumes that the first inbox thread has 3 messages in it
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(thread.getMessages());

Parametry

NazwaTypOpis
messagesGmailMessage[]tablica wiadomości do oznaczenia jako nieprzeczytane

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


markThreadImportant(thread)

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

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

Parametry

NazwaTypOpis
threadGmailThreadzaznacz wątek jako ważny

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


markThreadRead(thread)

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

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

Parametry

NazwaTypOpis
threadGmailThreadwątek do oznaczenia jako przeczytany

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


markThreadUnimportant(thread)

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

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

Parametry

NazwaTypOpis
threadGmailThreadwątek do oznaczenia jako nieważny

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


markThreadUnread(thread)

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

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

Parametry

NazwaTypOpis
threadGmailThreadwątek do oznaczenia jako nieprzeczytany

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


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

NazwaTypOpis
threadsGmailThread[]tablica wątków do oznaczenia jako ważne

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


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

NazwaTypOpis
threadsGmailThread[]tablica wątków do oznaczenia jako przeczytane

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


markThreadsUnimportant(threads)

Oznacza wątki jako nieważne i wymusza ich odświeżenie.

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

Parametry

NazwaTypOpis
threadsGmailThread[]tablica wątków do oznaczenia jako nieważne

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


markThreadsUnread(threads)

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

// Marks first two threads in inbox as unread
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnread(threads);

Parametry

NazwaTypOpis
threadsGmailThread[]tablica wątków do oznaczenia jako nieprzeczytane

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


moveMessageToTrash(message)

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

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

Parametry

NazwaTypOpis
messageGmailMessagewiadomość do usunięcia

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


moveMessagesToTrash(messages)

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

// Move first two messages in your inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var messages = firstThread.getMessages();
var toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

Parametry

NazwaTypOpis
messagesGmailMessage[]wiadomości do usunięcia

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


moveThreadToArchive(thread)

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

// Archive the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToArchive(firstThread);

Parametry

NazwaTypOpis
threadGmailThreadwątek do zarchiwizowania

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


moveThreadToInbox(thread)

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

// Find a thread not already in your inbox
var thread = GmailApp.search("-in:inbox")[0]; // Get the first one
GmailApp.moveThreadToInbox(thread);

Parametry

NazwaTypOpis
threadGmailThreadwątek do przeniesienia do skrzynki odbiorczej

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


moveThreadToSpam(thread)

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

// Tag first thread in inbox as spam
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToSpam(firstThread);

Parametry

NazwaTypOpis
threadGmailThreadprzeniesienie wątku do spamu

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


moveThreadToTrash(thread)

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

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

Parametry

NazwaTypOpis
threadGmailThreadwątek do usunięcia do kosza

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


moveThreadsToArchive(threads)

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

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

Parametry

NazwaTypOpis
threadsGmailThread[]tablica wątków do zarchiwizowania

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


moveThreadsToInbox(threads)

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

// Find two threads not already in your inbox
var firstTwoThreads = GmailApp.search("-in:inbox", 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

Parametry

NazwaTypOpis
threadsGmailThread[]tablica wątków do przeniesienia do skrzynki odbiorczej

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


moveThreadsToSpam(threads)

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

// Move first two threads in your inbox to spam
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToSpam(firstTwoThreads);

Parametry

NazwaTypOpis
threadsGmailThread[]tablica wątków do przeniesienia do spamu

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


moveThreadsToTrash(threads)

Powoduje przeniesienie tych wątków 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

NazwaTypOpis
threadsGmailThread[]tablicę wątków do usunięcia do kosza

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


refreshMessage(message)

Ponownie wczytuje wiadomość i powiązany z nią stan z Gmaila (przydatne w przypadku, gdy etykiety, stan odczytu itp., uległy zmianie).

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

NazwaTypOpis
messageGmailMessagewiadomość do odświeżenia

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


refreshMessages(messages)

Ponownie wczytuje wiadomości i powiązany stan z Gmaila (przydatne w przypadku, gdy etykiety, stan odczytu itp., uległy zmianie).

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

NazwaTypOpis
messagesGmailMessage[]wiadomości do odświeżenia,

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


refreshThread(thread)

Ponownie wczytuje wątek i powiązany stan z Gmaila (przydatne w przypadku, gdy etykiety, stan odczytu itp., uległy zmianie).

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

NazwaTypOpis
threadGmailThreadwątek do odświeżenia

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


refreshThreads(threads)

Ponownie wczytuje wątki i powiązane stany z Gmaila (przydatne, gdy etykiety, stan odczytu itp., uległy zmianie).

var threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

Parametry

NazwaTypOpis
threadsGmailThread[]wątki do odświeżenia

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


search(query)

Wyszukaj w Gmailu dane zapytanie.

To wywołanie nie powiedzie się, gdy rozmiar wszystkich wątków będzie zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i może być bardzo duży, należy użyć atrybutu „paged” połączenia i określać zakresy wątków do pobrania w przypadku każdego wywołania.

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

Parametry

NazwaTypOpis
queryStringzapytanie, tak jak w przypadku wpisywania go w Gmailu.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

search(query, start, max)

Wyszukaj w Gmailu dane zapytanie.

// Find starred messages with subject IMPORTANT and return second batch of 10.
// Assumes there are at least 11 of them, otherwise this will return an empty array.
var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

Parametry

NazwaTypOpis
queryStringzapytanie, tak jak w przypadku wpisywania go w Gmailu.
startIntegerindeks wątku początkowego
maxIntegermaksymalna liczba wątków do zwrócenia

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

sendEmail(recipient, subject, body)

Wysyła e-maila. Rozmiar e-maila (wraz z nagłówkami) jest ograniczony.

// The code below will send an email with the current date and time.
var now = new Date();
GmailApp.sendEmail("mike@example.com", "current time", "The time is: " + now.toString());

Parametry

NazwaTypOpis
recipientStringrozdzielana przecinkami lista adresów e-mail
subjectStringtemat e-maila (maksymalnie 250 znaków)
bodyStringtreść e-maila

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


sendEmail(recipient, subject, body, options)

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

// Send an email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail('mike@example.com', 'Attachment example', 'Please see the attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Parametry

NazwaTypOpis
recipientStringadresy odbiorcy,
subjectStringwiersz tematu (maksymalnie 250 znaków)
bodyStringtreść e-maila
optionsObjectobiekt JavaScript, który określa zaawansowane parametry, jak pokazano poniżej.

Parametry zaawansowane

NazwaTypOpis
attachmentsBlobSource[] tablica plików do wysłania e-mailem
bccStringrozdzielana przecinkami lista adresów e-mail do pola UDW
ccStringrozdzielana przecinkami lista adresów e-mail, na które należy wysłać kopie wiadomości
fromStringadres, z którego ma zostać wysłany e-mail (musi to być jeden z nich) wartości zwróconych przez funkcję getAliases()
htmlBodyStringJeśli jest ustawiony, będą go używać urządzenia, które potrafią renderować kod HTML wymaganego argumentu body; opcjonalne pole inlineImages można dodać w kodzie HTML treść, jeśli e-mail zawiera obrazy w tekście.
inlineImagesObjectobiekt JavaScript zawierający mapowanie z klucza obrazu (String) do danych zdjęcia (BlobSource); przy założeniu, że używany jest parametr htmlBody, który zawiera odwołania do tych obrazów w formacie <img src="cid:imageKey" />
nameStringnazwa nadawcy e-maila (domyślnie jest to nazwa użytkownika);
noReplyBooleantrue, jeśli e-mail ma być wysłany z ogólnego adresu adres e-mail używany tylko do wysyłania e-maili, który zniechęca odbiorców do odpowiadania na e-maile; ta opcja jest jest to możliwe tylko na kontach Google Workspace, nie na kontach użytkowników Gmaila.
replyToStringadres 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, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


setCurrentMessageAccessToken(accessToken)

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

Tylko projekty z dodatkiem Google Workspace korzystające z bieżących zakresów wiadomości Gmaila wymaga tej metody.

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

NazwaTypOpis
accessTokenStringtymczasowy token dostępu uzyskany z obiektu zdarzenia działania dodatku Gmail.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

starMessage(message)

Dodaje gwiazdkę do wiadomości i wymusza jej odświeżenie.

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

NazwaTypOpis
messageGmailMessagewiadomość do oznaczenia gwiazdką

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


starMessages(messages)

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

// Stars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

Parametry

NazwaTypOpis
messagesGmailMessage[]tablica wiadomości do oznaczenia gwiazdką

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


unstarMessage(message)

Usuwa gwiazdkę z 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

NazwaTypOpis
messageGmailMessagewiadomość do usunięcia oznaczenia gwiazdką

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


unstarMessages(messages)

Usuwa gwiazdki z tych wiadomości i wymusza ich odświeżenie.

// Unstars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

Parametry

NazwaTypOpis
messagesGmailMessage[]tablica wiadomości do usunięcia gwiazdką

Powrót

GmailApp – usługa Gmail, która przydaje się do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednimi zakresami z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też

Wycofane metody