Class GmailLabel

GmailLabel

Etykieta utworzona przez użytkownika na koncie Gmail użytkownika.

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 ich odświeżenie.
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ątku.

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, który ma zostać oznaczony etykietą.

Powroty

GmailLabel – etykieta na potrzeby łańcuchów.

Upoważnienie

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

  • https://mail.google.com/

Zobacz też


addToThreads(threads)

Dodaje tę etykietę do podanych wątków i wymusza ich odświeżenie. W grupie możesz dodać etykiety obejmujące maksymalnie 100 wątków.

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

Powroty

GmailLabel – etykieta na potrzeby łańcuchów.

Upoważnienie

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

  • https://mail.google.com/

Zobacz też


deleteLabel()

Usuwa tę etykietę.

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

Rzuty

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

Upoważnienie

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

  • https://mail.google.com/

Zobacz też


getName()

Pobiera nazwę tej etykiety.

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

Powroty

String – nazwa etykiety.

Upoważnienie

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

  • 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ł je obsłużyć. Jeśli rozmiar wątku jest nieznany i potencjalnie bardzo duży, użyj wartości getThreads(start, max) i określ zakresy wątków do pobrania w każdym wywołaniu.

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

Powroty

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

Upoważnienie

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

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

Powroty

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

Upoważnienie

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

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

Powroty

Integer – liczba nieprzeczytanych wątków oznaczonych etykietami.

Upoważnienie

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

  • 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 miał etykiety.

Powroty

GmailLabel – etykieta na potrzeby łańcuchów.

Upoważnienie

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

  • https://mail.google.com/

Zobacz też


removeFromThreads(threads)

Usuwa tę etykietę z podanych wątków i wymusza odświeżenie wątku. Możesz usunąć etykiety maksymalnie 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, które nie mają być oznaczone etykietami.

Powroty

GmailLabel – etykieta na potrzeby łańcuchów.

Upoważnienie

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

  • https://mail.google.com/

Zobacz też