SMTP_AddHeader

4D v19

SMTP_AddHeader


SMTP_AddHeader ( smtp_ID ; headerName ; headerText {; deleteOption} ) -> 戻り値

引数	型	説明
smtp_ID	倍長整数	メッセージ参照
headerName	文字	ヘッダ名
headerText	テキスト	ヘッダテキスト
deleteOption	整数	0 = 追加, 1 = すべてのヘッダを'headerName'で置き換え, 2 = 'headerName'ヘッダをすべて取り除く
戻り値	整数	エラーコード

説明

SMTP_AddHeader コマンドは、smtp_IDで参照されるメッセージに独自のヘッダーを追加するために使用します。4D Internet Commandsが提供するさまざまなヘッダー関連のコマンドに加え、二つのカテゴリのヘッダー ('ユーザー定義' と '拡張') があります。SMTP_AddHeader コマンドでは新しいヘッダータグと、それに割り当てるデータ両方の追加が可能です。

拡張ヘッダー: これらのヘッダーはNICにより公式に認証されていて、オリジナルのSMTP使用の後に定義されました。これらのヘッダーはしばしば、さまざまなアプリケーションの動作に影響する特定の機能があります。拡張ヘッダーは"X"から始まっていてはなりません。

ユーザー定義ヘッダー: SMTPプロトコルは、独自のヘッダー定義を許可しています。すべてのユーザー定義ヘッダーは"X-"から始まるべきで、このルールが守られる限り、将来の拡張ヘッダと衝突する心配はありません。ユーザー定義ヘッダーは、通信の両端で開発者がコントロールを行えるようデザインをする際にとても便利です。

ユーザー定義ヘッダーを使用して、開発者はデータをメッセージに格納し、MSG_FindHeader コマンドを使用して簡単にそのデータを取り出すことができます。たとえば"X-001001"という名前のヘッダーを作成し、テーブル1のフィールド1の値を格納することができます。ユーザー定義ヘッダーを使用すれば、情報を追加して、簡単にその情報を取り出すことができます。ボディ部を解析する必要はありません。

smtp_ID はSMTP_New コマンドで作成されるメッセージ参照です。

headerName は追加するヘッダーのヘッダー名です。

headerText はheaderNameヘッダーに割り当てる情報を含むテキスト値です。

警告：テキストにラインフィード (ascii=10)を含んでいてはいけません。含まれていると、それはヘッダー部の終わりかつボディ部の始まりを意味します。これに続くヘッダーはボディ部に押し出され、サーバーやクライアントで正しく解釈されません。ヘッダーについての詳細はRFC#822を参照してください。

注: headerName または headerText が空文字列の場合 (ヘッダーが追加されていない)、このコマンドは何もしません。

deleteOption はオプションの引数で、カレントのヘッダーを追加するか削除するかを指定します。0を指定すると、headerNameをメッセージに追加します。1を指定すると、すべてのヘッダーをheaderNameで置き換えます。この場合headerName が空の文字列なら、すべてのヘッダーが取り除かれます。2を指定すると、headerNameヘッダーを取り除きます。

注: 4D v14以降のInternet Commandsでは、HTMLメッセージを送信したい場合に SMTP_AddHeader を使用して"content-type"を変更する必要がなくなりました。 SMTP_Body コマンドを使用することによってHTMLフォーマットの仕様を直接宣言できるようになりました。これにより"Content-Type"は自動的に"text/html;charset=utf-8"に定義されます(そうでない場合には"Content-Type" はデフォルトで"text/plain;charset=utf-8"に設定されます)。しかしながら、必要な場合においては、SMTP_AddHeader コマンドを使用して"Content-Type" フィールドを強制的に指定する事ができます。この場合、文字コードも必ず指定するようにしてください (デフォルトでは4D ICは常にUTF-8で本文を送信するので、通常は"charset=utf-8"を指定します)。

参照

MSG_FindHeader
SMTP_New