commons-mail
b2007062501

org.phosphoresce.commons.mail
クラス MailReciveTransaction

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

public final class MailReciveTransaction
extends MailTransaction

メール受信操作トランザクションクラス。

作成者:
Kitagawa

フィールドの概要
 
インタフェース org.phosphoresce.commons.mail.MailDeclareInterface から継承したフィールド
CHARSET_ISO_2022_JP, DEFAULT_MIME_CHARSET, EMAIL_EXTENSION, PRIMARY_FOLDER
 
コンストラクタの概要
MailReciveTransaction(MailConfiguration configuration)
          コンストラクタ
 
メソッドの概要
 int getMessageCount()
          メールサーバー上のメッセージ数を取得します。
 int getNewMessageCount()
          メールサーバー上の新着メッセージ数を取得します。
 int getUnreadMessageCount()
          メールサーバー上の未読メッセージ数を取得します。
 MailMessage[] recive()
          メールを受信します。
 
クラス org.phosphoresce.commons.mail.MailTransaction から継承したメソッド
begin, close, isOpened
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

MailReciveTransaction

public MailReciveTransaction(MailConfiguration configuration)
コンストラクタ

パラメータ:
configuration - 環境設定情報オブジェクト
メソッドの詳細

getMessageCount

public int getMessageCount()
                    throws MailException,
                           MailTransactionException
メールサーバー上のメッセージ数を取得します。

戻り値:
メールサーバー上のメッセージ数
例外:
MailException - 正常に受信処理が行えなかった場合に発生します
MailTransactionException - トランザクションが開始されていない状態で処理が行われた場合に発生します

getUnreadMessageCount

public int getUnreadMessageCount()
                          throws MailException,
                                 MailTransactionException
メールサーバー上の未読メッセージ数を取得します。

戻り値:
メールサーバー上の未読メッセージ数
例外:
MailException - 正常に受信処理が行えなかった場合に発生します
MailTransactionException - トランザクションが開始されていない状態で処理が行われた場合に発生します

getNewMessageCount

public int getNewMessageCount()
                       throws MailException,
                              MailTransactionException
メールサーバー上の新着メッセージ数を取得します。

戻り値:
メールサーバー上の新着メッセージ数
例外:
MailException - 正常に受信処理が行えなかった場合に発生します
MailTransactionException - トランザクションが開始されていない状態で処理が行われた場合に発生します

recive

public MailMessage[] recive()
                     throws MailException,
                            MailTransactionException
メールを受信します。

戻り値:
メールメッセージオブジェクト
例外:
MailException - 正常に受信処理が行えなかった場合に発生します
MailTransactionException - トランザクションが開始されていない状態で処理が行われた場合に発生します

commons-mail
b2007062501