Class GmailDraft

Gmailฉบับร่าง

ข้อความร่างที่ผู้ใช้สร้างขึ้นในบัญชี 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()

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

const 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()

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

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

รีเทิร์น

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

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

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

  • https://mail.google.com/

getMessage()

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

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

รีเทิร์น

GmailMessage — ข้อความที่แสดงถึงเนื้อหาของฉบับร่างนี้

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

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

  • https://mail.google.com/

getMessageId()

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

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

รีเทิร์น

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

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

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

  • https://mail.google.com/

send()

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

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const 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.
const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const now = new Date();
draft.update(
    'mike@example.com',
    'current time',
    `The time is: ${now.toString()}`,
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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.
const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
draft.update(
    'mike@example.com',
    'Attachment example',
    'Please see attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

พารามิเตอร์

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

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

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

รีเทิร์น

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

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

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

  • https://mail.google.com/

ดูเพิ่มเติม