Class GmailApp

Gmail앱

Gmail 대화목록, 메일, 라벨에 대한 액세스 권한을 제공합니다.

메서드

메서드	반환 유형	간략한 설명
createDraft(recipient, subject, body)	GmailDraft	이메일 초안을 만듭니다.
createDraft(recipient, subject, body, options)	GmailDraft	선택적 인수가 있는 이메일 초안을 만듭니다.
createLabel(name)	GmailLabel	지정된 이름의 새 사용자 라벨을 만듭니다.
deleteLabel(label)	GmailApp	지정된 라벨을 삭제합니다.
getAliases()	String[]	Gmail에서 이 계정의 별칭으로 설정된 이메일의 목록을 가져옵니다.
getDraft(draftId)	GmailDraft	ID별로 이메일 메시지 초안을 검색합니다.
getDraftMessages()	GmailMessage[]	모든 임시보관 메일을 검색합니다.
getDrafts()	GmailDraft[]	모든 Gmail 임시보관 메일을 가져옵니다.
getInboxThreads()	GmailThread[]	라벨과 관계없이 모든 받은편지함 대화목록을 검색합니다.
getInboxThreads(start, max)	GmailThread[]	라벨과 관계없이 받은편지함 대화목록 범위를 검색합니다.
getInboxUnreadCount()	Integer	받은편지함의 읽지 않은 대화목록 수를 가져옵니다.
getMessageById(id)	GmailMessage	ID로 메시지를 가져옵니다.
getMessagesForThread(thread)	GmailMessage[]	지정된 대화목록의 모든 메시지를 검색합니다.
getMessagesForThreads(threads)	GmailMessage[][]	지정된 대화목록의 모든 메시지를 검색합니다.
getPriorityInboxThreads()	GmailThread[]	라벨과 관계없이 모든 우선순위 받은편지함 대화목록을 검색합니다.
getPriorityInboxThreads(start, max)	GmailThread[]	라벨과 관계없이 자동분류함 대화목록의 범위를 검색합니다.
getPriorityInboxUnreadCount()	Integer	자동분류함에서 읽지 않은 대화목록의 개수를 가져옵니다.
getSpamThreads()	GmailThread[]	라벨과 관계없이 모든 스팸 대화목록을 검색합니다.
getSpamThreads(start, max)	GmailThread[]	라벨과 관계없이 다양한 스팸 대화목록을 검색합니다.
getSpamUnreadCount()	Integer	스팸인 읽지 않은 대화목록 수를 가져옵니다.
getStarredThreads()	GmailThread[]	라벨과 관계없이 별표표시된 모든 대화목록을 검색합니다.
getStarredThreads(start, max)	GmailThread[]	라벨과 관계없이 별표표시된 대화목록의 범위를 검색합니다.
getStarredUnreadCount()	Integer	별표표시된 읽지 않은 대화목록 수를 가져옵니다.
getThreadById(id)	GmailThread	ID로 대화목록을 가져옵니다.
getTrashThreads()	GmailThread[]	라벨과 관계없이 모든 휴지통 스레드를 검색합니다.
getTrashThreads(start, max)	GmailThread[]	라벨과 관계없이 다양한 휴지통 대화목록을 검색합니다.
getUserLabelByName(name)	GmailLabel	라벨 이름을 사용하여 라벨을 가져옵니다.
getUserLabels()	GmailLabel[]	사용자가 만든 라벨 목록을 가져옵니다.
markMessageRead(message)	GmailApp	이 메시지를 읽음으로 표시하고 메시지를 강제로 새로고침합니다.
markMessageUnread(message)	GmailApp	이 메시지를 읽지 않음으로 표시하고 메시지를 강제로 새로고침합니다.
markMessagesRead(messages)	GmailApp	이러한 메일을 읽음으로 표시하고 메일을 강제로 새로고침합니다.
markMessagesUnread(messages)	GmailApp	이러한 메일을 읽지 않은 것으로 표시하고 메일을 강제로 새로고침합니다.
markThreadImportant(thread)	GmailApp	이 대화목록을 중요하게 표시하고 대화목록을 강제로 새로고침합니다.
markThreadRead(thread)	GmailApp	이 대화목록을 읽음으로 표시하고 대화목록을 강제로 새로고침합니다.
markThreadUnimportant(thread)	GmailApp	이 대화목록을 중요하지 않은 대화로 표시하고 대화목록을 강제로 새로고침합니다.
markThreadUnread(thread)	GmailApp	이 대화목록을 읽지 않음으로 표시하고 대화목록을 강제로 새로고침합니다.
markThreadsImportant(threads)	GmailApp	이러한 대화목록을 중요하게 표시하고 대화목록을 강제로 새로고침합니다.
markThreadsRead(threads)	GmailApp	이러한 대화목록을 읽음으로 표시하고 대화목록을 강제로 새로고침합니다.
markThreadsUnimportant(threads)	GmailApp	이러한 대화목록을 중요하지 않은 것으로 표시하고 대화목록을 강제로 새로고침합니다.
markThreadsUnread(threads)	GmailApp	이러한 대화목록을 읽지 않음으로 표시하고 대화목록을 강제로 새로고침합니다.
moveMessageToTrash(message)	GmailApp	메일을 휴지통으로 이동하고 메일을 강제로 새로고침합니다.
moveMessagesToTrash(messages)	GmailApp	지정된 메일을 휴지통으로 이동하고 메일을 강제로 새로고침합니다.
moveThreadToArchive(thread)	GmailApp	이 대화목록을 보관처리함으로 이동하고 스레드를 강제로 새로고침합니다.
moveThreadToInbox(thread)	GmailApp	이 대화목록을 받은편지함으로 이동하고 대화목록을 강제로 새로고침합니다.
moveThreadToSpam(thread)	GmailApp	이 스레드를 스팸함으로 이동하고 스레드를 강제로 새로고침합니다.
moveThreadToTrash(thread)	GmailApp	이 스레드를 휴지통으로 이동하고 스레드를 강제로 새로고침합니다.
moveThreadsToArchive(threads)	GmailApp	이러한 대화목록을 보관처리함으로 이동하고 대화목록을 강제로 새로고침합니다.
moveThreadsToInbox(threads)	GmailApp	이러한 대화목록을 받은편지함으로 이동하고 대화목록을 강제로 새로고침합니다.
moveThreadsToSpam(threads)	GmailApp	이러한 대화목록을 스팸함으로 이동하고 대화목록을 강제로 새로고침합니다.
moveThreadsToTrash(threads)	GmailApp	이러한 대화목록을 휴지통으로 이동하고 대화목록을 강제로 새로고침합니다.
refreshMessage(message)	GmailApp	Gmail에서 메시지와 연결된 상태를 새로고침합니다 (라벨, 읽기 상태 등이 변경된 경우에 유용).
refreshMessages(messages)	GmailApp	Gmail에서 메시지와 연결된 상태를 새로고침합니다 (라벨, 읽기 상태 등이 변경된 경우에 유용).
refreshThread(thread)	GmailApp	Gmail에서 스레드와 연결된 상태를 새로고침합니다 (라벨, 읽기 상태 등이 변경된 경우에 유용).
refreshThreads(threads)	GmailApp	Gmail에서 스레드와 연결된 상태를 새로고침합니다 (라벨, 읽기 상태 등이 변경된 경우에 유용).
search(query)	GmailThread[]	지정된 검색어로 Gmail을 검색합니다.
search(query, start, max)	GmailThread[]	지정된 검색어로 Gmail을 검색합니다.
sendEmail(recipient, subject, body)	GmailApp	이메일 메시지를 전송합니다.
sendEmail(recipient, subject, body, options)	GmailApp	선택적 인수를 사용하여 이메일 메시지를 전송합니다.
setCurrentMessageAccessToken(accessToken)	void	스크립트가 현재 GmailMessage 속성에 액세스할 수 있도록 하는 현재 메시지 액세스 토큰을 설정합니다.
starMessage(message)	GmailApp	이 메일에 별표표시를 추가하고 메시지를 강제로 새로고침합니다.
starMessages(messages)	GmailApp	이러한 메일에 별표표시를 추가하고 메시지를 강제로 새로고침합니다.
unstarMessage(message)	GmailApp	이 메시지에서 별표를 삭제하고 메시지를 강제로 새로고침합니다.
unstarMessages(messages)	GmailApp	이러한 메일에서 별표를 삭제하고 메일을 강제로 새로고침합니다.

