Class GmailLabel

GmailLabel

사용자의 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
var label = GmailApp.getUserLabelByName("MyLabel");
var 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
var label = GmailApp.getUserLabelByName("MyLabel");
var threads = GmailApp.getInboxThreads(0,3);
label.addToThreads(threads);

매개변수

이름유형설명
threadsGmailThread[]라벨을 지정할 스레드의 배열입니다.

리턴

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

승인

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

  • https://mail.google.com/

참고 항목

deleteLabel()

이 라벨을 삭제합니다. 

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

생성 값

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

승인

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

  • https://mail.google.com/

참고 항목

getName()

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

var 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
var label = GmailApp.getUserLabelByName("MyLabel");
var threads = label.getThreads();
for (var 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
var label = GmailApp.getUserLabelByName("MyLabel");
var threads = label.getThreads(0, 30);
for (var 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
var 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
var label = GmailApp.getUserLabelByName("MyLabel");
var 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
var label = GmailApp.getUserLabelByName("MyLabel");
var threads = GmailApp.getInboxThreads(0,3);
label.removeFromThreads(threads);

매개변수

이름유형설명
threadsGmailThread[]라벨을 지정하지 않을 스레드의 배열입니다.

리턴

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

승인

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

  • https://mail.google.com/

참고 항목