version 6.8.1
IMAP_Login (hostName; userName; password; imap_ID) --> 整数
引数 | タイプ | 説明 | |
hostName | 文字列 | --> | IMAPサーバのホスト名またはIPアドレス |
userName | 文字列 | --> | ユーザ名 |
password | 文字列 | --> | パスワード |
imap_ID | 倍長整数 | IMAPログイン参照 | |
戻り値 | 整数 | エラーコード |
説明
IMAP_Login コマンドは、ユーザ名とパスワードを使用して、IMAPサーバにログインします。
このログインの結果、他のIMAPコマンドで使用するimap_IDにログイン参照が返されます。
接続はIMAP_Logout コマンドの実行またはIMAPサーバの無動作タイマがタイムアウトしたときに閉じられます。
hostName はIMAPサーバのホスト名またはIPアドレスです。ホスト名の利用を推奨しますが、必要であればIPアドレスを使用することもできます。
userName はIMAPサーバにログインするためのユーザ名です。
password はIMAPサーバにログインするためのパスワードです。
imap_ID は倍長整数変数で、ログイン参照が返されます。この引数には値を受け取るために、倍長整数変数を渡さなくてはなりません。この変数は、このセッションに関連するアクションを行うIMAPコマンドで使用されます。
IMAP_Loginに失敗すると、imap_IDには0が設定されます。
例題
接続シーケンスは以下のようになります:
$ErrorNum:=IMAP_Login (vHost;vUserName;vUserPassword;vImap_ID) If($ErrorNum =0) C_TEXT(vCapability) $ErrorNum:=IMAP_Capability (vImap_ID;vCapability)) … ` IMAP コマンドはvImap_IDを使用する End if $ErrorNum:=IMAP_Logout (vImap_ID)
参照