지원 중단된 메서드

메서드	반환 유형	간략한 설명
getChatThreads()	GmailThread[]	Google에서 올해 말에 기존 행아웃 사용자를 모두 Chat으로 전환할 때까지 모든 기존 Google 행아웃 대화목록과 Google Chat 대화목록을 가져옵니다.
getChatThreads(start, max)	GmailThread[]	Google에서 올해 말에 모든 기본 행아웃 사용자를 Chat으로 전환할 때까지 다양한 기존 Google 행아웃 대화목록과 Google Chat 대화목록을 가져옵니다.

자세한 문서

createDraft(recipient, subject, body)

이메일 초안을 만듭니다. 이메일 크기 (헤더 포함)는 할당량 제한이 적용됩니다.

// The code below creates a draft email with the current date and time.
const now = new Date();
GmailApp.createDraft(
    '[e-mail]',
    'current time',
    `The time is: ${now.toString()}`,
);

매개변수

이름	유형	설명
recipient	String	쉼표로 구분된 이메일 주소 목록
subject	String	이메일 제목
body	String	이메일 본문

리턴

GmailDraft: 새로 생성된 GmailDraft

승인

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

• https://mail.google.com/

참고 항목

• createDraft(recipient, subject, body, options)

---

createDraft(recipient, subject, body, options)

선택적 인수가 있는 이메일 초안을 만듭니다. 이메일에는 일반 텍스트 또는 HTML 본문이 포함될 수 있습니다. 이메일 크기 (헤더 포함, 첨부파일 제외)는 할당량 제한이 적용됩니다.

// Create a draft email with a file from Google Drive attached as a PDF.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft(
    '[e-mail]',
    'Attachment example',
    'Please see attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

