Class GmailApp

AplikacjaGmail

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ą wiadomości e-mail.
createDraft(recipient, subject, body, options)GmailDraftTworzy wersję roboczą e-maila z argumentami opcjonalnymi.
createLabel(name)GmailLabelUtwórz nową etykietę użytkownika o podanej nazwie.
deleteLabel(label)GmailAppUsuwa określoną etykietę.
getAliases()String[]Pobiera listę adresów e-mail skonfigurowanych jako aliasy na tym koncie w Gmailu.
getDraft(draftId)GmailDraftPobierz 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()IntegerPobiera liczbę nieprzeczytanych wątków w skrzynce odbiorczej.
getMessageById(id)GmailMessagePobiera 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()IntegerPobiera 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()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()IntegerZwraca liczbę nieprzeczytanych wątków oznaczonych gwiazdką.
getThreadById(id)GmailThread|nullPobiera 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)GmailLabelPobiera etykietę na podstawie jej nazwy.
getUserLabels()GmailLabel[]Pobiera listę etykiet utworzonych przez użytkownika.
markMessageRead(message)GmailAppOznacza tę 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 ten wątek jako ważny i wymusza jego odświeżenie.
markThreadRead(thread)GmailAppOznacza ten wątek jako przeczytany i wymusza jego odświeżenie.
markThreadUnimportant(thread)GmailAppOznacza ten wątek jako nieważny i wymusza jego odświeżenie.
markThreadUnread(thread)GmailAppOznacza ten 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 te 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 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 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)GmailAppPrzenosi te wątki 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)GmailAppPrzenosi te wątki do kosza i wymusza ich odświeżenie.
refreshMessage(message)GmailAppPonownie wczytuje wiadomość i powiązany z nią stan z Gmaila (przydatne, jeśli zmieniły się etykiety, stan odczytu itp.).
refreshMessages(messages)GmailAppPonownie wczytuje wiadomości i powiązany z nimi stan z Gmaila (przydatne, jeśli zmieniły się etykiety, stan odczytania itp.).
refreshThread(thread)GmailAppPonownie wczytuje wątek i powiązany stan z Gmaila (przydatne, jeśli zmieniły się etykiety, stan odczytu itp.).
refreshThreads(threads)GmailAppPonownie 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)GmailAppWysyła e-maila.
sendEmail(recipient, subject, body, options)GmailAppWysyła e-maila z argumentami opcjonalnymi.
setCurrentMessageAccessToken(accessToken)voidUstawia bieżący token dostępu do wiadomości, który umożliwia skryptowi dostęp do bieżących właściwości GmailMessage.
starMessage(message)GmailAppOznacza wiadomość gwiazdką i wymusza jej odświeżenie.
starMessages(messages)GmailAppDodaje gwiazdki do tych wiadomości i wymusza ich odświeżenie.
unstarMessage(message)GmailAppUsuwa gwiazdkę z tej 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ą wiadomości e-mail. Rozmiar e-maila (wraz z nagłówkami) jest ograniczony.

// The code below creates a draft email with the current date and time.
const now = new Date();
GmailApp.createDraft(
    'mike@example.com',
    'current time',
    `The time is: ${now.toString()}`,
);

Parametry

NazwaTypOpis
recipientStringlista adresów e-mail rozdzielonych przecinkami
subjectStringtemat e-maila,
bodyStringtreść e-maila

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, 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(
    'mike@example.com',
    'Attachment example',
    'Please see attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

Parametry

NazwaTypOpis
recipientStringadresy odbiorcy;
subjectStringtemat,
bodyStringtreść e-maila,
optionsObjectobiekt JavaScriptu, który określa parametry zaawansowane wymienione poniżej;

Parametry zaawansowane

NazwaTypOpis
attachmentsBlobSource[]tablicę plików do wysłania z e-mailem.
bccStringlista adresów e-mail do pola UDW rozdzielona przecinkami;
ccStringlista adresów e-mail, na które należy wysłać kopię wiadomości, rozdzielona przecinkami;
fromStringadres, z którego ma zostać wysłany e-mail. Musi to być jedna z wartości zwróconych przez getAliases().
htmlBodyStringjeśli jest ustawiony, urządzenia obsługujące HTML będą go używać zamiast wymaganego argumentu body; możesz dodać opcjonalne pole inlineImages w treści HTML, jeśli masz wbudowane obrazy w e-mailu
inlineImagesObjectobiekt 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" />.
nameStringnazwa nadawcy e-maila (domyślnie: 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 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ż


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

NazwaTypOpis
nameStringnazwę 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)

Usuwa określoną etykietę.

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

Parametry

NazwaTypOpis
labelGmailLabeletykieta 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ż


getAliases()

Pobiera listę adresów e-mail skonfigurowanych jako aliasy na tym koncie 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ż


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

NazwaTypOpis
draftIdStringidentyfikator wersji roboczej do pobrania;

Powrót

GmailDraft – wersja robocza o podanym identyfikatorze;

Zgłasza

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

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.

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

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

NazwaTypOpis
idStringidentyfikator wiadomości do pobrania;

Powrót

GmailMessage – komunikat o podanym identyfikatorze.

Zgłasza

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ż


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

NazwaTypOpis
threadGmailThreadwą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)

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

