summaryrefslogtreecommitdiff
path: root/lib/net/pop.rb
diff options
context:
space:
mode:
authormatz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>1999-10-13 07:29:15 +0000
committermatz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>1999-10-13 07:29:15 +0000
commitec8a9bba354e3bcdb7b7b004d3ce3d148bd9fc7f (patch)
treec159d8a62f8328d5c3a962b13e8c2b96c64b316d /lib/net/pop.rb
parent2e23ebc601fd5c8d7de232e470e2374df8888d11 (diff)
maillib-1.0.2
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@541 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/net/pop.rb')
-rw-r--r--lib/net/pop.rb207
1 files changed, 198 insertions, 9 deletions
diff --git a/lib/net/pop.rb b/lib/net/pop.rb
index bd45515..c492a4c 100644
--- a/lib/net/pop.rb
+++ b/lib/net/pop.rb
@@ -1,8 +1,14 @@
-#
-# pop.rb version 1.0.1
-#
-# author: Minero Aoki <aamine@dp.u-netsurf.ne.jp>
-#
+=begin
+
+= Net module version 1.0.2 reference manual
+
+pop.rb written by Minero Aoki <aamine@dp.u-netsurf.ne.jp>
+
+This library is distributed under the terms of Ruby style license.
+You can freely distribute/modify/copy this file.
+
+=end
+
require 'net/session'
require 'md5'
@@ -10,8 +16,44 @@ require 'md5'
module Net
+=begin
+
+== Net::POP3Session
+
+=== Super Class
+
+Net::Session
+
+=== Class Methods
+
+: new( address = 'localhost', port = 110 )
+
+ This method create a new POP3Session object but this will not open connection.
+
+=end
+
class POP3Session < Session
+
+=begin
+
+=== Methods
+
+: start( account, password )
+
+ This method start POP session.
+
+: each{|popmail| ...}
+
+ This method is equals to "POP3Session.mails.each"
+
+: mails
+
+ This method returns an array of <a href="#popi">POP3Session::POPMail</a>.
+ This array is renewed when login.
+
+=end
+
attr :mails
def each() @mails.each{|m| yield m} end
@@ -44,6 +86,17 @@ module Net
end
+=begin
+
+== Net::POP3Session::POPMail
+
+A class of mail which exists on POP server.
+
+=== Super Class
+
+Object
+
+=end
class POPMail
@@ -55,6 +108,39 @@ module Net
@deleted = false
end
+=begin
+
+=== Method
+
+: all
+: pop
+: mail
+
+ This method fetches a mail and return it.
+
+: header
+
+ This method fetches only mail header.
+
+: top( lines )
+
+ This method fetches mail header and 'lines' lines body.
+
+: delete
+: delete!
+
+ This method deletes mail.
+
+: size
+
+ size of mail(bytes)
+
+: deleted?
+
+ true if mail was deleted
+
+=end
+
attr :size
def all( dest = '' )
@@ -83,8 +169,23 @@ module Net
end
- end
+ end # POP3Session
+
+ POPSession = POP3Session
+ POP3 = POP3Session
+
+=begin
+
+== Net::APOP3Session
+
+This class has no new methods. Only way of authetication is changed.
+
+=== Super Class
+
+Net::POP3Session
+
+=end
class APOPSession < POP3Session
@@ -95,14 +196,85 @@ module Net
end
+ APOP = APOPSession
- POPSession = POP3Session
- POP3 = POP3Session
+=begin
+
+== Net::POP3Command
+
+POP3 protocol class.
+
+=== Super Class
+
+Net::Command
+
+=== Class Methods
+: new( socket )
+
+ This method creates new POP3Command object. 'socket' must be ProtocolSocket.
+
+=end
class POP3Command < Command
+
+=begin
+
+=== Methods
+
+: auth( account, password )
+
+ This method do POP authorization (no RPOP)
+ In case of failed authorization, raises Protocol::ProtocolError exception.
+
+: list
+
+ a list of mails which existing on server.
+ The list is an array like "array[ number ] = size".
+
+ ex:
+
+ The list from server is
+
+ 1 2452
+ 2 3355
+ 4 9842
+ :
+
+ then, an array is
+
+ [ nil, 2452, 3355, nil, 9842, ... ]
+
+: quit
+
+ This method finishes POP3 session.
+
+: rset
+
+ This method reset all changes done in current session,
+ by sending 'RSET' command.
+
+: top( num, lines = 0 )
+
+ This method gets all mail header and 'lines' lines body
+ by sending 'TOP' command. 'num' is mail number.
+
+ WARNING: the TOP command is 'Optional' in RFC1939 (POP3)
+
+
+: retr( num : Integer )
+
+ This method gets a mail by 'RETR' command. 'num' is mail number.
+
+
+: dele( num : Integer )
+
+ This method deletes a mail on server by 'DELE'.
+
+=end
+
def auth( acnt, pass )
@socket.writeline( 'USER ' + acnt )
check_reply_auth
@@ -190,6 +362,23 @@ module Net
end
+=begin
+
+== APOPCommand
+
+=== Super Class
+
+POP3
+
+=== Methods
+
+: auth( account, password )
+
+ This method do authorization by sending 'APOP' command.
+ If server is not APOP server, this raises Net::ProtoAuthError exception.
+ On other errors, raises Net::ProtocolError.
+
+=end
class APOPCommand < POP3Command
@@ -223,7 +412,7 @@ module Net
end
- unless Session::Version == '1.0.1' then
+ unless Session::Version == '1.0.2' then
$stderr.puts "WARNING: wrong version of session.rb & pop.rb"
end