send-mime

www.altova.com このトピックを印刷 前のページ 1つ上のレベル 次のページ

ホーム >  ビルトイン関数 > /system/mail >

send-mime

フルパス:/system/mail/send-mime

 

指定済みの宛先に電子メールを送信します。通常宛先は管理者です。

 

メモ: この関数を使用する前に、電子メールのサーバー設定が構成されていることを確認してください  (メールのパラメータの設定 を参照してください).

 

実行に成功すると、この関数はブール値の TRUE を返します。ジョブの実行に失敗すると、結果は 「エラー時には中断」 パラメーターの値により以下のように異なります:

 

「エラー時には中断」  パラメーターが  TRUE (デフォルトの値) の場合、ジョブの実行は中断されます。この場合、エラーを保護されたブロックを使用して処理することができます (以下を参照: ステップのエラーの処理 )。
「エラー時には中断」 パラメーターが FALSE の場合、関数は、FALSE を返します。

 

send 関数とは異なり、この関数の メッセージ本文パラメーターは、文字列ではなくストリームを生成する式を期待します。 これにより、ストリームから (例えば、 HTML として) メッセージを取得することができます。

 

HTML コンテンツをメッセージ本文のために取得するには、 HTML 出力を MIME として生成する、StyleVision Server 変換を呼び出すことが強く奨励されます。FlowForce Server 自身は、イメージ、スタイルシート、または、 HTML ファイルにより参照されている類似したリソースを内蔵 MIME ストリームに集めません。

 

内蔵 HTML メッセージ本文を StyleVision Server を使用して生成するには、以下を行います:

 

1.Altova StyleVision 内で電子メールの HTML 本文をデザインします。デザインにはローカルイメージとスタイルシートが含まれる場合があります。

2.StyleVision 変換を FlowForce Server にデプロイします。FlowForce 内では、変換は StyleVision Server により実行が可能な内蔵 FlowForce 関数になります。

3.上記の StyleVision Server 変換を呼び出すジョブを作成します。GenerateHtmlOutputAsMime オプションがジョブ構成ページで選択されていることを確認してください。

4.ジョブ構成ページ内で FlowForce Server 式関数を呼出、生成された MIME ストリームをピックアップし、send-mime 関数の 「メッセージ本文」パラメーターにパスします (下の 「例 1」 を参照してください)。

 

HTML ファイルにより参照されている外部リソースは MIME ストリームに埋め込むことはできず、電子メールの添付として追加されます。

 

HTML 出力を MIME ストリームとして生成するジョブのサンプルは、以下で説明されています。StyleVision 変換を FlowForce Server にデプロイする方法をステップバイステップで説明しているサンプルに関しては、StyleVision 変換からのジョブの作成 を参照してください。StyleVision Server 統合の詳細に関しては、 他の Altova サーバーとの統合. 統合を参照してください。

 

メッセージ本文のためにストリームを直接 FlowForce 内で作成するには、stream-open または stream-from-string などの式関数を呼び出すこともできます。同様に、MIME 式関数を使用して電子メール、または、添付メッセージヘッダーをカスタマイズすることができます。

 

宛先側の迷惑メールフォルダーに電子メールが振り分けられないように、MIME ヘッダーを受信先のサーバー、または、プログラムで許可されている方法で構成してください。

 

パラメーター

名前

説明

差出人

string

電子メールが送信されるアドレス。例: flowforce@<hostname>.

宛先

string

電子メールアドレスの宛先必須のパラメーターです。

件名

string

メッセージの件名必須のパラメーターです。

本文

stream

ストリーム型を返す FlowForce 式としてのメッセージの本文テキスト。

添付

sequence of stream

電子メールと共に送信される添付ファイルです。各添付は、ストリームを生成する FlowForce 式である必要があります。 文字列またはファイルからストリームを作成するために、 ストリーム式関数 を呼び出します。MIME 式関数 を呼び出して、MIME ヘッダーを追加、変更、または、削除することができます。

エラー時には中断する

boolean

このブールパラメーターはジョブが失敗した場合の戻り値を決定します。 「エラー時には中断」 が FALSE の場合、関数は、ブール値の FALSE を返します。 「エラー時には中断」 が TRUE の場合、ジョブの実行は中断されます。デフォルトの値は、 TRUE です。

 

サンプル

サンプル 1: HTML 書式で電子メールを送信するには、下で説明されるジョブは send-mime 関数を呼び出します。

 

最初の実行ステップは HTML 出力を StyleVision Server 変換を呼び出して生成します。この変換は StyleVision を使用してデザインされ、StyleVision 変換からのジョブの作成で説明されている通り、 FlowForce Server にデプロイされます。 GenerateHtmlOutputAsMime チェックボックスが選択されています。最初の実行ステップの結果は、「出力」と呼ばれています (この文字列は以降のステップで必要とされ、式内に「output」を入力することのより参照することができます)。

 

2番目の実行ステップは FlowForce 式を計算するために compute 関数を呼び出します。 具体的には、式 nth(results(output), 0) はインデックス 0 を持つ(この場合、OutHtml) MIME ストリームを前のステップにより生成された結果からピックアップします。

 

最後に、3番目の実行ステップは電子メールメッセージを送信します。 「メッセージ本文」 フィールドは、ステップ2で前に計算された結果である FlowForce 式を含んでいます。

 

fs_send_mime_example1

サンプル 2: 下で表示されているジョブは HTML 書式のイメージ添付を含む .png 書式で電子メールを送信する send-mime 関数を呼び出します。

 

最初の実行ステップはメッセージの内容を準備します。

簡素化のために、このサンプル内の HTML コードは直接テキストボックスに入力されます。 HTML 出力を取得するには、奨励される方法は、前のサンプルで説明されている通り StyleVision Server 変換を呼び出すことです。

 

「メッセージ本文」 フィールドには FlowForce 式が含まれています。式は、 (型文字列の) 最初の実行ステップの結果をストリームに変換します。 Stream-from-string 関数はこの目的のために呼び出されます。 エンコードと希望される MIME 型はこの関数の引数としてパスされています。

 

イメージ添付はローカルパスから取得されます: C:\sample.png

fs_send_mime_example_cut

上記のイメージは印刷ページにフィットするように切り取られています。「添付」フィールドには次の式が含まれています

 

add-mime-header(stream-open('C:\sample.png', 'image/png'), 'Content-Disposition', 'attachment; filename=''sample.png')

 

上の式は以下を行います:

 

stream-open 関数はイメージをストリームとして開きます。
add-mime-header 関数は、 「コンテンツ - ディスポジション」 ヘッダーをストリームに追加します。このようにして、イメージ添付は想定された名前 (「sample.png」) が与えられます。

(C) 2019 Altova GmbH