From 91edcb053b3dd0a86ad7cec0a652d084d6e7dd46 Mon Sep 17 00:00:00 2001 From: drbrain Date: Fri, 4 Aug 2006 22:00:31 +0000 Subject: Merge RDoc changes from HEAD. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@10679 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- lib/mailread.rb | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'lib/mailread.rb') diff --git a/lib/mailread.rb b/lib/mailread.rb index 7573d03ed4..08b33c92a4 100644 --- a/lib/mailread.rb +++ b/lib/mailread.rb @@ -1,5 +1,14 @@ +# The Mail class represents an internet mail message (as per RFC822, RFC2822) +# with headers and a body. class Mail + # Create a new Mail where +f+ is either a stream which responds to gets(), + # or a path to a file. If +f+ is a path it will be opened. + # + # The whole message is read so it can be made available through the #header, + # #[] and #body methods. + # + # The "From " line is ignored if the mail is in mbox format. def initialize(f) unless defined? f.gets f = open(f, "r") @@ -34,14 +43,19 @@ class Mail end end + # Return the headers as a Hash. def header return @header end + # Return the message body as an Array of lines def body return @body end + # Return the header corresponding to +field+. + # + # Matching is case-insensitive. def [](field) @header[field.capitalize] end -- cgit v1.2.3