diff options
author | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2011-05-16 22:09:23 +0000 |
---|---|---|
committer | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2011-05-16 22:09:23 +0000 |
commit | a13b23973aeb23bfb78d6082fb6d66759f26efd2 (patch) | |
tree | d2dfb5660101ec53194e74b7ea68c2c183d5c9fe | |
parent | 3257aa8f8f9745c1da1ec81c2f4eeeb723e6a56f (diff) | |
download | ruby-a13b23973aeb23bfb78d6082fb6d66759f26efd2.tar.gz |
* lib/net/pop.rb: Improve documentation. Patch by Vincent Batts.
[Ruby 1.9 - Bug #4711]
* lib/net/telnet.rb: ditto
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31602 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
-rw-r--r-- | ChangeLog | 6 | ||||
-rw-r--r-- | lib/net/pop.rb | 21 | ||||
-rw-r--r-- | lib/net/telnet.rb | 1 |
3 files changed, 28 insertions, 0 deletions
@@ -1,3 +1,9 @@ +Tue May 17 07:09:01 2011 Eric Hodel <drbrain@segment7.net> + + * lib/net/pop.rb: Improve documentation. Patch by Vincent Batts. + [Ruby 1.9 - Bug #4711] + * lib/net/telnet.rb: ditto + Tue May 17 07:00:41 2011 Eric Hodel <drbrain@segment7.net> * lib/net/http.rb: Fix nodoc for Net::HTTP::version_1_1?. Patch by diff --git a/lib/net/pop.rb b/lib/net/pop.rb index 6a45e3b5f0..87c921bf87 100644 --- a/lib/net/pop.rb +++ b/lib/net/pop.rb @@ -196,12 +196,14 @@ module Net # class POP3 < Protocol + # svn revision of this library Revision = %q$Revision$.split[1] # # Class Parameters # + # returns the port for POP3 def POP3.default_port default_pop3_port() end @@ -333,6 +335,7 @@ module Net @ssl_params = create_ssl_params(*args) end + # Constructs proper parameters from arguments def POP3.create_ssl_params(verify_or_params = {}, certs = nil) begin params = verify_or_params.to_hash @@ -355,18 +358,24 @@ module Net @ssl_params = nil end + # returns the SSL Parameters + # + # see also POP3.enable_ssl def POP3.ssl_params return @ssl_params end + # returns +true+ if POP3.ssl_params is set def POP3.use_ssl? return !@ssl_params.nil? end + # returns whether verify_mode is enable from POP3.ssl_params def POP3.verify return @ssl_params[:verify_mode] end + # returns the :ca_file or :ca_path from POP3.ssh_params def POP3.certs return @ssl_params[:ca_file] || @ssl_params[:ca_path] end @@ -452,6 +461,7 @@ module Net end end + # Disable SSL for all new instances. def disable_ssl @ssl_params = nil end @@ -530,6 +540,7 @@ module Net end end + # internal method for Net::POP3.start def do_start(account, password) s = timeout(@open_timeout) { TCPSocket.open(@address, port) } if use_ssl? @@ -565,6 +576,7 @@ module Net end private :do_start + # Does nothing def on_connect end private :on_connect @@ -575,6 +587,11 @@ module Net do_finish end + # nil's out the: + # - mails + # - number counter for mails + # - number counter for bytes + # - quits the current command, if any def do_finish @mails = nil @n_mails = nil @@ -588,6 +605,9 @@ module Net end private :do_finish + # Returns the current command. + # + # Raises IOError if there is no active socket def command raise IOError, 'POP session not opened yet' \ if not @socket or @socket.closed? @@ -687,6 +707,7 @@ module Net @mails.each {|m| m.uid = uidl[m.number] } end + # deguging output for +msg+ def logging(msg) @debug_output << msg + "\n" if @debug_output end diff --git a/lib/net/telnet.rb b/lib/net/telnet.rb index a8ded93b9d..c25930c48b 100644 --- a/lib/net/telnet.rb +++ b/lib/net/telnet.rb @@ -754,6 +754,7 @@ module Net line end + # Closes the connection def close @sock.close end |