MIME メッセージの作成、記述および読み取り

MIME メッセージの概要

MIME 形式のドキュメントは、MIME パートと呼ばれます。各 MIME パートにはヘッダがあり、メッセージ本文 (テキストまたはバイナリのいずれか)、または追加 MIME パートが含まれます。MIME-Version ヘッダを持つ MIME パートは、トップレベル・ドキュメントとして使用でき、MIME メッセージと呼ばれます。次の図に例を示します。

この例で、E と F には、表示されない追加サブパートがあります。

MIME パートを表示するには、ヘッダおよびこのパートのコンテンツの設定に使用するプロパティを提供する %Net.MIMEPartOpens in a new tab クラスを使用します。

MIME パートの作成

MIME パートを作成する手順は以下のとおりです。

1. %Net.MIMEPartOpens in a new tab のインスタンスを作成します。

2. 以下のいずれかを行います。

   • テキストまたはバイナリの本文を追加します。そのためには、ストリーム (テキストまたはバイナリのいずれか) のインスタンスを作成し、MIME パートの Body プロパティをこのストリームと等しくなるように設定します。データをこのストリームに書き込むには、標準のストリーム・インタフェースを使用します。Parts プロパティの値は指定しないでください。

   • MIME パートのリストを追加します。そのためには、ここで説明したとおりに MIME パートを作成し、Parts プロパティをこれらのパートのリストと等しくなるように設定します。Body プロパティの値は指定しないでください。

3. オプションで、“MIME パート・ヘッダの設定と取得” の説明に従って、ヘッダを設定します。

MIME メッセージの記述

MIME メッセージを記述するには、以下のように %Net.MIMEWriterOpens in a new tab を使用します。

1. %Net.MIMEWriterOpens in a new tab クラスのインスタンスを作成します。

2. オプションで、出力先を指定します。出力先を指定するには、ライター・インスタンスの OutputToDevice() (既定)、OutputToFile()、または OutputToStream() のメソッドのいずれかを使用します。

3. 必要に応じて、ライターのメソッドを呼び出して、出力を記述します。

   • ヘッダ名および値を指定すると、WriteHeader() がそのヘッダを記述します。

   • %Net.MIMEPartOpens in a new tab のインスタンスを指定すると、WriteMIMEBody() が、メッセージの本文を記述します。これは、複数のパートを持つことが可能です。

     メッセージがマルチパートの場合、このメソッドは、ヘッダを記述しません。ユーザの責任でヘッダを記述してください。ただし、メッセージがマルチパートではない場合、メソッドはヘッダを記述します。

   • %Net.MIMEPartOpens in a new tab のインスタンスを指定すると、WriteMIMEMessage() は、すべてのヘッダを含む、MIME メッセージを記述します。

   シングルパートのメッセージの場合、WriteMIMEBody() および WriteMIMEMessage() は、同じ出力を生成します。

完全なメソッド・シグニチャおよびその他の詳細は、%Net.MIMEPartOpens in a new tab のクラス・ドキュメントを参照してください。

例 ： WriteMIMEMessage()

以下の例は、WriteMIMEMessage() の使用法を示しています。

ClassMethod WriteMIMEMessage(text As %String,header as %String) as %Status
{
 Set msg=##class(%Net.MIMEPart).%New()
 Set msg.Body=##class(%GlobalCharacterStream).%New()
 Do msg.Body.Write(text)
 
 //specify some headers
 Set msg.ContentType="text/html"
 Set msg.ContentCharset="us-ascii"
 Do msg.SetHeader("Custom-header",header)
 
 //create MIME writer; write MIME message
 Set writer=##class(%Net.MIMEWriter).%New()
 Set status=writer.WriteMIMEMessage(msg)
 
 If $$$ISERR(status) do $system.Status.DisplayError(status)
 Quit $$$OK
}

以下のターミナル・セッションでは、このメソッドが使用されています。

GNET> Set text = "message text"
 
GNET> Set header="my header value"
 
GNET> Do ##class(GNET.MIME).WriteMIMEMessage(text,header)
CONTENT-TYPE: text/html
Custom-header: my header value
 
message text
 
GNET>

MIME メッセージの読み取り

MIME メッセージを読み取るには、以下のように %Net.MIMEReaderOpens in a new tab を使用します。

1. %Net.MIMEReaderOpens in a new tab クラスのインスタンスを作成します。

2. 入力のソースを指定します。入力のソースを指定するには、リーダ・インスタンスの OpenFile() メソッドまたは OpenStream() メソッドを使用します。

3. リーダ・インスタンスの ReadMIMEMessage() メソッドを呼び出します。このメソッドは、最初の引数として %Net.MIMEPartOpens in a new tab のインスタンスを参照によって返します。これはステータスを返すので、それを確認する必要があります。

完全なメソッド・シグニチャおよびその他の詳細は、%Net.MIMEPartOpens in a new tab のクラス・ドキュメントを参照してください。