本頁面由 Cloud Translation API 翻譯而成。

Class GmailDraft

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

方法

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

授權

使用這個方法的指令碼需要授權下列一或多個範圍或相關 REST API 中的適當範圍：

https://mail.google.com/

`getId()`

取得此訊息草稿的 ID。

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

授權

使用這個方法的指令碼需要授權下列一或多個範圍或相關 REST API 中的適當範圍：

https://mail.google.com/

`getMessage()`

傳回代表此草稿的 Gmail 郵件。

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

回攻員

GmailMessage：代表這份草稿內容的訊息

授權

使用這個方法的指令碼需要授權下列一或多個範圍或相關 REST API 中的適當範圍：

https://mail.google.com/

`getMessageId()`

傳回代表此草稿的 GmailMessage 的 ID。

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

回攻員

String：郵件 ID

授權

使用這個方法的指令碼需要授權下列一或多個範圍或相關 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：最近傳送的訊息

授權

使用這個方法的指令碼需要授權下列一或多個範圍或相關 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());

參數

名稱	類型	說明
`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.
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'
});

參數

名稱	類型	說明
`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)