version 6.5
SMTP_Comments (smtp_ID; comments{; deleteOption}) --> 整数
引数 | タイプ | 説明 | |
smtp_ID | 倍長整数 | --> | メッセージ参照 |
comments | テキスト | --> | コメントテキスト |
deleteOption | 整数 | --> | 0 = 置き換え (commentsが空でない場合), |
1 = 置き換え, 2 = 削除 | |||
戻り値 | 整数 | エラーコード |
説明
SMTP_Comments コマンドは、メッセージボディに変更を加えずに、メッセージにコメントを追加する方法を提供します。コメントはメッセージのヘッダ部にのみ現れます。多くのメールアプリケーションはメッセージヘッダをユーザに表示しません。
smtp_ID はSMTP_New コマンドで作成されるメッセージ参照です。
comments は、メールヘッダに置く情報を含んだテキストです。
警告: テキストにラインフィード (ascii=10)を含んでいてはいけません。含まれていると、それはヘッダ部の終わりかつボディ部の始まりを意味します。これに続くヘッダはボディ部に押し出され、サーバやクライアントで正しく解釈されません。ヘッダについての詳細はRFC#822を参照してください。
deleteOption は"Comments"ヘッダを置き換えるか削除するか指定する整数値です:
・0を指定すると、以前の値を置き換えて、"Comments" フィールドに新しい値を設定します。(空の文字列をcommentsに指定すると、以前のヘッダが保持されます。)
・1を指定すると、以前の値を置き換えて、"Comments" フィールドに新しい値を設定します。(空の文字列をcommentsに指定すると、ヘッダが削除されます。)
・2を指定すると、"Comments" フィールドに設定されていた値が削除され、ヘッダがメッセージから取り除かれます。
deleteOption はオプションの引数で、指定しない場合の値はデフォルトで0です。
例題
SMTP_Bodyコマンドの例題を参照してください。
参照