NAME

Mail::ISO2022JP - compose ISO-2022-JP encoded email

SYNOPSIS

  use Mail::ISO2022JP;
  
  $mail = Mail::ISO2022JP->new;
  $mail->set('From_addr', 'taro@cpan.tld');
  $mail->set('To_addr'  , 'sakura@cpan.tld, yuri@cpan.tld');
  # mail subject containing Japanese characters.
  $mail->set('Subject'  , 'Subject_Containing_Japanese_Characters');
  # mail body    containing Japanese characters.
  $mail->set('Body'     , 'Body_Containing_Japanese_Characters');
  # output the composed mail
  print $mail->compose;

DESCRIPTION

This module is mainly for Japanese Perl programmers those who wants to compose an email.

For some reasons, most Japanese internet users have chosen ISO-2022-JP 7bit character encoding for email rather than the other 8bit encodings (eg. EUC-JP, Shift_JIS).

We can use ISO-2022-JP encoded Japanese text as message body safely in an email.

But we should not use ISO-2022-JP encoded Japanese text as a header. We should escape some reserved 'special' characters before composing a header. To enable it, we encode ISO-2022-JP encoded Japanese text with MIME Base64 encoding. Thus MIME Base64 encoded ISO-2022-JP encoded Japanese text is safely using in a mail header.

This module has developed to intend to automate those kinds of operations.

METHODS

new

Creates a new object.

set('From_addr', $address)

To set originator address. $address should be valid as email address.

set('To_addr', $address)

To set destination address. $address should be valid as email address. Comma separated multiple destination addresses are also usable.

set('Subject', $subject)

To set mail subject. $subject can contain Japanese characters. Note that this module runs under Unicode/UTF-8 environment, you should input these data in UTF-8 character encoding.

set('Body', $body)

To set mail body. $body can contain Japanese characters. Note that this module runs under Unicode/UTF-8 environment, you should input these data in UTF-8 character encoding.

compose

Compose and output a formed email.

date($date_string)

Specifies mail origination date. This method must used before compose() method when you want to specify this value. Of course, date-time format should be compliant to the format of RFC2822 specification. It is like blow:

 Mon, 10 Mar 2003 18:48:06 +0900

Origination date is not a essential information for email (sendmail program will add automatically on posting). Don't forget to quote the string.

post() *EXPERIMENTAL*

Posts a mail using sendmail program. At the default setting, it is supposed that sendmail program's name is `sendmail' under the systems's PATH environmental variable. You can specify exact location with sendmail() method.

sendmail($path) *EXPERIMENTAL*

Specifies sendmail location. ex. '/usr/bin/sendmail'

SEE ALSO

Encode

MIME::Base64

RFC2822: http://www.ietf.org/rfc/rfc2822.txt (Mail)

RFC2045: http://www.ietf.org/rfc/rfc2045.txt (MIME)

RFC2046: http://www.ietf.org/rfc/rfc2046.txt (MIME)

RFC2047: http://www.ietf.org/rfc/rfc2047.txt (MIME)

NOTES

This module runs under Unicode/UTF-8 environment (then Perl5.8 or later is required), you should input data in UTF-8 character encoding.

TO DO

enable originator/destination name containing Japanese characters.

AUTHOR

Masanori HATA <lovewing@geocities.co.jp> (Saitama, JAPAN)

COPYRIGHT

Copyright (c) 2003 Masanori HATA. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.