매개변수

이름	유형	설명
recipient	String	수신자의 주소
subject	String	제목
body	String	이메일 본문
options	Object	아래에 나열된 고급 매개변수를 지정하는 JavaScript 객체입니다.

고급 매개변수

이름	유형	설명
attachments	BlobSource[]	이메일과 함께 전송할 파일 배열
bcc	String	BCC할 이메일 주소를 쉼표로 구분한 목록
cc	String	참조에 추가할 이메일 주소를 쉼표로 구분한 목록
from	String	이메일을 보내야 하는 주소로, getAliases()에서 반환된 값 중 하나여야 합니다.
htmlBody	String	설정된 경우 HTML을 렌더링할 수 있는 기기는 필수 본문 인수 대신 이를 사용합니다. 이메일에 이미지를 인라인 처리한 경우 HTML 본문에 선택적 inlineImages 필드를 추가할 수 있습니다.
inlineImages	Object	이미지 키(String)와 이미지 데이터 (BlobSource) 간의 매핑이 포함된 JavaScript 객체입니다. 여기서는 htmlBody 매개변수가 사용되고 <img src="cid:imageKey" /> 형식의 이러한 이미지 참조가 포함되어 있다고 가정합니다.
name	String	이메일 발신자의 이름 (기본값: 사용자 이름)
replyTo	String	기본 답장 주소로 사용할 이메일 주소입니다. 기본값은 사용자의 이메일 주소입니다.

리턴

GmailDraft: 새로 생성된 GmailDraft

승인

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

• https://mail.google.com/

참고 항목

• createDraft(recipient, subject, body)

---

createLabel(name)

지정된 이름의 새 사용자 라벨을 만듭니다.

// Creates the label @FOO and logs label: FOO
Logger.log(`label: ${GmailApp.createLabel('FOO')}`);

매개변수

이름	유형	설명
name	String	새 라벨의 이름

리턴

GmailLabel: 새로 생성된 라벨

승인

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

• https://mail.google.com/

참고 항목

• deleteLabel(label)

---

deleteLabel(label)

지정된 라벨을 삭제합니다.

// Have to get the label by name first
const label = GmailApp.getUserLabelByName('FOO');
GmailApp.deleteLabel(label);

매개변수

이름	유형	설명
label	GmailLabel	삭제할 라벨

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• createLabel(name)

---

getAliases()

Gmail에서 이 계정의 별칭으로 설정된 이메일의 목록을 가져옵니다.

'from' 선택적 인수를 사용하여 이러한 별칭 중 하나에서 메시지를 보낼 수 있습니다.

// Log the aliases for this Gmail account and send an email as the first one.
const me = Session.getActiveUser().getEmail();
const aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {
    from: aliases[0],
  });
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

리턴

String[]: 이 계정의 별칭 배열

승인

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

• https://mail.google.com/

참고 항목

• sendEmail(recipient, subject, body, options)

---

getDraft(draftId)

ID별로 이메일 메시지 초안을 검색합니다.

Gmail 초안에서 getId()와 함께 사용합니다.

// Get the first draft message in your drafts folder
const draft = GmailApp.getDrafts()[0];
// Get its ID
const draftId = draft.getId();
// Now fetch the same draft using that ID.
const draftById = GmailApp.getDraft(draftId);
// Should always log true as they should be the same message
Logger.log(
    draft.getMessage().getSubject() === draftById.getMessage().getSubject(),
);

매개변수

이름	유형	설명
draftId	String	가져올 답안의 ID

리턴

GmailDraft: 지정된 ID가 있는 초안

생성 값

Error: 지정된 ID의 초안을 찾을 수 없는 경우

승인

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

• https://mail.google.com/

---

getDraftMessages()

모든 임시보관 메일을 검색합니다.

// Logs the number of draft messages
const drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

리턴

GmailMessage[]: Gmail 초안 메일 배열

승인

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

• https://mail.google.com/

---

getDrafts()

모든 Gmail 임시보관 메일을 가져옵니다.

const drafts = GmailApp.getDrafts();
for (let i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

리턴

GmailDraft[]: Gmail 초안 메일 배열

승인

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

• https://mail.google.com/

---

getInboxThreads()

라벨과 관계없이 모든 받은편지함 대화목록을 검색합니다.

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

// Log the subject lines of your Inbox
const threads = GmailApp.getInboxThreads();
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

리턴

GmailThread[]: 받은편지함의 Gmail 대화목록 배열

승인

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

• https://mail.google.com/

---

getInboxThreads(start, max)

라벨과 관계없이 받은편지함 대화목록 범위를 검색합니다.

// Log the subject lines of up to the first 50 emails in your Inbox
const threads = GmailApp.getInboxThreads(0, 50);
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

매개변수

이름	유형	설명
start	Integer	가져올 첫 번째 대화목록의 색인
max	Integer	가져올 최대 스레드 수

리턴

GmailThread[]: 받은편지함의 Gmail 대화목록 배열

승인

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

• https://mail.google.com/

---

getInboxUnreadCount()

받은편지함의 읽지 않은 대화목록 수를 가져옵니다.

Logger.log(`Messages unread in inbox: ${GmailApp.getInboxUnreadCount()}`);

리턴

Integer: 읽지 않은 메일이 있는 받은편지함의 대화목록 수입니다.

승인

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

• https://mail.google.com/

---

getMessageById(id)

ID로 메시지를 가져옵니다.

Gmail 메일에서 getId()와 함께 사용합니다.

// Get the first message in the first thread of your inbox
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
const messageId = message.getId();
// Now fetch the same message using that ID.
const messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() === messageById.getSubject());

