Class GmailLabel

Gmail라벨

사용자의 Gmail 계정에서 사용자가 만든 라벨입니다.

메서드

메서드반환 유형간략한 설명
addToThread(thread)GmailLabel지정된 대화목록에 이 라벨을 추가하고 대화목록을 강제로 새로고침합니다 (GmailThread.refresh()).
addToThreads(threads)GmailLabel지정된 스레드에 이 라벨을 추가하고 스레드를 강제로 새로고침합니다.
deleteLabel()void이 라벨을 삭제합니다.
getName()String이 라벨의 이름을 가져옵니다.
getThreads()GmailThread[]이 라벨로 표시된 스레드를 가져옵니다.
getThreads(start, max)GmailThread[]이 라벨로 표시된 다양한 스레드를 가져옵니다.
getUnreadCount()Integer이 라벨로 태그된 읽지 않은 대화목록의 수를 가져옵니다.
removeFromThread(thread)GmailLabel지정된 대화목록에서 이 라벨을 삭제하고 대화목록을 강제로 새로고침합니다.
removeFromThreads(threads)GmailLabel지정된 스레드에서 이 라벨을 삭제하고 스레드를 강제로 새로고침합니다.

자세한 문서

addToThread(thread)

지정된 대화목록에 이 라벨을 추가하고 대화목록을 강제로 새로고침합니다 (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);

매개변수

이름유형설명
threadGmailThread라벨을 지정할 스레드입니다.

리턴

GmailLabel: 체이닝을 위한 라벨입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상 또는 관련 REST API의 적절한 범위가 있는 승인이 필요합니다.

  • https://mail.google.com/

참고 항목


addToThreads(threads)

지정된 스레드에 이 라벨을 추가하고 스레드를 강제로 새로고침합니다. 일괄 처리당 최대 100개의 대화목록에 라벨을 추가할 수 있습니다.

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

매개변수

이름유형설명
threadsGmailThread[]라벨을 지정할 대화목록 배열입니다.

리턴

GmailLabel: 체이닝을 위한 라벨입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상 또는 관련 REST API의 적절한 범위가 있는 승인이 필요합니다.

  • https://mail.google.com/

참고 항목


deleteLabel()

이 라벨을 삭제합니다.

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

생성 값

Error: 라벨을 삭제할 수 없는 경우

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상 또는 관련 REST API의 적절한 범위가 있는 승인이 필요합니다.

  • https://mail.google.com/

참고 항목


getName()

이 라벨의 이름을 가져옵니다.

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

리턴

String: 라벨 이름입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상 또는 관련 REST API의 적절한 범위가 있는 승인이 필요합니다.

  • https://mail.google.com/

getThreads()

이 라벨로 표시된 스레드를 가져옵니다.

모든 스레드의 크기가 시스템에서 처리하기에 너무 클 때 이 호출은 실패합니다. 스레드 크기를 알 수 없고 매우 클 수 있는 경우 getThreads(start, max)를 사용하고 각 호출에서 검색할 스레드 범위를 지정하세요.

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

리턴

GmailThread[]: 이 라벨로 표시된 스레드 배열입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상 또는 관련 REST API의 적절한 범위가 있는 승인이 필요합니다.

  • https://mail.google.com/

getThreads(start, max)

이 라벨로 표시된 다양한 스레드를 가져옵니다.

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

매개변수

이름유형설명
startInteger시작 스레드의 색인입니다.
maxInteger반환할 최대 스레드 수입니다.

리턴

GmailThread[]: 이 라벨로 표시된 스레드 배열입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상 또는 관련 REST API의 적절한 범위가 있는 승인이 필요합니다.

  • https://mail.google.com/

getUnreadCount()

이 라벨로 태그된 읽지 않은 대화목록의 수를 가져옵니다.

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

리턴

Integer: 읽지 않은 라벨이 지정된 대화목록 수입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상 또는 관련 REST API의 적절한 범위가 있는 승인이 필요합니다.

  • https://mail.google.com/

removeFromThread(thread)

지정된 대화목록에서 이 라벨을 삭제하고 대화목록을 강제로 새로고침합니다.

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

매개변수

이름유형설명
threadGmailThread대화목록에 라벨이 지정되지 않습니다.

리턴

GmailLabel: 체이닝을 위한 라벨입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상 또는 관련 REST API의 적절한 범위가 있는 승인이 필요합니다.

  • https://mail.google.com/

참고 항목


removeFromThreads(threads)

지정된 스레드에서 이 라벨을 삭제하고 스레드를 강제로 새로고침합니다. 일괄 처리당 최대 100개의 대화목록에 대한 라벨을 삭제할 수 있습니다.

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

매개변수

이름유형설명
threadsGmailThread[]라벨을 지정할 대화목록 배열입니다.

리턴

GmailLabel: 체이닝을 위한 라벨입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상 또는 관련 REST API의 적절한 범위가 있는 승인이 필요합니다.

  • https://mail.google.com/

참고 항목