Win32 API 日本語リファレンス
ホーム › System.TaskScheduler › IEmailAction

IEmailAction

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID10f62c64-7e16-4314-a0c2-0c3683f99d40継承元IAction呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl10

公式ドキュメント

電子メールメッセージを送信するアクションを表します。

解説(Remarks)

タスクが正しく登録および実行されるためには、電子メールアクションの Server、From、および To または Cc の各プロパティに有効な値が設定されている必要があります。

タスク用の XML を自分で読み書きする場合、電子メールアクションは Task Scheduler スキーマの SendEmail 要素を使用して指定します。

Windows 8 および Windows Server 2012: このインターフェイスは削除されました。回避策として、PowerShell の Send-MailMessage コマンドレットとともに IExecAction を使用してください。

例

このインターフェイスの詳細情報とサンプルコードについては、Event Trigger Example (C++) を参照してください。

メソッド 20

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 10 HRESULT get_Server(LPWSTR* pServer)

電子メールの送信元として使用する SMTP サーバーの名前を取得または設定します。(Get)

pServerLPWSTR*inoutメール送信に使用する SMTP サーバー名を受け取る出力ポインタである。SysFreeString で解放する。

解説(Remarks)

電子メールを送信する SMTP サーバーが正しくセットアップされていることを確認してください。Windows の SMTP サーバーでは NTLM 認証を使用して電子メールが送信されます。つまり、タスクの実行に使用するセキュリティ資格情報は、SMTP サーバー上で電子メールメッセージを送信する権限も持っている必要があります。SMTP サーバーが Windows ベースでないサーバーの場合、そのサーバーが匿名アクセスを許可していれば電子メールは送信されます。SMTP サーバー設定の管理については、SMTP administration を参照してください。

vtbl 11 HRESULT put_Server(LPWSTR server)

電子メールの送信元として使用する SMTP サーバーの名前を取得または設定します。(Put)

serverLPWSTRinメール送信に使用する SMTP サーバー名を指定する。

解説(Remarks)

電子メールを送信する SMTP サーバーが正しくセットアップされていることを確認してください。Windows の SMTP サーバーでは NTLM 認証を使用して電子メールが送信されます。つまり、タスクの実行に使用するセキュリティ資格情報は、SMTP サーバー上で電子メールメッセージを送信する権限も持っている必要があります。SMTP サーバーが Windows ベースでないサーバーの場合、そのサーバーが匿名アクセスを許可していれば電子メールは送信されます。SMTP サーバーのセットアップについては SMTP Server Setup を、SMTP サーバー設定の管理については SMTP Administration を参照してください。

vtbl 12 HRESULT get_Subject(LPWSTR* pSubject)

電子メールメッセージの件名を取得または設定します。(Get)

pSubjectLPWSTR*inoutメールの件名を受け取る出力ポインタである。SysFreeString で解放する。

解説(Remarks)

このプロパティ値を設定する際、値としてリソース .dll ファイルから取得したテキストを使用できます。リソースファイルからテキストを参照するには、特殊な形式の文字列を使用します。文字列の形式は $(@ [Dll], [ResourceID]) で、[Dll] はリソースを含む .dll ファイルへのパス、[ResourceID] はリソーステキストの識別子です。たとえば、このプロパティ値を $(@ %SystemRoot%\System32\ResourceName.dll, -101) に設定すると、%SystemRoot%\System32\ResourceName.dll ファイル内で識別子が -101 に等しいリソーステキストの値がプロパティに設定されます。

vtbl 13 HRESULT put_Subject(LPWSTR subject)

電子メールメッセージの件名を取得または設定します。(Put)

subjectLPWSTRinメールの件名を指定する。

解説(Remarks)