매개변수

이름	유형	설명
id	String	검색할 메시지의 ID

리턴

GmailMessage: 지정된 ID가 있는 메시지

생성 값

Error: 지정된 ID의 메시지를 찾을 수 없는 경우

승인

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

• https://mail.google.com/

참고 항목

• getThreadById(id)

---

getMessagesForThread(thread)

지정된 대화목록의 모든 메시지를 검색합니다.

// Log all the subject lines in the first thread of your inbox
const thread = GmailApp.getInboxThreads(0, 1)[0];
const messages = GmailApp.getMessagesForThread(thread);
for (let i = 0; i < messages.length; i++) {
  Logger.log(`subject: ${messages[i].getSubject()}`);
}

매개변수

이름	유형	설명
thread	GmailThread	가져올 메시지 스레드

리턴

GmailMessage[]: 이 대화목록에 해당하는 메시지 배열입니다.

승인

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

• https://mail.google.com/

참고 항목

• getMessagesForThreads(threads)

---

getMessagesForThreads(threads)

지정된 대화목록의 모든 메시지를 검색합니다.

// Log the subject lines of all messages in the first two threads of your inbox
const thread = GmailApp.getInboxThreads(0, 2);
const messages = GmailApp.getMessagesForThreads(thread);
for (let i = 0; i < messages.length; i++) {
  for (let j = 0; j < messages[i].length; j++) {
    Logger.log(`subject: ${messages[i][j].getSubject()}`);
  }
}

매개변수

이름	유형	설명
threads	GmailThread[]	가져올 메시지 스레드

리턴

GmailMessage[][]: 메시지 배열의 배열입니다. 외부 배열의 각 항목은 스레드에 해당하며 내부 배열에는 해당 스레드의 메시지가 포함됩니다.

승인

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

• https://mail.google.com/

참고 항목

• getMessagesForThread(thread)

---

getPriorityInboxThreads()

라벨과 관계없이 모든 우선순위 받은편지함 대화목록을 검색합니다.

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

Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads().length}`,
);

리턴

GmailThread[]: 자동분류함의 Gmail 대화목록 배열입니다.

승인

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

• https://mail.google.com/

---

getPriorityInboxThreads(start, max)

라벨과 관계없이 자동분류함 대화목록의 범위를 검색합니다.

// Will log some number 2 or less
Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads(0, 2).length}`,
);

매개변수

이름	유형	설명
start	Integer	가져올 첫 번째 대화목록의 색인
max	Integer	가져올 최대 스레드 수

리턴

GmailThread[]: 자동분류함의 Gmail 대화목록 배열입니다.

승인

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

• https://mail.google.com/

---

getPriorityInboxUnreadCount()

자동분류함에서 읽지 않은 대화목록의 개수를 가져옵니다.

Logger.log(
    `Number of unread emails in your Priority Inbox : ${
        GmailApp.getPriorityInboxUnreadCount()}`,
);

리턴

Integer: 읽지 않은 메일이 있는 자동분류함의 대화목록 수입니다.

승인

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

• https://mail.google.com/

---

getSpamThreads()

라벨과 관계없이 모든 스팸 대화목록을 검색합니다.

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

Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads().length}`);

리턴

GmailThread[]: 스팸 폴더의 Gmail 대화목록 배열

승인

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

• https://mail.google.com/

---

getSpamThreads(start, max)

라벨과 관계없이 다양한 스팸 대화목록을 검색합니다.

// Will log a number at most 5
Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads(0, 5).length}`);

매개변수

이름	유형	설명
start	Integer	가져올 첫 번째 대화목록의 색인
max	Integer	가져올 최대 스레드 수

리턴

GmailThread[]: 스팸 폴더의 Gmail 대화목록 배열

승인

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

• https://mail.google.com/

---

getSpamUnreadCount()

스팸인 읽지 않은 대화목록 수를 가져옵니다.

// Unless you actually read stuff in your spam folder, this should be the same
// as the number of messages in your spam folder.
Logger.log(`# unread threads that are spam: ${GmailApp.getSpamUnreadCount()}`);

리턴

Integer: 읽지 않은 메시지가 있는 스팸 대화목록 수

승인

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

• https://mail.google.com/

---

getStarredThreads()

라벨과 관계없이 별표표시된 모든 대화목록을 검색합니다.

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

// Logs the number of starred threads
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads().length}`);

리턴

GmailThread[]: 별표표시된 Gmail 대화목록 배열

승인

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

• https://mail.google.com/

---

getStarredThreads(start, max)

라벨과 관계없이 별표표시된 대화목록의 범위를 가져옵니다.

// Logs the number of starred threads to a maximum of 5
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads(0, 5).length}`);

