●AS-POP3オンラインマニュアル
|
- 基本的なプログラム手順
- プロパティ
- メソッド
- イベント
- エラーコード
|
1. 基本的なプログラム手順
|
・このソフトウエアはSMTP送信前にPOP3にて認証するPOP Before SMTP機能をサポートします。
|
【プログラム手順】
・オブジェクトのインスタンスを生成します。
-------------------------------------------------------------
(例:VB/VBAの場合)
Set objPop3 = CreateObject("ASLib2.POP3")
Set objPop3 = New ASLib2.POP3
(例:ASP VBScriptの場合)
Set objPop3 = Server.CreateObject("ASLib2.POP3")
(例:ASP JScriptの場合)
var objPop3 = new ActiveXObject('ASLib2.POP3');
(例:WSH VBScriptの場合)
Set objPop3 = WScript.CreateObject("ASLib2.POP3")
(例:WSH JScriptの場合)
var objPop3 = WScript.CreateObject('ASLib2.POP3');
-------------------------------------------------------------
※Version1.0をご利用の場合は、上記記述内のASLib2をASLibとして下さい。
・POP3ユーザ名・POP3パスワードプロパティを設定し、POP3ログインのためのパラメータを設定します。
-------------------------------------------------------------
(例:VBScriptでPOP3ユーザプロパティを"username"に設定する場合)
objPop3.POP3User = "username"
-------------------------------------------------------------
・メソッドを順次呼び出し、POP3サーバと通信を行います。
※Connect→LOGIN→STAT→QUITの順に呼び出します。
※非同期の場合にはOnCommandFinishイベントでコマンドの終了が通知されます。
-------------------------------------------------------------
(例:VBScriptでPOP3サーバ"ServerName"へConnectする場合)
Dim iret
iret = objPop3.Connect("ServerName")
-------------------------------------------------------------
・オブジェクトの解放が必要な場合は解放します。
-------------------------------------------------------------
(例:VBScriptの場合)
Set objPop3 = Nothing
-------------------------------------------------------------
|
2. プロパティ
|
|
データ型
|
(VC)long
(VB)Long
|
|
既定値
|
110
|
|
説明
|
POP3サーバのポート番号を指定します。
|
|
使用例
|
objPop3.Port = 110
|
|
|
データ型
|
(VC)long
(VB)Long
|
|
既定値
|
20(20秒)
|
|
説明
|
POP3サーバ通信時のタイムアウト秒数を指定します。
|
|
使用例
|
(通信タイムアウトを40秒とする)
objPop3.RecvTimeout = 40
|
|
|
データ型
|
(VC)long
(VB)Long
|
|
既定値
|
0(同期モード)
|
|
説明
|
POP3サーバ通信の同期/非同期を指定します。
0:同期モード
1:非同期モード
※同期の場合は対応するメッセージをサーバから受信するまで戻りませんが、非同期の場合はすぐに処理が戻ります。
※非同期の場合は対応するメッセージを受信するとOnCommandFinishイベントが発生します。ASPなどイベント非対応のプラットフォームの場合は同期モードで使用してください。
|
|
使用例
|
(POP3サーバとの通信を非同期モードにする)
objPop3.Sync = 1
|
|
|
データ型
|
(VC)BSTR
(VB)String
|
|
既定値
|
なし
|
|
説明
|
POP3認証を使用する際のユーザアカウントを指定します。
※LOGINメソッドで使用します。
|
|
使用例
|
(POP3認証用のアカウントを"Username"に設定する)
objPop3.POP3PUser = "Username"
|
|
|
データ型
|
(VC)BSTR
(VB)String
|
|
既定値
|
なし
|
|
説明
|
POP3認証を使用する際のパスワードを指定します。
※LOGINメソッドで使用します。
|
|
使用例
|
(POP3認証用のパスワードを"Password"に設定する)
objPop3.POP3User = "Password"
|
|
|
データ型
|
(VC)BSTR
(VB)String
|
|
既定値
|
なし
|
|
説明
|
POP3サーバから受信したメッセージを取得します。
正常終了時:"+OK"
エラー時:"-ERR"
※取得のみ可能。(設定不可)
|
|
使用例
|
(POP3サーバからのメッセージを取得する)
strMsg = objPop3.POP3msg
|
|
|
データ型
|
(VC)BSTR
(VB)String
|
|
既定値
|
なし
|
|
説明
|
POP3サーバから受信した拡張メッセージを取得します。
※取得のみ可能。(設定不可)
|
|
使用例
|
(POP3サーバからの拡張メッセージを取得する)
strMsgExt = objPop3.POP3msgExt
|
|
|
データ型
|
(VC)long
(VB)Long
|
|
既定値
|
なし
|
|
説明
|
Winsockでエラーが発生した場合のWinsockのエラーコードを取得します。
※取得のみ可能。(設定不可)
|
|
使用例
|
(Winsockのエラーコードを取得する)
lngLastError = objPop3.LastError
|
|
3. メソッド
・指定されたPOP3サーバとの通信を行います。
・非同期指定の場合はすぐに処理が戻り、POP3サーバからの応答を受信するとOnCommandFinishイベントが発生します。
・同期の場合はPOP3サーバからの応答を受信するまで待ちます。
|
|
|
機能概要
|
指定POP3サーバにコネクトします。
|
|
記述形式
|
lngret = objPop3.Connect(strServerName)
|
|
引数・戻り値
|
strServerName [in]:接続するPOP3サーバホスト名、又はIPアドレス文字列
lngret [out]:正常終了時0を返す
|
|
説明
|
指定されたPOP3サーバにコネクトします。
引数にはホスト名、もしくはIPアドレス文字列を指定して下さい。
Connect成功時には0を返します。
|
|
使用例(VB)
|
lngret = objPop3.Connect("servername")
lngret = objPop3.Connect("192.168.0.1")
|
|
|
機能概要
|
POP3Userプロパティ、POP3Passプロパティを使用して、
指定POP3サーバにログインします。
|
|
記述形式
|
lngret = objPop3.LOGIN()
|
|
引数・戻り値
|
lngret [out]:正常終了時0を返す
|
|
説明
|
POP3Userプロパティ、POP3Passプロパティを使用してPOP3サーバにログインします。
ログイン成功時には0を返します。
|
|
使用例(VB)
|
lngret = objPop3.LOGIN()
|
|
|
機能概要
|
指定POP3サーバにSTATコマンドを送信し、メールボックス内のメール数と全体データ量(バイト数)を問い合わせます。
|
|
記述形式
|
lngret = objPop3.STAT()
|
|
引数・戻り値
|
lngret [out]:正常終了時0を返す
|
|
説明
|
指定POP3サーバにSTATコマンドを送信し、メールボックス内のメール数と全体データ量(バイト数)を問い合わせます。問い合わせに成功するとPOP3msgExtプロパティに メール数 バイト数が設定されます
|
|
使用例(VB)
|
lngret = objPop3.STAT()
|
|
|
機能概要
|
指定POP3サーバにQUITコマンドを送信し、コネクションを切断します。
|
|
記述形式
|
lngret = objPop3.QUIT()
|
|
引数・戻り値
|
lngret [out]:正常終了時0を返す
|
|
説明
|
指定POP3サーバにQUITコマンドを送信し、コネクションを切断します。
|
|
使用例(VB)
|
lngret = objPop3.QUIT()
|
|
4. イベント
|
|
機能概要
|
非同期でPOP3コマンドを発行するメソッドを実行した場合、メソッドの終了を通知します。
|
|
引数
|
lResult [in]:正常終了時0を返す
|
|
説明
|
非同期でPOP3コマンドを発行するメソッドを実行した場合、メソッドの終了を通知します。
lResultにはエラー時はエラーコードが返ります。
|
|
使用例(VB)
|
Private Sub objPop3_OnCommandFinish(ByVal lResult As Long)
※詳しくはサンプルをご覧下さい。
|
|
5. エラーコード
|
・各メソッド・イベントから返されるエラーコードとエラーメッセージの一覧です。
|
|
エラーコード
|
エラー内容
|
-10000
|
メモリ確保に失敗しました。
|
-20001
|
ソケットの生成に失敗しました。
※固有のエラーコードはLastErrorプロパティに設定されます。
※固有のエラーコード内容については、Winsockライブラリのsocket関数のエラーコードを参照して下さい。
|
-20002
|
ホスト名からIPアドレスの取得に失敗しました。
※固有のエラーコードはLastErrorプロパティに設定されます。
※固有のエラーコード内容については、Winsockライブラリのgethostbyname関数のエラーコードを参照して下さい。
|
-20003
|
ソケットエラーが発生しました。
※固有のエラーコードはLastErrorプロパティに設定されます。
※固有のエラーコード内容については、Winsockライブラリのconnect関数、又はselect関数のエラーコードを参照して下さい。
|
-20005
|
POP3コマンドの送信でエラーが発生しました。
※固有のエラーコードはLastErrorプロパティに設定されます。
※固有のエラーコード内容については、Winsockライブラリのsend関数のエラーコードを参照して下さい。
|
-20006
|
POP3サーバからのメッセージ受信でエラーが発生しました。
※固有のエラーコードはLastErrorプロパティに設定されます。
※固有のエラーコード内容については、Winsockライブラリのrecv関数のエラーコードを参照して下さい。
|
-20008
|
POP3サーバから切断されました。
※固有のエラーコードはLastErrorプロパティに設定されます。
※固有のエラーコード内容については、Winsockライブラリのrecv関数のエラーコードを参照して下さい。
|
-20010
|
POP3サーバとの通信がタイムアウトしました。
|
-20011
|
イベントのウィンドウメッセージで通知設定に失敗しました。(非同期時のみ)
|
-20012
|
ソケットイベントの通知でエラーが発生しました。(非同期時のみ)
※固有のエラーコードはLastErrorプロパティに設定されます。
※固有のエラーコード内容については、WinsockライブラリのWSAAsyncSelect関数のエラーコードを参照して下さい。
|
-60001
|
POP3サーバがエラー("-ERR")を返しました。
|
-60002
|
POP3サーバが想定外のエラー("-ERR"以外)を返しました。
|
|