9.134 MAIL_ADD_ORIGINATOR
注意: 9.1 組み込み関数の規則 利用オプション
この電子メール処理組み込み関数を使用して、現在の電子メールの送信元の名前を追加します。
この関数を呼び出せば、メッセージの送信元を指定することができます。
引数
番号 | タイプ | 必須/任意 | 記述 | 最小長 | 最大長 | 最小小数桁数 | 最大小数桁数 |
|---|---|---|---|---|---|---|---|
1 | A | 必須 | メッセージ送信者の表示名 | 1 | 255 | ||
2 | A | 任意 | 送信者のアドレス このアドレスはプロバイダ特定のメッセージ配布データです。 送信メッセージの場合、ユーザーは、この引数にアドレス帳に含まれていない送信者のアドレス(つまりカスタム送信者)を入力することができます。 デフォルトの動作はメール・システムに特定されます。 | 1 | 255 |
戻り値
番号 | タイプ | 必須/任意 | 記述 | 最小長 | 最大長 | 最小小数桁数 | 最大小数桁数 |
|---|---|---|---|---|---|---|---|
1 | A | 任意 | 戻りコード OK:アクションが完了した ER:エラーが発生した | 2 | 2 |
技術上の注記
- 通常、Windowsシステムのメール・システムでは、送信元として現在のメール・ユーザーが使用されるため、この設定は無視されます。ただしエラーは発生しません。
- IBM i では、メール・メッセージに最低でも1人の送信者が必要です(通常は送信者を1人だけ指定します)。送信者名の指定がない場合、現在のユーザーの電子メールアドレスが使用されます。現在のユーザーは、SNADSディレクトリに登録され、さらにSMTPの別名を持っている必要があります。
- IBM i では、表示名を指定した場合、表示名引数または送信者アドレス引数に、フル電子メール・アドレスを入力します(アドレス・タイプ接頭辞のSMTP:は任意です)。
- MAIL_SEND組み込み関数を使用してメッセージを送信しない限り、電子メール定義の詳細は消えてしまいます。
- エラーが発生した場合、電子メール定義の詳細はすべて消えてしまいます。処理を再開するには、MAIL_STARTを新たに呼び出す必要があります。
例
以下の例では、この関数だけが掲載されています。MAIL_STARTの例を参照してください。その例では、各種組み込み関数を使用して電子メール・メッセージの詳細をすべて定義した後に電子メール・メッセージを送信しています。
注意: テストでこの例を使用する場合、必要な引数に有効な受信者アドレスを挿入する必要があります。
********** COMMENT(Define Message Originator if IBM i)
********** COMMENT(MAPI on non-IBM i usually defaults)
IF COND(*HOST)
USE BUILTIN(MAIL_ADD_ORIGINATOR) WITH_ARGS('SMTP:<-- recipient@address -->') TO_GET(#LEM_RETC)
ENDIF