From 08a0727577e23ee55ce0eb09a78826f7f7642411 Mon Sep 17 00:00:00 2001 From: aamine Date: Thu, 18 May 2000 08:57:37 +0000 Subject: o protocol.rb, http.rb, smtp.rb, pop.rb: update RD documents git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@701 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- lib/net/pop.rb | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) (limited to 'lib/net/pop.rb') diff --git a/lib/net/pop.rb b/lib/net/pop.rb index a6c002ce0c..1d3e41a54b 100644 --- a/lib/net/pop.rb +++ b/lib/net/pop.rb @@ -28,21 +28,28 @@ Net::Protocol === Class Methods : new( address = 'localhost', port = 110 ) - This method create a new POP3 object. - This will not open connection yet. + creates a new Net::POP3 object. + This method does not open TCP connection yet. +: start( address = 'localhost', port = 110, *protoargs ) +: start( address = 'localhost', port = 110, *protoargs ) {|pop| .... } + equals to Net::POP3.new( address, port ).start( *protoargs ) === Methods : start( account, password ) - This method start POP3. +: start( account, password ) {|pop| .... } + starts POP3 session. -: each{|popmail| ...} + When called as iterator, give a POP3 object to block and + close session after block call is finished. + +: each {|popmail| .... } This method is equals to "pop3.mails.each" : mails - This method returns an array of ((URL:#POPMail)). - This array is renewed when login. + an array of ((URL:#POPMail)). + This array is renewed when session started. =end -- cgit v1.2.3