start(address, port = nil, account=nil, password=nil, isapop=false) -> Net::POP3
[permalink][rdoc][edit]start(address, port = nil, account=nil, password=nil, isapop=false) {|pop| .... } -> object
-
Net::POP3 オブジェクトを生成し、サーバへ接続します。
ブロックを与えない場合には生成したオブジェクトを返します。
ブロックを与えた場合には、生成した Net::POP3 オブジェクトがブロックに渡され、ブロックが終わったときにセッションを終了させます。この場合返り値はブロックの返り値となります。
port に nil を渡すと、適当なポート(通常は110、SSL利用時には 995)を使います。
以下のコードと同じ動作をします。
require 'net/pop' Net::POP3.new(address, port, isapop).start(account, password)
使用例:
require 'net/pop' Net::POP3.start(addr, port, account, password) {|pop| pop.each_mail do |m| file.write m.pop m.delete end }
- [PARAM] address:
- POP3サーバのホスト名文字列
- [PARAM] port:
- 接続するPOP3サーバのポート番号
- [PARAM] account:
- アカウント名文字列
- [PARAM] password:
- パスワード文字列
- [PARAM] isapop:
- 真でAPOPを利用します
- [EXCEPTION] TimeoutError:
- 接続がタイムアウトした場合に発生します
- [EXCEPTION] Net::POPAuthenticationError:
- 認証に失敗した、もしくはAPOPを利用しようとしたがサーバがAPOPを提供していない場合に発生します
- [EXCEPTION] Net::POPError:
- サーバが認証失敗以外のエラーを報告した場合に発生します
- [EXCEPTION] Net::POPBadResponse:
- サーバからの応答がプロトコル上不正であった場合に発生します
[SEE_ALSO] Net::POP3#start