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

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

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(
    'mike@example.com',
    'current time',
    `The time is: ${now.toString()}`,
);

パラメータ

名前タイプ説明
recipientStringメールアドレスのカンマ区切りリスト
subjectStringメールの件名（最大 250 文字）
bodyStringメールの本文

戻る

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

承認

このメソッドを使用するスクリプトには、次のいずれかのスコープまたは関連する 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.
const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const 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()` によって返される値のいずれかである必要があります。GmailApp.getAliases()
htmlBodyString設定されている場合、HTML をレンダリングできるデバイスでは、必須の body 引数の代わりにこの引数が使用されます。メールにインライン画像がある場合は、HTML 本文にオプションの inlineImages フィールドを追加できます。
inlineImagesObject画像キー （String）から画像データ（BlobSource）へのマッピングを含む JavaScript オブジェクト。これは、htmlBody パラメータが使用され、<img src="cid:imageKey" /> 形式でこれらの画像への参照が含まれていることを前提としています。
nameStringメールの送信者の名前（デフォルト: ユーザーの名前）
replyToStringデフォルトの返信先アドレスとして使用するメールアドレス （デフォルト: ユーザーのメールアドレス）

戻る

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

承認

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

  • https://mail.google.com/

関連情報