Class GmailLabel

GmailLabel

Etykieta utworzona przez użytkownika na jego koncie Gmail.

Metody

MetodaZwracany typKrótki opis
addToThread(thread)GmailLabelDodaje tę etykietę do danego wątku i wymusza jego odświeżenie (GmailThread.refresh()).
addToThreads(threads)GmailLabelDodaje tę etykietę do określonych 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 jego odświeżenie.
removeFromThreads(threads)GmailLabelUsuwa tę etykietę z określonych wątków i wymusza ich odświeżenie.

Szczegółowa dokumentacja

addToThread(thread)

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

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

Parametry

NazwaTypOpis
threadGmailThreadWątek, który ma zostać oznaczony.

Powrót

GmailLabel – ta etykieta służy do łańcuchowania.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


addToThreads(threads)

Dodaje tę etykietę do określonych wątków i wymusza ich odświeżenie. Do każdej partii możesz dodać etykiety maksymalnie 100 wątków.

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

Parametry

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

Powrót

GmailLabel – ta etykieta służy do łańcuchowania.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


deleteLabel()

Usuwa tę etykietę.

const label = GmailApp.getUserLabelByName('MyLabel');
label.deleteLabel();

Rzuty

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

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


getName()

Pobiera nazwę tej etykiety.

const label = GmailApp.getUserLabelByName('MyLabel');
Logger.log(label.getName());  // logs MyLabel

Powrót

String – nazwa etykiety.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

  • https://mail.google.com/

getThreads()

Pobiera wątki oznaczone tą etykietą.

Wywołania te kończą 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 może być bardzo duży, użyj parametru getThreads(start, max) i określ zakresy wątków do pobrania w każdej wywołaniach.

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

Powrót

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

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu 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
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = label.getThreads(0, 30);
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Parametry

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

Powrót

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

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu 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
const label = GmailApp.getUserLabelByName('MyLabel');
Logger.log(label.getUnreadCount());

Powrót

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

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

  • https://mail.google.com/

removeFromThread(thread)

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

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

Parametry

NazwaTypOpis
threadGmailThreadWątek nie ma etykiety.

Powrót

GmailLabel – ta etykieta służy do łańcuchowania.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też


removeFromThreads(threads)

Usuwa tę etykietę z określonych wątków i wymusza ich odświeżenie. Możesz usunąć etykiety maksymalnie 100 wątków na partię.

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

Parametry

NazwaTypOpis
threadsGmailThread[]Tablica wątków, które mają zostać pozbawione etykiet.

Powrót

GmailLabel – ta etykieta służy do łańcuchowania.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

  • https://mail.google.com/

Zobacz też