IMAP_Login

4D v20

IMAP_Login


IMAP_Login ( hostName ; userName ; password ; imap_ID {; sessionParam} ) -> 戻り値

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

説明

IMAP_Login コマンドは、ユーザ名とパスワードを使用して、IMAPサーバにログインします。

このログインの結果、imap_IDに他のIMAPコマンドで使用するログイン参照が返されます。

接続はIMAP_Logout コマンドの実行またはIMAPサーバの無動作タイマがタイムアウトしたときに閉じられます。

hostName はIMAPサーバのホスト名またはIPアドレスです。ホスト名の利用を推奨しますが、必要であればIPアドレスを使用することもできます。

userName はIMAPサーバにログインするためのユーザ名です。

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

imap_ID は倍長整数変数で、ログイン参照が返されます。この引数には値を受け取るために、倍長整数変数を渡さなくてはなりません。この変数は、このセッションに関連するアクションを行うIMAPコマンドで使用されます。

IMAP_Loginに失敗すると、imap_IDには0が設定されます。

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

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

例題

典型的な接続処理は以下の通りです:

 $ErrorNum:=IMAP_Login(vHost;vUserName;vUserPassword;vImap_ID;1)

 If($ErrorNum =0)

    C_TEXT(vCapability)

    $ErrorNum:=IMAP_Capability(vImap_ID;vCapability)

    … ` vImap_ID引数を使用するIMAPコマンドを実行

 End if

 $ErrorNum:=IMAP_Logout(vImap_ID)

参照

IMAP_Logout
IMAP_VerifyID