Class GmailDraft

GmailDraft

ข้อความร่างที่ผู้ใช้สร้างในบัญชี Gmail ของผู้ใช้

วิธีการ

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
deleteDraft()voidลบข้อความฉบับร่างนี้
getId()Stringรับรหัสของข้อความฉบับร่างนี้
getMessage()GmailMessageแสดงผล GmailMessage ที่แสดงถึงข้อความร่างนี้
getMessageId()Stringแสดงผลรหัส GmailMessage ที่แสดงถึงฉบับร่างนี้
send()GmailMessageส่งข้อความอีเมลฉบับร่างนี้
update(recipient, subject, body)GmailDraftแทนที่เนื้อหาของข้อความฉบับร่างนี้
update(recipient, subject, body, options)GmailDraftแทนที่เนื้อหาของข้อความร่างนี้โดยใช้อาร์กิวเมนต์ที่ไม่บังคับ

เอกสารประกอบโดยละเอียด

deleteDraft()

ลบข้อความฉบับร่างนี้

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
draft.deleteDraft();
draft.getMessage(); // Throws exception.

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้จะต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://mail.google.com/

getId()

รับรหัสของข้อความฉบับร่างนี้

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var draftId = draft.getId();
var draftById = GmailApp.getDraft(draftId);
Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());

รีเทิร์น

String — รหัสฉบับร่าง

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้จะต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://mail.google.com/

getMessage()

แสดงผล GmailMessage ที่แสดงถึงข้อความร่างนี้

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var message = draft.getMessage();
Logger.log(message.getSubject());

รีเทิร์น

GmailMessage — ข้อความที่แทนเนื้อหาของข้อความร่างนี้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้จะต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://mail.google.com/

getMessageId()

แสดงผลรหัส GmailMessage ที่แสดงถึงฉบับร่างนี้

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var messageId = draft.getMessageId();
Logger.log(messageId == draft.getMessage().getId());

รีเทิร์น

String — รหัสข้อความ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้จะต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://mail.google.com/

send()

ส่งข้อความอีเมลฉบับร่างนี้ ขนาดของอีเมล (รวมถึงส่วนหัว) ถูกจำกัด

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var msg = draft.send(); // Send it
Logger.log(msg.getDate()); // Should be approximately the current timestamp

รีเทิร์น

GmailMessage — ข้อความที่ส่งใหม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้จะต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://mail.google.com/

update(recipient, subject, body)

แทนที่เนื้อหาของข้อความฉบับร่างนี้ ขนาดของอีเมล (รวมถึงส่วนหัว) ถูกจำกัด

// The code below will update a draft email with the current date and time.
var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var now = new Date();
draft.update("mike@example.com", "current time", "The time is: " + now.toString());

พารามิเตอร์

ชื่อTypeคำอธิบาย
recipientStringรายการที่อยู่อีเมลที่คั่นด้วยเครื่องหมายจุลภาค
subjectStringหัวเรื่องของอีเมล (อักขระไม่เกิน 250 ตัว)
bodyStringเนื้อหาของอีเมล

รีเทิร์น

GmailDraft — ฉบับร่างที่อัปเดตใหม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้จะต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://mail.google.com/

ดูเพิ่มเติม


update(recipient, subject, body, options)

แทนที่เนื้อหาของข้อความร่างนี้โดยใช้อาร์กิวเมนต์ที่ไม่บังคับ โดยในอีเมลอาจมีข้อความธรรมดาหรือเนื้อหา HTML ขนาดของอีเมล (รวมถึงส่วนหัว) ถูกจำกัด

// Update a draft email with a file from Google Drive attached as a PDF.
var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
draft.update('mike@example.com', 'Attachment example', 'Please see attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

พารามิเตอร์

ชื่อTypeคำอธิบาย
recipientStringรายการที่อยู่อีเมลที่คั่นด้วยเครื่องหมายจุลภาค
subjectStringหัวเรื่องของอีเมล (อักขระไม่เกิน 250 ตัว)
bodyStringเนื้อหาของอีเมล
optionsObjectออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูง ดังที่แสดงด้านล่าง

พารามิเตอร์ขั้นสูง

ชื่อTypeคำอธิบาย
attachmentsBlobSource[]อาร์เรย์ของไฟล์ที่จะส่งพร้อมกับอีเมล
bccStringรายการที่อยู่อีเมลที่คั่นด้วยจุลภาคในสำเนาลับ
ccStringรายการที่อยู่อีเมลที่คั่นด้วยเครื่องหมายจุลภาคสำหรับส่งสำเนาถึง
fromStringที่อยู่ที่ใช้ส่งอีเมล ซึ่งต้องเป็นค่าใดค่าหนึ่งที่ GmailApp.getAliases() แสดงผล
htmlBodyStringหากตั้งค่าไว้ อุปกรณ์ที่แสดงผล HTML ได้จะใช้อาร์กิวเมนต์ดังกล่าวแทนอาร์กิวเมนต์เนื้อหาที่จำเป็น คุณเพิ่มช่อง inlineImages ในเนื้อหา HTML ได้หากมีรูปภาพในบรรทัดสำหรับอีเมล
inlineImagesObjectออบเจ็กต์ JavaScript ที่มีการแมปจากคีย์รูปภาพ (String) กับข้อมูลรูปภาพ (BlobSource) โดยจะถือว่ามีการใช้พารามิเตอร์ htmlBody และมีการอ้างอิงรูปภาพเหล่านี้ในรูปแบบ <img src="cid:imageKey" />
nameStringชื่อผู้ส่งอีเมล (ค่าเริ่มต้น: ชื่อของผู้ใช้)
replyToStringอีเมลที่จะใช้เป็นที่อยู่สำหรับตอบกลับเริ่มต้น (ค่าเริ่มต้น: อีเมลของผู้ใช้)

รีเทิร์น

GmailDraft — ฉบับร่างที่อัปเดตใหม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้จะต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ หรือขอบเขตที่เหมาะสมจาก REST API ที่เกี่ยวข้อง

  • https://mail.google.com/

ดูเพิ่มเติม