Class GmailDraft

Gmail 下書き

ユーザーの 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 をレンダリングします。メールのインライン画像がある場合は、HTML 本文にオプションの inlineImages フィールドを追加できます。
inlineImagesObject画像キー(String)から画像データ(BlobSource)へのマッピングを含む JavaScript オブジェクト。これは、htmlBody パラメータが使用され、これらの画像への参照が <img src="cid:imageKey" /> 形式で含まれていることを前提としています。
nameStringメールの送信者の名前(デフォルト: ユーザーの名前)
replyToStringデフォルトの返信先アドレスとして使用するメールアドレス(デフォルト: ユーザーのメールアドレス)

戻る

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

認可

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

  • https://mail.google.com/

関連ドキュメント