Class GmailLabel

GmailLabel

Etykieta utworzona przez użytkownika na jego koncie Gmail.

Metody

Metoda	Zwracany typ	Krótki opis
addToThread(thread)	GmailLabel	Dodaje tę etykietę do danego wątku i wymusza jego odświeżenie (GmailThread.refresh()).
addToThreads(threads)	GmailLabel	Dodaje tę etykietę do podanych wątków i wymusza ich odświeżenie.
deleteLabel()	void	Usuwa tę etykietę.
getId()	String	Pobiera identyfikator tej etykiety.
getName()	String	Pobiera nazwę tej etykiety.
getThreads()	GmailThread[]	Pobiera wątki oznaczone tą etykietą.
getThreads(start, max)	GmailThread[]	Pobiera zakres wątków oznaczonych tą etykietą.
getUnreadCount()	Integer	Pobiera liczbę nieprzeczytanych wątków oznaczonych tą etykietą.
removeFromThread(thread)	GmailLabel	Usuwa tę etykietę z danego wątku i wymusza jego odświeżenie.
removeFromThreads(threads)	GmailLabel	Usuwa tę etykietę z podanych 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

Nazwa	Typ	Opis
thread	GmailThread	Wątek, który ma zostać oznaczony.

Powrót

GmailLabel – ta etykieta do łączenia w łańcuch.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• removeFromThread(thread)

---

addToThreads(threads)

Dodaje tę etykietę do podanych wątków i wymusza ich odświeżenie. W ramach jednej operacji możesz dodać etykiety do 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

Nazwa	Typ	Opis
threads	GmailThread[]	Tablica wątków, które mają zostać oznaczone.

Powrót

GmailLabel – ta etykieta do łączenia w łańcuch.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• removeFromThreads(threads)

---

deleteLabel()

Usuwa tę etykietę.

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

Zgłasza

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

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• getName()

---

getId()

Pobiera identyfikator tej etykiety.

const label = GmailApp.getUserLabelByName('MyLabel');
console.log(label.getId());

Powrót

String – identyfikator etykiety.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

---

getName()

Pobiera nazwę tej etykiety.

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

Powrót

String – nazwa etykiety.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z użyciem co najmniej jednego 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 potencjalnie bardzo duży, użyj 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
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

Skrypty, które używają tej metody, wymagają autoryzacji z użyciem co najmniej jednego 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

Nazwa	Typ	Opis
start	Integer	Indeks wątku początkowego.
max	Integer	Maksymalna liczba wątków do zwrócenia.

Powrót

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

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z użyciem co najmniej jednego 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 oznaczonych etykietą.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z użyciem co najmniej jednego 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

Nazwa	Typ	Opis
thread	GmailThread	Wątek, z którego ma zostać usunięta etykieta.

Powrót

GmailLabel – ta etykieta do łączenia w łańcuch.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• addToThread(thread)

---

removeFromThreads(threads)

Usuwa tę etykietę z podanych wątków i wymusza ich odświeżenie. W ramach jednej operacji możesz usunąć etykiety z maksymalnie 100 wątków.

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

Nazwa	Typ	Opis
threads	GmailThread[]	Tablica wątków, z których mają zostać usunięte etykiety.

Powrót

GmailLabel – ta etykieta do łączenia w łańcuch.

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

• https://mail.google.com/

Zobacz też

• addToThreads(threads)