このプロパティ値を設定する際、値としてリソース .dll ファイルから取得したテキストを使用できます。リソースファイルからテキストを参照するには、特殊な形式の文字列を使用します。文字列の形式は $(@ [Dll], [ResourceID]) で、[Dll] はリソースを含む .dll ファイルへのパス、[ResourceID] はリソーステキストの識別子です。たとえば、このプロパティ値を $(@ %SystemRoot%\System32\ResourceName.dll, -101) に設定すると、%SystemRoot%\System32\ResourceName.dll ファイル内で識別子が -101 に等しいリソーステキストの値がプロパティに設定されます。

vtbl 14 HRESULT get_To(LPWSTR* pTo)

電子メールの送信先とする 1 つまたは複数の電子メールアドレスを取得または設定します。(Get)

pToLPWSTR*inoutメールの宛先 (To) アドレスを受け取る出力ポインタである。SysFreeString で解放する。
vtbl 15 HRESULT put_To(LPWSTR to)

電子メールの送信先とする 1 つまたは複数の電子メールアドレスを取得または設定します。(Put)

toLPWSTRinメールの宛先 (To) アドレスを指定する。
vtbl 16 HRESULT get_Cc(LPWSTR* pCc)

電子メールメッセージで Cc に指定する 1 つまたは複数の電子メールアドレスを取得または設定します。(Get)

pCcLPWSTR*inoutメールの CC アドレスを受け取る出力ポインタである。SysFreeString で解放する。
vtbl 17 HRESULT put_Cc(LPWSTR cc)

電子メールメッセージで Cc に指定する 1 つまたは複数の電子メールアドレスを取得または設定します。(Put)

ccLPWSTRinメールの CC アドレスを指定する。
vtbl 18 HRESULT get_Bcc(LPWSTR* pBcc)

電子メールメッセージで Bcc に指定する 1 つまたは複数の電子メールアドレスを取得または設定します。(Get)

pBccLPWSTR*inoutメールの BCC アドレスを受け取る出力ポインタである。SysFreeString で解放する。
vtbl 19 HRESULT put_Bcc(LPWSTR bcc)

電子メールメッセージで Bcc に指定する 1 つまたは複数の電子メールアドレスを取得または設定します。(Put)

bccLPWSTRinメールの BCC アドレスを指定する。
vtbl 20 HRESULT get_ReplyTo(LPWSTR* pReplyTo)

返信先とする電子メールアドレスを取得または設定します。(Get)

pReplyToLPWSTR*inoutメールの返信先 (Reply-To) アドレスを受け取る出力ポインタである。SysFreeString で解放する。
vtbl 21 HRESULT put_ReplyTo(LPWSTR replyTo)

返信先とする電子メールアドレスを取得または設定します。(Put)

replyToLPWSTRinメールの返信先 (Reply-To) アドレスを指定する。
vtbl 22 HRESULT get_From(LPWSTR* pFrom)

電子メールの送信元とする電子メールアドレスを取得または設定します。(Get)

pFromLPWSTR*inoutメールの送信元 (From) アドレスを受け取る出力ポインタである。SysFreeString で解放する。
vtbl 23 HRESULT put_From(LPWSTR from)

電子メールの送信元とする電子メールアドレスを取得または設定します。(Put)

fromLPWSTRinメールの送信元 (From) アドレスを指定する。
vtbl 24 HRESULT get_HeaderFields(ITaskNamedValueCollection** ppHeaderFields)

送信する電子メールメッセージのヘッダー情報を取得または設定します。(Get)

ppHeaderFieldsITaskNamedValueCollection**outメールに追加するヘッダーフィールドのコレクション (ITaskNamedValueCollection) を受け取る出力ポインタである。
vtbl 25 HRESULT put_HeaderFields(ITaskNamedValueCollection* pHeaderFields)

送信する電子メールメッセージのヘッダー情報を取得または設定します。(Put)

pHeaderFieldsITaskNamedValueCollection*inメールに追加するヘッダーフィールドのコレクション (ITaskNamedValueCollection) へのポインタである。
vtbl 26 HRESULT get_Body(LPWSTR* pBody)

