POP3_Login

4D Internet Commands v16

POP3_Login


POP3_Login ( hostName ; userName ; password ; aPOP ; pop3_ID {; sessionParam} ) -> 戻り値

引数	型	説明
hostName	文字	POP3メールサーバのホスト名またはIPアドレス
userName	文字	ユーザ名
password	文字	パスワード
aPOP	整数	0 = クリアテキストログイン, 1 = APOP ログイン
pop3_ID	倍長整数	POP3ログイン参照
sessionParam	倍長整数	1 = SSLを使用, 0または省略 = SSLを使用しない
戻り値	整数	エラーコード

説明

POP3_Login コマンドは、userName とpasswordを使用してPOP3メールサーバにログインします。aPOPに1を指定した場合、APOPメカニズム (RFC#1321) がログインに使用されます。aPOPが0の場合、通常のクリアテキストパスワードログインが実行されます。このコマンドの実行が成功すると、pop3_IDに参照が返されます。

警告： POP3サーバは、対話的な方法でアクセスされるようにはデザインされていません。サーバにログインした後は、必要なアクションを行い、できる限り早くサーバからログアウトすべきです。POP3_LoginとPOP3_Logoutとの間でユーザの指示を待ちうけるような画面を表示させるべきではありません。POP3サーバは特定の時間アクションがない接続を自動で切断します。 POP3のRFCによれば、このタイマは最低30分が想定されています。しかし経験上、ほとんどのサーバはもっと短い時間で接続を切断します。

POP3サーバと通信を行うそれぞれのコマンドは、このタイマをリセットします。POP3_Logout前にサーバが接続をアボートする場合、削除処理はロールバックされます。

hostName はPOP3メールサーバのホスト名またはIPアドレスです。ホスト名の利用をお勧めしますが、必要であればIPアドレスも利用できます。

userName はPOP3メールサーバにログインするためのユーザ名です。userName にはドメイン名を含めるべきではありません。例えば"jack@4d.com"というアドレスでは、userName はおそらく"jack"になります (設定により異なることがあります)。

password はPOP3メールサーバにログインするためのパスワードです。

aPOP は、ログインにAPOPメカニズムを使用するかどうか指定する整数値です。1を指定するとAPOPメカニズムが使用されます。0を渡すとクリアテキストパスワードログインが行われます。デフォルトは0です。

pop3_ID は倍長整数変数で、セッションの参照が返されます。このセッションのアクションを実行する際にこの参照を使用します。

オプションのsessionParam引数を使用すると、接続にSSLプロトコルを使用することができます:

1を渡すと、POP3サーバーへの接続はSSLで行われます (同期モード)、
0を渡すかこの引数を省略すると、接続は標準の非保護モードで行われます。

参照

POP3_Logout