j
= TMail λȤ
e
= TMail Usage
.

j
== TMail γ
e
== Abstruction
.

j
TMail Żҥ᡼򰷤饤֥Ǥ᡼ȥ᡼
ܥåΥϥɥ󥰤äޤŪ᡼κä
ᡢʻȤȤƤϡ֥᡼뤫סֿ᡼
बꤵƤꡢ饤¦ν˶ʤäƤޤ
e
TMail is 90% RFC compatible mail library. By using TMail, You can
get data from internet mail (e-mail) and write data to mail,
without knowning standard details.
.

j
== ᡼뤫

ϰֺǽ˼줿ʬǤꡢTMail ǤդȤǤ
ޤ
e
== Getting information from e-mail
.

j
=== TMail::Mail 饹
e
=== class TMail::Mail
.

j
TMail::Mail 饹ϥ᡼̤ä륪֥ȤǤޤɤˤ
ƤΥ֥ȤʤȤޤ󡣤Υ֥Ȥˡ
̤ꤢޤ

  (1) ʸ󤫤Ĥ
  (2) ե(̾)Ĥ
  (3) Port Ĥ

ʸ󡢥եϤ줾᡼ʬޤǤʤФޤ
ΤǰʲΤ褦˺ޤ
e
At first you must create TMail::Mail object. There's three ways
to create Mail object. First one is "creating from string", second
way is "creating from file (name)". Examples are below:
.
--
require 'tmail'
mail = TMail::Mail.parse(string)    # from String
mail = TMail::Mail.load(filename)   # from file
--
j
ˤäϤʤȻפޤ
.

j
=== Port  Loader
e
=== Port and Loader
.

j
Port ȤΤ TMail ˤ᡼륽ɽǤȤ
Ҥʸե̾᡼륽ǡTMail::Mail#parse  load 
ʸե Port ǥåפ Mail ֥Ȥ
Ƥޤ Port ǥåפ뤳Ȥʸ󡢥ե
(Ūˤ IMAP ץȥ⡩) ΰ㤤äƤޤ

Port 桼ľܺ뤳ȤϤޤʤǤ礦˥桼
Port 򤵤뤳ȤˤʤΤϡ᡼ܥåΥåѡǤ Loader 
ȤȤǤȤ MH ᡼ܥåˤ᡼֤˽
ˤϰʲΤ褦ˤޤ
e
The third way to get TMail::Mail object is using the "port".
"port" is the abstruction of mail sources, e.g. strings or file names.
You can get ports by using mail loaders (TMail::*Loader classes).
Here's simple example:
.
--
require 'tmail'

loader = TMail::MhLoader.new( '/home/aamine/Mail/inbox' )
loader.each_port do |port|
  mail = TMail::Mail.new(port)
  # ....
end
--

j
=== TMail::Mail ֥Ȥ
e
=== Accessing EMail Attributes via TMail::Mail object
.

j
ʾΤ褦ʼʤ TMail::Mail ֥Ȥä顢ȤϤΥ᥽åɤ
Ƥ֤ǤƤΤȤϤǤޤȤ To: ɥ쥹ʤ
e
Now you can get any data from e-mail, by calling methods of
TMail::Mail object. For example, to get To: addresses...
.
--
require 'tmail'
mail = TMail::Mail.parse( 'To: Minero Aoki <aamine@loveruby.net>' )
p mail.to   # => ["aamine@loveruby.net"]
--
j
Subject: ʤ
e
to get subject,
.
--
p mail.subject
--
j
᡼Τʤ
e
to get mail body,
--
p mail.body
--
j
Ȥ褦ˡȤƤñǤ
.

j
ܤ TMail::Mail 饹Υե󥹤
ŪȤƤ sample/from-check.rb 򸫤Ƥ
e
For more TMail::Mail class details, see reference manual.
For more examples, see sample/from-check.rb.
.

j
=== MIME ޥѡȥ᡼

MIME ޥѡȥ᡼ˤбƤޤޥѡȤΤȤ
Mail#multipart? ˤʤꡢ#parts  TMail::Mail ֥Ȥ
ޤ
e
=== MIME multipart mail

TMail also supports MIME multipart mails.
If mail is multipart mail, Mail#multipart? returns true,
and Mail#parts contains an array of parts (TMail::Mail object).
.
--
require 'tmail'
mail = TMail::Mail.parse( multipart_mail_string )
if mail.multipart? then
  mail.parts.each do |m|
    puts m.main_type
  end
end
--
j
ŪȤƤ sample/multipart.rb 򸫤Ƥ
e
For examples, see sample/multipart.rb.
.

j
=== TMail ʤ

TMail ϡإåϼưǥǥɡ󥳡ɤޤ(ʸ)
ѹޤ󡣤ᤤˤ Base64 ΥǥɤϼưǤ
⤷ޤ
e
=== What TMail is NOT

TMail does not touch mail body. Does not decode body,
does not encode body, does not change line terminator.
(I want to support Base64 auto-decoding although.)
.


j
== ᡼

 TMail::Mail 饹ΤǤȤˤ᡼Ф
϶ʸ󤫤顢᡼ܥå˺ꤿϥͳ
ݡȤƤ顢᡼륪֥Ȥޤ
e
== Creating New Mail
.
--
require 'tmail'

# Example 1: create mail on only memory
mail = TMail::Mail.new

# Example 2: create mail on mailbox (on disk)
loader = TMail::MhLoader.new('/home/aamine/Mail/drafts')
mail = TMail::Mail.new( loader.new_port )
--
j
ä顢Ȥޤ
e
then fill headers and body.
.
--
mail.to = 'test@loveruby.net'
mail.from = 'Minero Aoki <aamine@loveruby.net>'
mail.subject = 'test mail'
mail.date = Time.now
mail.mime_version = '1.0'
mail.set_content_type 'text', 'plain', {'charset'=>'iso-2022-jp'}
mail.body = 'This is test mail.'
--
j
ɤΥإå򥻥åȤ餤ʤɺ٤ʬ⤦äȥС
ΤǤޤƤޤ󡣤Ȥꤢ嵭Υإå
åȤۤ褤Ǥ礦ޤֿžξϤޤ줾
󤬤ޤ⥫СΤǤޤƤޤ
С 1.0 ˴ԤƤ

Ǹʸ󲽤ޤ
e
At last, convert mail object to string.
.
--
str = mail.encoded
--
j
ݡȤ˽᤹ʤ顢˰ʲΤ褦ˤޤ
e
If you want to write mails against files directly
(without intermediate string), use Mail#write_back.
.
--
mail.write_back
--
j
write_back ʸ𤹤뤳Ȥʤեľܽ񤭤ߤޤ

ŪȤƤ sample/sendmail.rb 򸫤Ƥ
e
For more examples, see sample/sendmail.rb.
.