class TMail::Mail new( port: TMail::Port = TMail::StringPort.new, strict = false ) -< TMail::Mail
creates a new TMail::Mail object from port.
raises TMail::SyntaxError exception on parse error,
if strict is true. ignores error if strict is false.
load( filename: String ) -< TMail::Mail
creates a new TMail::Mail object. filename is the name of file
which contains just one mail (e.g. MH mail file).
parse( str: String ) -< TMail::Mail
parses str and creates a new TMail::Mail object.
port -< TMail::Portthe source port of this mail.
body_port -< TMail::Portthe port to save body of this mail.
each {|line| .... }iterates for each lines of mail body.
body -< Stringpreamble -< Stringthe mail body. If the mail is a MIME multipart mail, this attribute represents "preamble".
parts -< Array of TMail::Mailparts of this mail. (valid only if this mail is a MIME multipart mail)
epilogue -< StringIf the mail was MIME multipart mail, this represent "epilogue" string. Else, empty string.
multipart?encoded( eol = "\n", encoding = 'j' ) -< Stringconverts the mail object to a MIME encoded string.
decoded( eol = "\n", encoding = 'e' ) -< Stringto_s( eol = "\n", encoding = 'e' ) -< Stringconverts the mail object to a decoded string.
inspect -< String
returns simple string representation like
"#<TMail::Mail port=<StringPort:str=...>>"
write_back( eol = "\n", encoding = 'e' )
converts this mail into string and write back to body_port,
setting line terminator to eol.
date( default = nil ) -< Timedate=( datetime: Time )a time object of Date: header field.
strftime( format: String, default = nil ) -< String
is equals to date.strftime(format).
If date is not exist, this method does nothing and
returns default.
to( default = nil ) -< Array of Stringto=( addrs: String/Array of String )address specs for To: header field.
to_addrs( default = nil ) -< Array of TMail::Addressto_addrs=( addrs: TMail::Address/Array of TMail::Address )adresses which is represented in To: header field.
cc( default = nil ) -< Array of Stringcc=( addrs: String/Array of String )address specs for Cc: header field.
cc_addrs( default = nil ) -< Array of TMail::Addresscc_addrs=( addrs: TMail::Address/Array of TMail::Address )adresses which is represented in Cc: header field.
bcc( default = nil ) -< Array of Stringbcc=( addrs: String/Array of String )address specs for Bcc: header field.
bcc_addrs( default = nil ) -< Array of TMail::Addressbcc_addrs=( addrs: TMail::Address/Array of TMail::Address )adresses which is represented in Bcc: header field.
from( default = nil ) -< Array of Stringfrom=( addrs: String/Array of String )address specs for From: header field.
from_addrs( default = nil ) -< Array of TMail::Addressfrom_addrs=( addrs: TMail::Address/Array of TMail::Address )adresses which is represented in From: header field.
friedly_from( default = nil ) -< Stringa phrase part or address spec of first From: address.
reply_to( default = nil ) -< Array of Stringreply_to=( addrs: String/Array of String )address specs for Reply-To: header field.
reply_to_addrs( default = nil ) -< Array of TMail::Addressreply_to_addrs=( addrs: TMail::Address/Array of TMail::Address )adresses which is represented in Reply-To: header field.
sender( default = nil ) -< Stringsender=( addr: String )address spec for Sender: header field.
sender_addr( default = nil ) -< TMail::Addresssender_addr=( addr: TMail::Address )adress which is represented in Sender: header field.
subject( default = nil ) -< Stringsubject=( sbj: String )Subject: string.
message_id( default = nil ) -< Stringmessage_id=( id: String )message id string.
in_reply_to( default = nil ) -< Array of Stringin_reply_to=( ids: String/Array of String )message IDs of replying mails.
references( default = nil ) -< Array of Stringreferences=( refs: String/Array of String )message IDs of all referencing (replying) mails.
mime_version( default = nil ) -< Stringmime_version=( ver: String )used MIME version
set_mime_version( major: Integer, minor: Integer )set MIME version from integers.
main_type( default = nil ) -< Stringmain content type.
sub_type( default = nil ) -< Stringsub content type (e.g. "plain")
set_content_type( main: String, sub: String, params: Hash = nil )set Content-type: header as "main/sub; param=val; param=val; ...".
multipart?judge if this mail is MIME multi part mail, by inspecting Content-Type: header field.
transfer_encoding( default = nil ) -< Stringtransfer_encoding=( str: String )Content-Transfer-Encoding. (e.g. "7bit" "Base64")
disposition( default = nil ) -< Stringdisposition=( field: String )Content-Disposition main value. e.g. "attach"
set_content_disposition( pos: String, params: Hash = nil )set content disposition. params is a hash like {"name"=>"value"}.
destinations( default = nil ) -< Array of Stringall address specs which are represented in To:, Cc: and Bcc: header fields.
reply_addresses( default = nil ) -< Array of TMail::Addressaddresses to reply.
error_reply_addresses( default = nil ) -< Array of TMail::Addressaddresses to use when returning error message.
clearclears all header.
keys -< Array of TMail::HeaderFieldreturns an array of contained header names.
[]( name ) -< TMail::HeaderFieldreturns a header field object corresponding to the case-insensitive key name. e.g. mail["To"]
[]=( name, field )set name header field to field.
delete( key )deletes header corresponding to case-insensitive key key.
delete_if {|key, val| .... }evaluates block with a name of header and header field object, and delete the header if block returns true.
each_header {|name, field| .... }each_pair {|name, field| .... }iterates for each header name and its field object.
each_header_name {|name| .... }each_key {|name| .... }iterates for each contained header names.
each_field {|field| .... }each_value {|field| .... }iterates for each header field object.
orderd_each {|name, field| .... }key?( name )returns true if the mail has name header.
value?( field )returns true if the mail has field header field object.
indexes( *keys ) -< Array of TMail::HeaderFieldindices( *keys ) -< Array of TMail::HeaderField
equals to keys.collect {|k| mail[k] }.
values -< Array of TMail::HeaderFieldreturns an array of all header field object.