summaryrefslogtreecommitdiff
path: root/lib/net/pop.rb
diff options
context:
space:
mode:
authoraamine <aamine@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2000-12-22 18:40:55 +0000
committeraamine <aamine@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2000-12-22 18:40:55 +0000
commit79633d3bb8334fc58be49b6d86fcd6a40f569f75 (patch)
tree498e27da2e1e1fc08fc04bf6e7f84a40f51feecc /lib/net/pop.rb
parente6bf7809f399b4602c9b3a2aa4761da0e336fb83 (diff)
aamine
* lib/net/protocol.rb: set @closed false in Socket#reopen. * lib/net/pop.rb: add POP3.foreach, delete_all. * lib/net/pop.rb: add POP3#delete_all. * lib/net/http.rb: add HTTP.version_1_1, version_1_2 * lib/net/http.rb: refactoring. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@1071 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/net/pop.rb')
-rw-r--r--lib/net/pop.rb128
1 files changed, 107 insertions, 21 deletions
diff --git a/lib/net/pop.rb b/lib/net/pop.rb
index a1bcaa8..4f6eb93 100644
--- a/lib/net/pop.rb
+++ b/lib/net/pop.rb
@@ -1,6 +1,6 @@
=begin
-= net/pop.rb version 1.1.31
+= net/pop.rb version 1.1.32
written by Minero Aoki <aamine@dp.u-netsurf.ne.jp>
@@ -25,26 +25,82 @@ Net::Protocol
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 )
+: start( address = 'localhost', port = 110, account, password )
+: start( address = 'localhost', port = 110, account, password ) {|pop| .... }
+ equals to Net::POP3.new( address, port ).start( account, password )
+ # typical usage
+ Net::POP3.start( addr, port, acnt, pass ) do |pop|
+ pop.each_mail do |m|
+ any_file.write m.pop
+ m.delete
+ end
+ end
+
+: foreach( address = 'localhost', port = 110, account, password ) {|mail| .... }
+ starts protocol and iterate for each POPMail object.
+ This method equals to
+
+ Net::POP3.start( address, port, account, password ) do |pop|
+ pop.each do |m|
+ yield m
+ end
+ end
+
+ .
+
+ # typical usage
+ Net::POP3.foreach( addr, nil, acnt, pass ) do |m|
+ m.pop file
+ m.delete
+ end
+
+: delete_all( address = 'localhost', port = 110, account, password )
+: delete_all( address = 'localhost', port = 110, account, password ) {|mail| .... }
+ starts POP3 session and delete all mails.
+ If block is given, iterates for each POPMail object before delete.
+
+ # typical usage
+ Net::POP3.delete_all( addr, nil, acnt, pass ) do |m|
+ m.pop file
+ end
+
=== Methods
: start( account, password )
: start( account, password ) {|pop| .... }
starts POP3 session.
- When called with block, give a POP3 object to block and
- close session after block call is finished.
-
-: each {|popmail| .... }
- This method is equals to "pop3.mails.each"
+ When called with block, gives a POP3 object to block and
+ closes the session after block call finish.
: mails
an array of ((URL:#POPMail)).
This array is renewed when session started.
+: each_mail {|popmail| .... }
+: each {|popmail| .... }
+ is equals to "pop3.mails.each"
+
+: delete_all
+: delete_all {|popmail| .... }
+ deletes all mails.
+ If called with block, gives mails to the block before deleting.
+
+ # example 1
+ # pop and delete all mails
+ n = 1
+ pop.delete_all do |m|
+ File.open("inbox/#{n}") {|f| f.write m.pop }
+ n += 1
+ end
+
+ # example 2
+ # clear all mails on server
+ Net::POP3.start( addr, port, acc, pass ) do |pop|
+ pop.delete_all
+ end
+
: reset
reset the session. All "deleted mark" are removed.
@@ -70,31 +126,33 @@ Object
=== Methods
-: all( dest = '' )
-: pop
-: mail
+: pop( dest = '' )
This method fetches a mail and write to 'dest' using '<<' method.
# usage example
mailarr = []
POP3.start( 'localhost', 110 ) do |pop|
- pop.each do |popm|
+ pop.each_mail do |popm|
mailarr.push popm.pop # all() returns 'dest' (this time, string)
# or, you can also
# popm.pop( $stdout ) # write mail to stdout
+
+ # maybe you also want to delete mail after popping
+ popm.delete
end
end
-: all {|str| .... }
- You can call all/pop/mail with block.
- argument 'str' is a read string (a part of mail).
+: pop {|str| .... }
+ If pop() is called with block, it gives the block part strings of a mail.
# usage example
- POP3.start( 'localhost', 110 ) do |pop|
- pop.mails[0].pop do |str| # pop only first mail...
- _do_anything_( str )
+ POP3.start( 'localhost', 110 ) do |pop3|
+ pop3.each_mail do |m|
+ m.pop do |str|
+ # do anything
+ end
end
end
@@ -129,6 +187,25 @@ module Net
protocol_param :mail_type, '::Net::POPMail'
+ class << self
+
+ def foreach( address = nil, port = nil,
+ account = nil, password = nil, &block )
+ start( address, port, account, password ) do |pop|
+ pop.each_mail( &block )
+ end
+ end
+
+ def delete_all( address = nil, port = nil,
+ account = nil, password = nil, &block )
+ start( address, port, account, password ) do |pop|
+ pop.delete_all( &block )
+ end
+ end
+
+ end
+
+
def initialize( addr = nil, port = nil )
super
@mails = nil
@@ -136,9 +213,18 @@ module Net
attr :mails
- def each( &block )
+ def each_mail( &block )
io_check
- @mails.each &block
+ @mails.each( &block )
+ end
+
+ alias each each_mail
+
+ def delete_all
+ @mails.each do |m|
+ yield m if block_given?
+ m.delete unless m.deleted?
+ end
end
def reset