Class GmailLabel

NhãnGmail

Nhãn do người dùng tạo trong tài khoản Gmail của người dùng.

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
addToThread(thread)GmailLabelThêm nhãn này vào chuỗi đã cho và buộc chuỗi làm mới (GmailThread.refresh()).
addToThreads(threads)GmailLabelThêm nhãn này vào các luồng đã cho và buộc các luồng làm mới.
deleteLabel()voidXoá nhãn này.
getId()StringLấy mã nhận dạng của nhãn này.
getName()StringLấy tên của nhãn này.
getThreads()GmailThread[]Lấy các luồng được đánh dấu bằng nhãn này.
getThreads(start, max)GmailThread[]Lấy một dải các chuỗi được đánh dấu bằng nhãn này.
getUnreadCount()IntegerLấy số lượng chuỗi chưa đọc được gắn nhãn này.
removeFromThread(thread)GmailLabelXoá nhãn này khỏi luồng đã cho và buộc luồng làm mới.
removeFromThreads(threads)GmailLabelXoá nhãn này khỏi các chuỗi đã cho và buộc các chuỗi làm mới.

Tài liệu chi tiết

addToThread(thread)

Thêm nhãn này vào chuỗi đã cho và buộc chuỗi làm mới (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);

Thông số

TênLoạiMô tả
threadGmailThreadLuồng cần được gắn nhãn.

Cầu thủ trả bóng

GmailLabel – Nhãn này dùng để liên kết.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ REST API có liên quan:

  • https://mail.google.com/

Xem thêm


addToThreads(threads)

Thêm nhãn này vào các luồng đã cho và buộc các luồng làm mới. Bạn có thể thêm nhãn cho tối đa 100 chuỗi email trong mỗi lô.

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

Thông số

TênLoạiMô tả
threadsGmailThread[]Một mảng các luồng cần được gắn nhãn.

Cầu thủ trả bóng

GmailLabel – Nhãn này dùng để liên kết.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ REST API có liên quan:

  • https://mail.google.com/

Xem thêm


deleteLabel()

Xoá nhãn này.

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

Gửi

Error – nếu không thể xoá nhãn

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ REST API có liên quan:

  • https://mail.google.com/

Xem thêm


getId()

Lấy mã nhận dạng của nhãn này.

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

Cầu thủ trả bóng

String – Mã của nhãn.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ REST API có liên quan:

  • https://mail.google.com/

getName()

Lấy tên của nhãn này.

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

Cầu thủ trả bóng

String – Tên của nhãn.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ REST API có liên quan:

  • https://mail.google.com/

getThreads()

Lấy các luồng được đánh dấu bằng nhãn này.

Các lệnh gọi này sẽ không thành công khi kích thước của tất cả các luồng quá lớn để hệ thống xử lý. Nếu không biết kích thước luồng và kích thước này có thể rất lớn, vui lòng sử dụng getThreads(start, max) và chỉ định các dải luồng cần truy xuất trong mỗi lệnh gọi.

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

Cầu thủ trả bóng

GmailThread[] – Một mảng các luồng được đánh dấu bằng nhãn này.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ REST API có liên quan:

  • https://mail.google.com/

getThreads(start, max)

Lấy một dải các chuỗi được đánh dấu bằng nhãn này.

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

Thông số

TênLoạiMô tả
startIntegerChỉ mục của luồng bắt đầu.
maxIntegerSố lượng luồng tối đa cần trả về.

Cầu thủ trả bóng

GmailThread[] – Một mảng các luồng được đánh dấu bằng nhãn này.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ REST API có liên quan:

  • https://mail.google.com/

getUnreadCount()

Lấy số lượng chuỗi chưa đọc được gắn nhãn này.

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

Cầu thủ trả bóng

Integer – Số lượng chuỗi tin nhắn chưa đọc được gắn nhãn.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ REST API có liên quan:

  • https://mail.google.com/

removeFromThread(thread)

Xoá nhãn này khỏi luồng đã cho và buộc luồng làm mới.

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

Thông số

TênLoạiMô tả
threadGmailThreadChuỗi sẽ không được gắn nhãn.

Cầu thủ trả bóng

GmailLabel – Nhãn này dùng để liên kết.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ REST API có liên quan:

  • https://mail.google.com/

Xem thêm


removeFromThreads(threads)

Xoá nhãn này khỏi các chuỗi đã cho và buộc các chuỗi làm mới. Bạn có thể xoá nhãn cho tối đa 100 chuỗi email trong mỗi lô.

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

Thông số

TênLoạiMô tả
threadsGmailThread[]Một mảng gồm các chuỗi cần xoá nhãn.

Cầu thủ trả bóng

GmailLabel – Nhãn này dùng để liên kết.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ REST API có liên quan:

  • https://mail.google.com/

Xem thêm