電子メールメッセージを含む電子メールの本文を取得または設定します。(Get)

pBodyLPWSTR*inoutメールの本文を受け取る出力ポインタである。SysFreeString で解放する。

解説(Remarks)

このプロパティ値を設定する際、値としてリソース .dll ファイルから取得したテキストを使用できます。リソースファイルからテキストを参照するには、特殊な形式の文字列を使用します。文字列の形式は $(@ [Dll], [ResourceID]) で、[Dll] はリソースを含む .dll ファイルへのパス、[ResourceID] はリソーステキストの識別子です。たとえば、このプロパティ値を $(@ %SystemRoot%\System32\ResourceName.dll, -101) に設定すると、%SystemRoot%\System32\ResourceName.dll ファイル内で識別子が -101 に等しいリソーステキストの値がプロパティに設定されます。

vtbl 27 HRESULT put_Body(LPWSTR body)

電子メールメッセージを含む電子メールの本文を取得または設定します。(Put)

bodyLPWSTRinメールの本文を指定する。

解説(Remarks)

このプロパティ値を設定する際、値としてリソース .dll ファイルから取得したテキストを使用できます。リソースファイルからテキストを参照するには、特殊な形式の文字列を使用します。文字列の形式は $(@ [Dll], [ResourceID]) で、[Dll] はリソースを含む .dll ファイルへのパス、[ResourceID] はリソーステキストの識別子です。たとえば、このプロパティ値を $(@ %SystemRoot%\System32\ResourceName.dll, -101) に設定すると、%SystemRoot%\System32\ResourceName.dll ファイル内で識別子が -101 に等しいリソーステキストの値がプロパティに設定されます。

vtbl 28 HRESULT get_Attachments(SAFEARRAY** pAttachements)

電子メールメッセージとともに送信される添付ファイルの配列へのポインターを取得または設定します。(Get)

pAttachementsSAFEARRAY**inoutメールに添付するファイル名の配列を格納した SAFEARRAY を受け取る出力ポインタである。

解説(Remarks)

添付ファイルの配列には、最大 8 個の添付ファイルを含めることができます。

vtbl 29 HRESULT put_Attachments(SAFEARRAY* pAttachements)

電子メールメッセージとともに送信される添付ファイルの配列へのポインターを取得または設定します。(Put)

pAttachementsSAFEARRAY*inoutメールに添付するファイル名の配列を格納した SAFEARRAY へのポインタである。

解説(Remarks)

添付ファイルの配列には、最大 8 個の添付ファイルを含めることができます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IEmailAction "{10F62C64-7E16-4314-A0C2-0C3683F99D40}"
#usecom global IEmailAction IID_IEmailAction "{}"
#comfunc global IEmailAction_get_Server        10 var
#comfunc global IEmailAction_put_Server        11 wstr
#comfunc global IEmailAction_get_Subject       12 var
#comfunc global IEmailAction_put_Subject       13 wstr
#comfunc global IEmailAction_get_To            14 var
#comfunc global IEmailAction_put_To            15 wstr
#comfunc global IEmailAction_get_Cc            16 var
#comfunc global IEmailAction_put_Cc            17 wstr
#comfunc global IEmailAction_get_Bcc           18 var
#comfunc global IEmailAction_put_Bcc           19 wstr
#comfunc global IEmailAction_get_ReplyTo       20 var
#comfunc global IEmailAction_put_ReplyTo       21 wstr
#comfunc global IEmailAction_get_From          22 var
#comfunc global IEmailAction_put_From          23 wstr
#comfunc global IEmailAction_get_HeaderFields  24 sptr
#comfunc global IEmailAction_put_HeaderFields  25 sptr
#comfunc global IEmailAction_get_Body          26 var
#comfunc global IEmailAction_put_Body          27 wstr
#comfunc global IEmailAction_get_Attachments   28 var
#comfunc global IEmailAction_put_Attachments   29 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。