Class GmailDraft

Gmail草稿

使用者在 Gmail 帳戶中建立的草稿郵件。

方法

方法	傳回類型	簡短說明
deleteDraft()	void	刪除這則草稿訊息。
getId()	String	取得草稿郵件的 ID。
getMessage()	GmailMessage	傳回代表此草稿的 GmailMessage。
getMessageId()	String	傳回代表此草稿的 GmailMessage ID。
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.

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

---

getId()

取得草稿訊息的 ID。

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：草稿 ID

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 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：代表此草稿內容的訊息

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

---

getMessageId()

傳回代表此草稿的 GmailMessage ID。

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

回攻員

String：訊息 ID

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 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：新傳送的訊息

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 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(
    '[e-mail]',
    'current time',
    `The time is: ${now.toString()}`,
);

參數

名稱	類型	說明
recipient	String	以半形逗號分隔的電子郵件地址清單
subject	String	電子郵件主旨 (最多 250 個半形字元)
body	String	電子郵件內文

回攻員

GmailDraft：新更新的草稿

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• GmailApp.createDraft(recipient, subject, body)

---

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(
    '[e-mail]',
    'Attachment example',
    'Please see 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	以半形逗號分隔的電子郵件地址清單 (用於副本收件人)
cc	String	以半形逗號分隔的電子郵件地址清單 (用於副本收件者)
from	String	電子郵件應傳送自的地址，必須是 GmailApp.getAliases() 傳回的其中一個值
htmlBody	String	如果已設定，則可轉換為可轉換 HTML 的裝置，而非使用必要的 body 引數；如果您為電子郵件內嵌圖片，則可在 HTML 主體中新增選用的 inlineImages 欄位
inlineImages	Object	JavaScript 物件，其中包含圖片鍵 (String) 與圖片資料 (BlobSource) 的對應關係；這項操作假設您會使用 htmlBody 參數，並以 <img src="cid:imageKey" /> 格式包含這些圖片的參照
name	String	電子郵件寄件者的名稱 (預設為使用者名稱)
replyTo	String	做為預設回覆地址的電子郵件地址 (預設值：使用者的電子郵件地址)

回攻員

GmailDraft：新更新的草稿

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

• https://mail.google.com/

另請參閱

• GmailApp.createDraft(recipient, subject, body, options)