diff options
| author | gsinclair <gsinclair@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-05-09 13:42:05 +0000 |
|---|---|---|
| committer | gsinclair <gsinclair@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-05-09 13:42:05 +0000 |
| commit | d31210ccbd28a7873aa5db8f34ea87275dc62269 (patch) | |
| tree | 07eec8a8d97df96f930054d556e3a93881887cfd /lib/net/imap.rb | |
| parent | 3dbd32a2144af170378d0b5713a828dad6c976fb (diff) | |
* lib/net/ftp.rb: improved documentation
* lib/net/imap.rb: ditto
* lib/net/pop.rb: ditto
* lib/net/smtp.rb: ditto
* lib/net/telnet.rb: ditto
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@6281 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/net/imap.rb')
| -rw-r--r-- | lib/net/imap.rb | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/lib/net/imap.rb b/lib/net/imap.rb index 0845009813..27936746c6 100644 --- a/lib/net/imap.rb +++ b/lib/net/imap.rb @@ -7,7 +7,9 @@ # You can freely distribute/modify this library. # # Documentation: Shugo Maeda, with RDoc conversion and overview by William -# Webber. +# Webber. +# +# See Net::IMAP for documentation. # @@ -19,13 +21,13 @@ begin rescue LoadError end -module Net # :nodoc: +module Net # # Net::IMAP implements Internet Message Access Protocol (IMAP) client # functionality. The protocol is described in [IMAP]. # - # == IMAP OVERVIEW + # == IMAP Overview # # An IMAP client connects to a server, and then authenticates # itself using either #authenticate() or #login(). Having @@ -63,7 +65,7 @@ module Net # :nodoc: # UIDs have to be reassigned. An IMAP client cannot thus # rearrange message orders. # - # == EXAMPLES OF USAGE + # == Examples of Usage # # === List sender and subject of all recent messages in the default mailbox # @@ -89,7 +91,7 @@ module Net # :nodoc: # end # imap.expunge # - # == THREAD-SAFENESS + # == Thread Safety # # Net::IMAP supports concurrent threads. For example, # @@ -103,7 +105,7 @@ module Net # :nodoc: # # This script invokes the FETCH command and the SEARCH command concurrently. # - # == ERRORS + # == Errors # # An IMAP server can send three different types of responses to indicate # failure: |