Class GmailLabel

Etykieta Gmaila

Etykieta utworzona przez użytkownika na koncie Gmail.

Metody

MetodaZwracany typKrótki opis
addToThread(thread)GmailLabelDodaje tę etykietę do danego wątku i wymusza odświeżenie wątku (GmailThread.refresh()).
addToThreads(threads)GmailLabelDodaje tę etykietę do podanych wątków i wymusza odświeżenie wątków.
deleteLabel()voidUsuwa tę etykietę.
getName()StringPobiera nazwę tej etykiety.
getThreads()GmailThread[]Pobiera wątki oznaczone tą etykietą.
getThreads(start, max)GmailThread[]Pobiera zakres wątków oznaczonych tą etykietą.
getUnreadCount()IntegerPobiera liczbę nieprzeczytanych wątków oznaczonych tą etykietą.
removeFromThread(thread)GmailLabelUsuwa tę etykietę z danego wątku i wymusza odświeżenie wątku.
removeFromThreads(threads)GmailLabelUsuwa tę etykietę z podanych wątków i wymusza odświeżenie wątków.

Szczegółowa dokumentacja

addToThread(thread)

Dodaje tę etykietę do danego wątku i wymusza odświeżenie wątku (GmailThread.refresh()).

// label the first thread in the inbox with the label MyLabel
var label = GmailApp.getUserLabelByName("MyLabel");
var firstThread = GmailApp.getInboxThreads(0,1)[0];
label.addToThread(firstThread);

Parametry

NazwaTypOpis
threadGmailThreadWątek do oznaczenia.

Zwróć

GmailLabel – ta etykieta dla łańcuchów.

Autoryzacja

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

  • https://mail.google.com/

Zobacz też


addToThreads(threads)

Dodaje tę etykietę do podanych wątków i wymusza odświeżenie wątków. Etykiety możesz dodać dla maksymalnie 100 wątków na grupę.

// label the first three threads in the inbox with the label MyLabel
var label = GmailApp.getUserLabelByName("MyLabel");
var threads = GmailApp.getInboxThreads(0,3);
label.addToThreads(threads);

Parametry

NazwaTypOpis
threadsGmailThread[]Tablica wątków do oznaczenia.

Zwróć

GmailLabel – ta etykieta dla łańcuchów.

Autoryzacja

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

  • https://mail.google.com/

Zobacz też


deleteLabel()

Usuwa tę etykietę.

var label = GmailApp.getUserLabelByName("MyLabel");
label.deleteLabel();

Narzuty

Error – jeśli nie można usunąć etykiety

Autoryzacja

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

  • https://mail.google.com/

Zobacz też


getName()

Pobiera nazwę tej etykiety.

var label = GmailApp.getUserLabelByName("MyLabel");
Logger.log(label.getName()); //logs MyLabel

Zwróć

String – nazwa etykiety;

Autoryzacja

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

  • https://mail.google.com/

getThreads()

Pobiera wątki oznaczone tą etykietą.

To wywołanie kończy się niepowodzeniem, gdy rozmiar wszystkich wątków jest zbyt duży, aby system mógł go obsłużyć. Jeśli rozmiar wątku jest nieznany i potencjalnie duży, użyj metody getThreads(start, max) i określ zakresy wątków do pobrania w każdej rozmowie.

// Log the subject lines of the threads labeled with MyLabel
var label = GmailApp.getUserLabelByName("MyLabel");
var threads = label.getThreads();
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Zwróć

GmailThread[] – tablica wątków oznaczonych tą etykietą.

Autoryzacja

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

  • https://mail.google.com/

getThreads(start, max)

Pobiera zakres wątków oznaczonych tą etykietą.

// log the subject lines of up to the first 30 threads with the label MyLabel
var label = GmailApp.getUserLabelByName("MyLabel");
var threads = label.getThreads(0, 30);
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Parametry

NazwaTypOpis
startIntegerIndeks początkowego wątku.
maxIntegerMaksymalna liczba wątków do zwrócenia.

Zwróć

GmailThread[] – tablica wątków oznaczonych tą etykietą.

Autoryzacja

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

  • https://mail.google.com/

getUnreadCount()

Pobiera liczbę nieprzeczytanych wątków oznaczonych tą etykietą.

// log the number of unread threads labeled with MyLabel
var label = GmailApp.getUserLabelByName("MyLabel");
Logger.log(label.getUnreadCount());

Zwróć

Integer – liczba nieprzeczytanych wątków z oznaczeniem.

Autoryzacja

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

  • https://mail.google.com/

removeFromThread(thread)

Usuwa tę etykietę z danego wątku i wymusza odświeżenie wątku.

// remove the label MyLabel from the first thread in the inbox
var label = GmailApp.getUserLabelByName("MyLabel");
var firstThread = GmailApp.getInboxThreads(0,1)[0];
label.removeFromThread(firstThread);

Parametry

NazwaTypOpis
threadGmailThreadWątek nie będzie oznaczony etykietą.

Zwróć

GmailLabel – ta etykieta dla łańcuchów.

Autoryzacja

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

  • https://mail.google.com/

Zobacz też


removeFromThreads(threads)

Usuwa tę etykietę z podanych wątków i wymusza odświeżenie wątków. Możesz usunąć etykiety do 100 wątków na grupę.

// remove the label MyLabel from the first three threads in the inbox
var label = GmailApp.getUserLabelByName("MyLabel");
var threads = GmailApp.getInboxThreads(0,3);
label.removeFromThreads(threads);

Parametry

NazwaTypOpis
threadsGmailThread[]Tablica wątków do usunięcia.

Zwróć

GmailLabel – ta etykieta dla łańcuchów.

Autoryzacja

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

  • https://mail.google.com/

Zobacz też