매개변수

이름	유형	설명
start	Integer	가져올 첫 번째 대화목록의 색인
max	Integer	가져올 최대 스레드 수

리턴

GmailThread[]: 별표표시된 Gmail 대화목록 배열

승인

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

• https://mail.google.com/

---

getStarredUnreadCount()

별표표시된 읽지 않은 대화목록 수를 가져옵니다.

Logger.log(`# unread and starred: ${GmailApp.getStarredUnreadCount()}`);

리턴

Integer: 읽지 않은 메시지가 있는 별표표시된 대화목록 수

승인

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

• https://mail.google.com/

---

getThreadById(id)

ID로 대화목록을 가져옵니다.

Gmail 대화목록에서 getId()와 함께 사용합니다.

// Gets the first inbox thread.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
// Gets the same thread by ID.
const threadById = GmailApp.getThreadById(firstThread.getId());
// Verifies that they are the same.
console.log(
    firstThread.getFirstMessageSubject() ===
        threadById.getFirstMessageSubject(),
);

매개변수

이름	유형	설명
id	String	가져올 대화목록의 ID입니다.

리턴

GmailThread: 지정된 ID의 대화목록 또는 찾을 수 없는 경우 null입니다.

승인

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

• https://mail.google.com/

참고 항목

• getMessageById(id)

---

getTrashThreads()

라벨과 관계없이 모든 휴지통 스레드를 검색합니다.

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

Logger.log(`# of total trash threads: ${GmailApp.getTrashThreads().length}`);

리턴

GmailThread[]: 휴지통에 있는 Gmail 대화목록 배열

승인

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

• https://mail.google.com/

---

getTrashThreads(start, max)

라벨과 관계없이 다양한 휴지통 대화목록을 검색합니다.

// Will log a number at most 5
Logger.log(
    `# of total trash threads: ${GmailApp.getTrashThreads(0, 5).length}`,
);

매개변수

이름	유형	설명
start	Integer	가져올 첫 번째 대화목록의 색인
max	Integer	가져올 최대 스레드 수

리턴

GmailThread[]: 휴지통에 있는 Gmail 대화목록 배열

승인

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

• https://mail.google.com/

---

getUserLabelByName(name)

라벨 이름을 사용하여 라벨을 가져옵니다.

const labelObject = GmailApp.getUserLabelByName('myLabel');

매개변수

이름	유형	설명
name	String	검색할 라벨의 이름

리턴

GmailLabel: 지정된 이름의 Gmail 라벨

승인

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

• https://mail.google.com/

---

getUserLabels()

사용자가 만든 라벨 목록을 가져옵니다.

// Logs all of the names of your labels
const labels = GmailApp.getUserLabels();
for (let i = 0; i < labels.length; i++) {
  Logger.log(`label: ${labels[i].getName()}`);
}

리턴

GmailLabel[]: 사용자가 만든 라벨 배열

승인

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

• https://mail.google.com/

---

markMessageRead(message)

이 메시지를 읽음으로 표시하고 메시지를 강제로 새로고침합니다.

// Mark the first message in the first thread of your inbox as read
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageRead(message);

매개변수

이름	유형	설명
message	GmailMessage	읽음으로 표시할 메일

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• markMessageUnread(message)

---

markMessageUnread(message)

이 메시지를 읽지 않음으로 표시하고 메시지를 강제로 새로고침합니다.

// Mark the first message in the first thread of your inbox as unread
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

매개변수

이름	유형	설명
message	GmailMessage	읽지 않음으로 표시할 메일

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• markMessageRead(message)

---

markMessagesRead(messages)

이러한 메일을 읽음으로 표시하고 메일을 강제로 새로고침합니다.

// Mark first three messages in the first inbox thread as read.
// Assumes that the first inbox thread has 3 messages in it.
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(messages);

매개변수

이름	유형	설명
messages	GmailMessage[]	읽음으로 표시할 메시지의 배열

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• markMessagesUnread(messages)

---

markMessagesUnread(messages)

이러한 메일을 읽지 않은 것으로 표시하고 메일을 강제로 새로고침합니다.

// Mark first three messages in the first inbox thread as unread.
// Assumes that the first inbox thread has 3 messages in it
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(messages);

매개변수

이름	유형	설명
messages	GmailMessage[]	읽지 않음으로 표시할 메일 배열

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• markMessagesRead(messages)

---

markThreadImportant(thread)

이 대화목록을 중요 대화목록으로 표시하고 대화목록을 강제로 새로고침합니다.

// Marks first inbox thread as important
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

매개변수

이름	유형	설명
thread	GmailThread	중요한 대화목록

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• markThreadUnimportant(thread)

---

markThreadRead(thread)

이 대화목록을 읽음으로 표시하고 대화목록을 강제로 새로고침합니다.

// Marks first inbox thread as read
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadRead(thread);

매개변수

이름	유형	설명
thread	GmailThread	읽음으로 표시할 대화목록

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• markThreadUnread(thread)

---

markThreadUnimportant(thread)

