commons-mail
b2007092401

org.phosphoresce.commons.mail
クラス MailMessage

java.lang.Object
  拡張org.phosphoresce.commons.mail.MailMessage
すべての実装インタフェース:
MailDeclareInterface

public final class MailMessage
extends java.lang.Object
implements MailDeclareInterface

メールメッセージ情報保持クラス。

作成者:
Kitagawa

フィールドの概要
 
インタフェース org.phosphoresce.commons.mail.MailDeclareInterface から継承したフィールド
CHARSET_ISO_2022_JP, DEFAULT_MIME_CHARSET, EMAIL_EXTENSION, PRIMARY_FOLDER
 
コンストラクタの概要
MailMessage(java.io.File file)
          コンストラクタ
MailMessage(MailConfiguration configuration, MailAddressContainer container, MailContent content, java.util.Date date)
          コンストラクタ
 
メソッドの概要
 java.lang.String getId()
          メールメッセージのIDを取得します。
 MailContent getMailContent()
          メールコンテンツオブジェクトを取得します。
 java.lang.String getMessageId()
          JavaMailのMimeMessageが提供するメッセージIDを取得します。
 java.util.Date getReceivedDate()
          メッセージオブジェクトの受信日付を取得します。
 MailAddressContainer getRecipientsContainer()
          メッセージオブジェクトの送信先情報を取得します。
 java.util.Date getSendDate()
          メッセージオブジェクトの送信日付を取得します。
 void save(java.io.File file)
          メール情報を指定されたファイルオブジェクトに保存します。
 void save(java.lang.String path)
          メール情報を指定されたファイルパスに保存します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

MailMessage

public MailMessage(MailConfiguration configuration,
                   MailAddressContainer container,
                   MailContent content,
                   java.util.Date date)
            throws MailMessageException
コンストラクタ

パラメータ:
configuration - 環境設定オブジェクト
container - 送信先アドレス情報コンテナ
content - メールコンテンツ
date - 送信日時
例外:
MailMessageException - 正常にクラスを初期化できなかった場合に発生

MailMessage

public MailMessage(java.io.File file)
            throws MailMessageException
コンストラクタ

パラメータ:
file - eml形式メールファイル
例外:
MailMessageException - 正常にメールファイルからMessageオブジェクトの生成が行えなかった場合に発生
メソッドの詳細

getMessageId

public java.lang.String getMessageId()
                              throws MailMessageException
JavaMailのMimeMessageが提供するメッセージIDを取得します。
但し、クラスが保持するMessageオブジェクトがMimeMessage派生クラスでない場合は空文字列が返却されます。

戻り値:
メッセージID
例外:
MailMessageException - 正常にメッセージIDを取得できなかった場合に発生

getId

public java.lang.String getId()
                       throws MailMessageException
メールメッセージのIDを取得します。
ここで取得するIDはJavaMailのMimeMessageオブジェクトが提供するメッセージIDとは異なります。
当メソッドが提供するIDはクライアントにおいて読み取り専用でメッセージを取得する場合に 既読済みのメッセージであるかどうかの判定に用いることを想定します。

戻り値:
メールメッセージのID
例外:
MailMessageException - 正常にメールメッセージのIDを生成することが出来なかった場合に発生

getSendDate

public java.util.Date getSendDate()
                           throws MailMessageException
メッセージオブジェクトの送信日付を取得します。

戻り値:
メッセージオブジェクトの送信日付
例外:
MailMessageException - 正常にメッセージオブジェクトの送信日付を取得できなかった場合に発生

getReceivedDate

public java.util.Date getReceivedDate()
                               throws MailMessageException
メッセージオブジェクトの受信日付を取得します。

戻り値:
メッセージオブジェクトの受信日付
例外:
MailMessageException - 正常にメッセージオブジェクトの受信日付を取得できなかった場合に発生

getRecipientsContainer

public MailAddressContainer getRecipientsContainer()
                                            throws MailMessageException
メッセージオブジェクトの送信先情報を取得します。

戻り値:
メッセージオブジェクトの送信先情報
例外:
MailMessageException - 正常にメッセージオブジェクトの送信先情報を取得できなかった場合に発生

getMailContent

public MailContent getMailContent()
                           throws MailMessageException
メールコンテンツオブジェクトを取得します。

戻り値:
メールコンテンツオブジェクト
例外:
MailMessageException - メールメッセージからコンテンツ情報が正常に取得できなかった場合に発生

save

public void save(java.io.File file)
          throws MailIOException
メール情報を指定されたファイルオブジェクトに保存します。
指定されたファイルオブジェクトがディレクトリである場合はメール表題を ファイル名としたファイルを該当のディレクトリに対して出力します。

パラメータ:
file - ファイルオブジェクト
例外:
MailIOException - 正常に添付ファイルの出力が行えなかった場合に発生

save

public void save(java.lang.String path)
          throws MailIOException
メール情報を指定されたファイルパスに保存します。
指定されたファイルパスがディレクトリである場合はメール表題を ファイル名としたファイルを該当のディレクトリに対して出力します。

パラメータ:
path - ファイルパス
例外:
MailIOException - 正常に添付ファイルの出力が行えなかった場合に発生

commons-mail
b2007092401