NazwaTypOpis
threadsGmailThread[]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ż


getPriorityInboxThreads()

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

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

NazwaTypOpis
startIntegerindeks pierwszego wątku do pobrania;
maxIntegermaksymalna 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.

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

NazwaTypOpis
startIntegerindeks pierwszego wątku do pobrania;
maxIntegermaksymalna 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 oznaczone gwiazdką, niezależnie od etykiet.

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

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

NazwaTypOpis
idStringIdentyfikator 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ż


getTrashThreads()

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

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

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

NazwaTypOpis
nameStringnazwa 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

NazwaTypOpis
messageGmailMessagewiadomość 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)

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

NazwaTypOpis
messageGmailMessagewiadomość do oznaczenia jako nieprzeczytana;

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)

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

NazwaTypOpis
messagesGmailMessage[]tablicę 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)

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

NazwaTypOpis
messagesGmailMessage[]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ż


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

NazwaTypOpis
threadGmailThreadwą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ż


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

NazwaTypOpis
threadGmailThreadwą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ż


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

NazwaTypOpis
threadGmailThreadwą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ż


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

NazwaTypOpis
threadGmailThreadwą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ż


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

NazwaTypOpis
threadsGmailThread[]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ż


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

NazwaTypOpis
threadsGmailThread[]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ż


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

NazwaTypOpis
threadsGmailThread[]tablicę 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ż


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

NazwaTypOpis
threadsGmailThread[]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ż


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

NazwaTypOpis
messageGmailMessagewiadomość, która ma zostać przeniesiona 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)

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

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

NazwaTypOpis
messagesGmailMessage[]wiadomości, które mają zostać przeniesione 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ż


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

NazwaTypOpis
threadGmailThreadwą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)

Przenosi 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

NazwaTypOpis
threadGmailThreadwą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ż


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

NazwaTypOpis
threadGmailThreadwą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)

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

NazwaTypOpis
threadGmailThreadwą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ż


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

NazwaTypOpis
threadsGmailThread[]tablicę 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)

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

NazwaTypOpis
threadsGmailThread[]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ż


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

NazwaTypOpis
threadsGmailThread[]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ż


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

NazwaTypOpis
threadsGmailThread[]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ż


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

NazwaTypOpis
messageGmailMessagewiadomość 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)

Ponownie wczytuje wiadomości i powiązany z nimi stan z Gmaila (przydatne, jeśli zmieniły się etykiety, stan odczytania 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

NazwaTypOpis
messagesGmailMessage[]wiadomości, które mają zostać odświeżone;

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)

Ponownie wczytuje wątek i powiązany stan z Gmaila (przydatne, jeśli 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

NazwaTypOpis
threadGmailThreadwą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)

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

NazwaTypOpis
threadsGmailThread[]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ż


search(query)

Wyszukaj w Gmailu podane zapytanie.

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

NazwaTypOpis
queryStringzapytanie, które wpisujesz 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

NazwaTypOpis
queryStringzapytanie, które wpisujesz 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, 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) jest ograniczony.

// The code below will send an email with the current date and time.
const now = new Date();
GmailApp.sendEmail(
    'mike@example.com',
    'current time',
    `The time is: ${now.toString()}`,
);

Parametry

NazwaTypOpis
recipientStringlista adresów e-mail rozdzielonych przecinkami
subjectStringtemat e-maila (maksymalnie 250 znaków);
bodyStringtreść 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)

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(
    '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 JavaScriptu, który określa parametry zaawansowane wymienione poniżej;

Parametry zaawansowane

NazwaTypOpis
attachmentsBlobSource[]tablicę plików do wysłania z e-mailem.
bccStringlista adresów e-mail do pola UDW rozdzielona przecinkami;
ccStringlista adresów e-mail, na które należy wysłać kopię wiadomości, rozdzielona przecinkami;
fromStringadres, z którego ma zostać wysłany e-mail. Musi to być jedna z wartości zwróconych przez getAliases().
htmlBodyStringjeśli jest ustawiony, urządzenia obsługujące HTML będą go używać zamiast wymaganego argumentu body; możesz dodać opcjonalne pole inlineImages w treści HTML, jeśli masz wbudowane obrazy w e-mailu
inlineImagesObjectobiekt 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" />.
nameStringnazwa nadawcy e-maila (domyślnie: nazwa użytkownika);
noReplyBooleantrue 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;
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, 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ż


setCurrentMessageAccessToken(accessToken)

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

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

NazwaTypOpis
accessTokenStringtymczasowy 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

NazwaTypOpis
messageGmailMessagewiadomość 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ż


starMessages(messages)

Dodaje gwiazdki do tych wiadomości 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

NazwaTypOpis
messagesGmailMessage[]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ż


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

NazwaTypOpis
messageGmailMessagewiadomość, z której chcesz usunąć 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)

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

NazwaTypOpis
messagesGmailMessage[]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ż

Wycofane metody