이 대화목록을 중요하지 않은 대화로 표시하고 대화목록을 강제로 새로고침합니다.

// Marks first inbox thread as unimportant
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnimportant(thread);

매개변수

이름	유형	설명
thread	GmailThread	중요하지 않은 대화목록

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• markThreadImportant(thread)

---

markThreadUnread(thread)

이 대화목록을 읽지 않음으로 표시하고 대화목록을 강제로 새로고침합니다.

// Marks first inbox thread as unread
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnread(thread);

매개변수

이름	유형	설명
thread	GmailThread	읽지 않음으로 표시할 대화목록

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• markThreadRead(thread)

---

markThreadsImportant(threads)

이러한 대화목록을 중요하게 표시하고 대화목록을 강제로 새로고침합니다.

// Marks first two threads in inbox as important
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

매개변수

이름	유형	설명
threads	GmailThread[]	중요 메일로 표시할 대화목록 배열

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• markThreadsUnimportant(threads)

---

markThreadsRead(threads)

이러한 대화목록을 읽음으로 표시하고 대화목록을 강제로 새로고침합니다.

// Marks first two threads in inbox as read
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsRead(threads);

매개변수

이름	유형	설명
threads	GmailThread[]	읽음으로 표시할 대화목록 배열

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• markThreadsUnread(threads)

---

markThreadsUnimportant(threads)

이러한 대화목록을 중요하지 않은 것으로 표시하고 대화목록을 강제로 새로고침합니다.

// Marks first two threads in inbox as unimportant
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnimportant(threads);

매개변수

이름	유형	설명
threads	GmailThread[]	중요하지 않은 것으로 표시할 대화목록 배열

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• markThreadsImportant(threads)

---

markThreadsUnread(threads)

이러한 대화목록을 읽지 않음으로 표시하고 대화목록을 강제로 새로고침합니다.

// Marks first two threads in inbox as unread
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnread(threads);

매개변수

이름	유형	설명
threads	GmailThread[]	읽지 않음으로 표시할 대화목록 배열

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• markThreadsRead(threads)

---

moveMessageToTrash(message)

메일을 휴지통으로 이동하고 메일을 강제로 새로고침합니다.

// Move the first message in your inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

매개변수

이름	유형	설명
message	GmailMessage	휴지통에 보낼 메일

리턴

GmailApp: Gmail 서비스 (체이닝에 유용)

승인

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

• https://mail.google.com/

참고 항목

• moveMessagesToTrash(messages)

---

moveMessagesToTrash(messages)

지정된 메일을 휴지통으로 이동하고 메일을 강제로 새로고침합니다.

// Move first two messages in your inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const messages = firstThread.getMessages();
const toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

매개변수

이름	유형	설명
messages	GmailMessage[]	휴지통에 보낼 메일

리턴

GmailApp: Gmail 서비스 (체이닝에 유용)

승인

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

• https://mail.google.com/

참고 항목

• moveMessageToTrash(message)

---

moveThreadToArchive(thread)

이 대화목록을 보관처리함으로 이동하고 스레드를 강제로 새로고침합니다.

// Archive the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToArchive(firstThread);

매개변수

이름	유형	설명
thread	GmailThread	보관처리할 대화목록

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToTrash(thread)

---

moveThreadToInbox(thread)

이 대화목록을 받은편지함으로 이동하고 대화목록을 강제로 새로고침합니다.

// Find a thread not already in your inbox
const thread = GmailApp.search('-in:inbox')[0];  // Get the first one
GmailApp.moveThreadToInbox(thread);

매개변수

