Class GmailDraft

GmailDraft

ユーザーの 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()

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

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イメージキーからのマッピングを含む JavaScript オブジェクト （String）から画像データ（BlobSource）へ。htmlBody パラメータが使用され、<img src="cid:imageKey" /> 形式でこれらの画像への参照が含まれていることを前提としています。
nameStringメールの送信者の名前（デフォルト: ユーザー名）
replyToStringデフォルトの返信先アドレスとして使用するメールアドレス （デフォルト: ユーザーのメールアドレス）。

戻る

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

承認

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

  • https://mail.google.com/

関連情報