Class GmailDraft

GmailDraft

ユーザーの Gmail アカウントでユーザーが作成したメールの下書き。

Methods

メソッド戻り値の型概要
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()

この下書きメッセージを削除します。 

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

この下書きメッセージの 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

承認

この方法を使用するスクリプトには、次の 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 の 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

承認

この方法を使用するスクリプトには、次の 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());

パラメータ

名前型説明
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'
});

パラメータ

名前型説明
recipientStringメールアドレスのカンマ区切りのリスト
subjectStringメールの件名（最大 250 文字）
bodyStringメールの本文
optionsObject詳細パラメータを指定する JavaScript オブジェクト（下記を参照）

拡張パラメータ

名前型説明
attachmentsBlobSource[]メールと一緒に送信するファイルの配列
bccStringBcc で送信するメールアドレスのカンマ区切りのリスト
ccStringCc に含めるメールアドレスのカンマ区切りのリスト
fromStringメールの送信元アドレス。GmailApp.getAliases() によって返される値のいずれかにする必要があります。
htmlBodyString設定すると、HTML をレンダリングできるデバイスは、必須の本文引数の代わりにそれを使用します。メール用にインライン画像を用意する場合は、HTML 本文にオプションの inlineImages フィールドを追加できます。
inlineImagesObject画像キー（String）から画像データ（BlobSource）へのマッピングを含む JavaScript オブジェクト。これは、htmlBody パラメータが使用され、<img src="cid:imageKey" /> 形式でこれらの画像への参照が含まれていることを前提としています。
nameStringメールの送信者の名前（デフォルト: ユーザー名）
replyToStringデフォルトの返信先アドレスとして使用するメールアドレス（デフォルト: ユーザーのメールアドレス）

リターン

GmailDraft - 新しく更新された下書き

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://mail.google.com/

関連ドキュメント