이름	유형	설명
thread	GmailThread	받은편지함으로 이동할 대화목록

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• moveThreadToTrash(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

---

moveThreadToSpam(thread)

이 스레드를 스팸함으로 이동하고 스레드를 강제로 새로고침합니다.

// Tag first thread in inbox as spam
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToSpam(firstThread);

매개변수

이름	유형	설명
thread	GmailThread	스팸으로 이동할 대화목록

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• moveThreadToTrash(thread)
• moveThreadToInbox(thread)
• moveThreadToArchive(thread)

---

moveThreadToTrash(thread)

이 스레드를 휴지통으로 이동하고 스레드를 강제로 새로고침합니다.

// Move first thread in inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToTrash(firstThread);

매개변수

이름	유형	설명
thread	GmailThread	휴지통에 버릴 대화목록

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

---

moveThreadsToArchive(threads)

이러한 대화목록을 보관처리함으로 이동하고 대화목록을 강제로 새로고침합니다.

// Move first two threads in your inbox to the archive
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToArchive(firstTwoThreads);

매개변수

이름	유형	설명
threads	GmailThread[]	보관처리할 대화목록 배열

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToTrash(threads)

---

moveThreadsToInbox(threads)

이러한 대화목록을 받은편지함으로 이동하고 대화목록을 강제로 새로고침합니다.

// Find two threads not already in your inbox
const firstTwoThreads = GmailApp.search('-in:inbox', 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

매개변수

이름	유형	설명
threads	GmailThread[]	받은편지함으로 이동할 스레드 배열

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• moveThreadsToTrash(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

---

moveThreadsToSpam(threads)

이러한 대화목록을 스팸함으로 이동하고 대화목록을 강제로 새로고침합니다.

// Move first two threads in your inbox to spam
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToSpam(firstTwoThreads);

매개변수

이름	유형	설명
threads	GmailThread[]	스팸함으로 이동할 스레드 배열

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• moveThreadsToInbox(threads)
• moveThreadsToTrash(threads)
• moveThreadsToArchive(threads)

---

moveThreadsToTrash(threads)

이러한 대화목록을 휴지통으로 이동하고 대화목록을 강제로 새로고침합니다.

// Move first two threads in your inbox to trash
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

매개변수

이름	유형	설명
threads	GmailThread[]	휴지통에 버릴 대화목록 배열

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

---

refreshMessage(message)

Gmail에서 메시지와 연결된 상태를 새로고침합니다 (라벨, 읽기 상태 등이 변경된 경우에 유용).

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const firstMessage = firstThread.getMessages()[0];
// ...Do something that may take a while here....
GmailApp.refreshMessage(firstMessage);
// ...Do more stuff with firstMessage...

매개변수

이름	유형	설명
message	GmailMessage	새로고침할 메시지

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• refreshMessages(messages)

---

refreshMessages(messages)

Gmail에서 메시지와 연결된 상태를 새로고침합니다 (라벨, 읽기 상태 등이 변경된 경우에 유용).

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 2);
// ...Do something that may take a while here....
GmailApp.refreshMessages(coupleOfMessages);
// ...Do more stuff with coupleOfMessages...

매개변수

이름	유형	설명
messages	GmailMessage[]	새로고침할 메시지

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• refreshMessage(message)

---

refreshThread(thread)

Gmail에서 스레드와 연결된 상태를 새로고침합니다 (라벨, 읽기 상태 등이 변경된 경우에 유용).

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
// ...Do something that may take a while here....
GmailApp.refreshThread(firstThread);
// ... Do more stuff with the thread ...

매개변수

이름	유형	설명
thread	GmailThread	새로고침할 대화목록

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• refreshThreads(threads)

---

refreshThreads(threads)

Gmail에서 스레드와 연결된 상태를 새로고침합니다 (라벨, 읽기 상태 등이 변경된 경우에 유용).

const threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

매개변수

이름	유형	설명
threads	GmailThread[]	새로고침할 대화목록

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• refreshThread(thread)

---

search(query)

지정된 검색어로 Gmail을 검색합니다.

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

// Find starred messages with subject IMPORTANT
const threads = GmailApp.search('is:starred subject:"IMPORTANT"');

매개변수

이름	유형	설명
query	String	Gmail에 입력할 때의 검색어

리턴

GmailThread[]: 이 검색어와 일치하는 Gmail 대화목록 배열

승인

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

• https://mail.google.com/

---

search(query, start, max)

지정된 검색어로 Gmail을 검색합니다.

// Find starred messages with subject IMPORTANT and return second batch of 10.
// Assumes there are at least 11 of them, otherwise this will return an empty
// array.
const threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

매개변수

이름	유형	설명
query	String	Gmail에 입력할 때의 검색어
start	Integer	시작 스레드의 색인
max	Integer	반환할 최대 스레드 수

리턴

GmailThread[]: 이 검색어와 일치하는 Gmail 대화목록 배열

승인

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

• https://mail.google.com/

---

sendEmail(recipient, subject, body)

이메일 메시지를 전송합니다. 이메일 크기 (헤더 포함)는 할당량 제한이 적용됩니다.

// The code below will send an email with the current date and time.
const now = new Date();
GmailApp.sendEmail(
    '[e-mail]',
    'current time',
    `The time is: ${now.toString()}`,
);

매개변수

이름	유형	설명
recipient	String	쉼표로 구분된 이메일 주소 목록
subject	String	이메일 제목 (영문 기준 최대 250자)
body	String	이메일 본문

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• sendEmail(recipient, subject, body, options)

---

sendEmail(recipient, subject, body, options)

선택적 인수를 사용하여 이메일 메시지를 전송합니다. 이메일에는 일반 텍스트 또는 HTML 본문이 포함될 수 있습니다. 이메일 크기 (헤더 포함, 첨부파일 제외)는 할당량 제한이 적용됩니다.

// Send an email with a file from Google Drive attached as a PDF.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail(
    '[e-mail]',
    'Attachment example',
    'Please see the attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

매개변수

이름	유형	설명
recipient	String	수신자의 주소
subject	String	제목 (영문 기준 최대 250자)
body	String	이메일 본문
options	Object	아래에 나열된 고급 매개변수를 지정하는 JavaScript 객체입니다.

고급 매개변수

이름	유형	설명
attachments	BlobSource[]	이메일과 함께 전송할 파일 배열
bcc	String	BCC할 이메일 주소를 쉼표로 구분한 목록
cc	String	참조에 추가할 이메일 주소를 쉼표로 구분한 목록
from	String	이메일을 보내야 하는 주소로, getAliases()에서 반환된 값 중 하나여야 합니다.
htmlBody	String	설정된 경우 HTML을 렌더링할 수 있는 기기는 필수 본문 인수 대신 이를 사용합니다. 이메일에 이미지를 인라인 처리한 경우 HTML 본문에 선택적 inlineImages 필드를 추가할 수 있습니다.
inlineImages	Object	이미지 키(String)와 이미지 데이터 (BlobSource) 간의 매핑이 포함된 JavaScript 객체입니다. 여기서는 htmlBody 매개변수가 사용되고 <img src="cid:imageKey" /> 형식의 이러한 이미지 참조가 포함되어 있다고 가정합니다.
name	String	이메일 발신자의 이름 (기본값: 사용자 이름)
noReply	Boolean	true: 수신자가 이메일에 응답하지 못하도록 하려면 일반 무응답 이메일 주소에서 이메일을 보내야 하는 경우. 이 옵션은 Gmail 사용자가 아닌 Google Workspace 계정에서만 사용할 수 있습니다.
replyTo	String	기본 답장 주소로 사용할 이메일 주소입니다. 기본값은 사용자의 이메일 주소입니다.

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• sendEmail(recipient, subject, body)

---

setCurrentMessageAccessToken(accessToken)

스크립트가 현재 GmailMessage 속성에 액세스할 수 있도록 하는 현재 메시지 액세스 토큰을 설정합니다.

Gmail 현재 메시지 범위를 사용하는 Google Workspace 부가기능 프로젝트에만 이 메서드가 필요합니다.

function handleAddonActionEvent(e) {
  GmailApp.setCurrentMessageAccessToken(e.messageMetadata.accessToken);
  const mailMessage = GmailApp.getMessageById(e.messageMetadata.messageId);
  // Do something with mailMessage
}

매개변수

이름	유형	설명
accessToken	String	Gmail 부가기능 작업 이벤트 객체에서 가져온 임시 액세스 토큰입니다.

승인

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

• https://mail.google.com/

---

starMessage(message)

이 메일에 별표표시를 추가하고 메시지를 강제로 새로고침합니다.

// Stars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

매개변수

이름	유형	설명
message	GmailMessage	별표표시할 메시지

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• starMessages(messages)

---

starMessages(messages)

이러한 메일에 별표표시를 추가하고 메시지를 강제로 새로고침합니다.

// Stars the first three messages in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

매개변수

이름	유형	설명
messages	GmailMessage[]	별표표시할 메시지의 배열

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• starMessage(message)

---

unstarMessage(message)

이 메시지에서 별표를 삭제하고 메시지를 강제로 새로고침합니다.

// Unstars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

매개변수

이름	유형	설명
message	GmailMessage	별표를 삭제할 메시지

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• unstarMessages(messages)

---

unstarMessages(messages)

이러한 메시지에서 별표를 삭제하고 메시지를 강제로 새로고침합니다.

// Unstars the first three messages in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

매개변수

이름	유형	설명
messages	GmailMessage[]	별표표시를 해제할 메시지의 배열

리턴

GmailApp: 체이닝에 유용한 Gmail 서비스

승인

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

• https://mail.google.com/

참고 항목

• unstarMessage(message)

지원 중단된 메서드

getChatThreads()

지원 중단되었습니다. 이 함수는 지원 중단되었으며 새 스크립트에서 사용해서는 안 됩니다.

Google에서 올해 말에 기존 행아웃 사용자를 모두 Chat으로 전환할 때까지 모든 기존 Google 행아웃 대화목록과 Google Chat 대화목록을 가져옵니다. 자세한 내용은 기존 행아웃에서 Google Chat으로의 전환에 관해 알아보기를 참고하세요.

모든 스레드의 크기가 시스템에서 처리하기에 너무 클 경우 이 호출은 실패합니다. 스레드 크기를 알 수 없고 매우 클 수 있는 경우 '페이징된' 호출을 사용하고 각 호출에서 검색할 스레드 범위를 지정합니다.

const threads = GmailApp.getChatThreads();
Logger.log(`# of chat threads: ${threads.length}`);

리턴

GmailThread[]: Gmail의 채팅 대화목록 배열입니다.

승인

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

• https://mail.google.com/

---

getChatThreads(start, max)

지원 중단되었습니다. 이 함수는 지원 중단되었으며 새 스크립트에서 사용해서는 안 됩니다.

Google에서 올해 말에 모든 기본 행아웃 사용자를 Chat으로 전환할 때까지 다양한 기존 Google 행아웃 대화목록과 Google Chat 대화목록을 가져옵니다. 자세한 내용은 기존 행아웃에서 Google Chat으로의 전환에 관해 알아보기를 참고하세요.

// Get first 50 chat threads
const threads = GmailApp.getChatThreads(0, 50);
// Will log no more than 50.0
Logger.log(threads.length);
Logger.log(threads[0].getFirstMessageSubject());

매개변수

이름	유형	설명
start	Integer	가져올 첫 번째 대화목록의 색인
max	Integer	가져올 최대 스레드 수

리턴

GmailThread[]: 채팅 Gmail 대화목록 배열

승인

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

• https://mail.google.com/