openGionopenGion
5.3.9.0

org.opengion.fukurou.mail
クラス MailRX

java.lang.Object
  上位を拡張 org.opengion.fukurou.mail.MailRX

public class MailRX
extends java.lang.Object

MailRX は、POP3プロトコルによるメール受信プログラムです。 メールへの接続条件(host,user,passwd など)と、選択条件(matchTermなど)を指定し、 MailReceiveListener をセットして、start() メソッドを呼びます。 実際のメール処理は、MailReceiveListener を介して、1メールずつ処理します。 添付ファイルを処理する場合は、MailAttachFiles クラスを使用します。 host メールサーバー(必須) user メールを取得するログインユーザー(必須) passwd メールを取得するログインパスワード(必須) protocol 受信サーバーのプロトコル(imap,pop3)を指定(初期値:pop3) port 受信サーバーのポートを指定(初期値:-1) mbox 受信サーバーのメールボックスを指定(初期値:INBOX) maxRowCount 受信メールの最大取り込み件数(初期値:100) charset メールのデフォルトエンコード(初期値:ISO-2022-JP) matchTerm 受信メールを選択する条件のMINEntryオブジェクト delete 検索後、メールをサーバーから削除するかどうかを、true/falseで指定。(初期値:false)

バージョン
4.0
作成者
Kazuhiko Hasegawa
導入されたバージョン:
JDK5.0,

フィールドの概要
static java.lang.String CHARSET
          メールのデフォルトエンコード "ISO-2022-JP" Windwos-31J , MS932 , ISO-2022-JP を指定します。
static boolean DELETE_MESSAGE
          検索後、メールをサーバーから削除するかどうかを、true/falseで指定します。
static int MAX_ROW_COUNT
          受信メールの最大取り込み件数を指定します。
static java.lang.String MBOX
          メールサーバーのデフォルトメールボックス "INBOX"
static int PORT
          メールサーバーのデフォルトポート番号 -1
static java.lang.String PROTOCOL
          メールサーバーのデフォルトプロトコル "pop3"
 
コンストラクタの概要
MailRX()
           
 
メソッドの概要
 void addMatchTerm(HybsEntry matchTerm)
          メール検索する場合のマッチ条件のキーと値の HybsEntry をセットします。
static void main(java.lang.String[] args)
          コマンドから実行できる、テスト用の main メソッドです。
 void setCharset(java.lang.String charset)
          文字エンコーディングをセットします。
 void setDebug(boolean debug)
          デバッグ情報の表示を行うかどうかをセットします。
 void setDelete(boolean deleteFlag)
          メッセージをメールサーバーから削除するかどうかをセットします。
 void setHost(java.lang.String host)
          メールサーバーをセットします。
 void setMailReceiveListener(MailReceiveListener listener)
          メール受信毎に発生するイベントを伝えるリスナーをセットします。
 void setMaxRowCount(int maxRowCount)
          maxRowCountをセットします。
 void setMbox(java.lang.String mbox)
          受信メイルボックスをセットします。
 void setPasswd(java.lang.String passwd)
          パスワードをセットします。
 void setPort(int port)
          ポート番号をセットします。
 void setProtocol(java.lang.String protocol)
          受信プロトコルをセットします。
 void setUser(java.lang.String user)
          受信ユーザーをセットします。
 void start()
          レシーバーを開始します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

MAX_ROW_COUNT

public static final int MAX_ROW_COUNT
受信メールの最大取り込み件数を指定します。 100

関連項目:
定数フィールド値

DELETE_MESSAGE

public static final boolean DELETE_MESSAGE
検索後、メールをサーバーから削除するかどうかを、true/falseで指定します。 false

関連項目:
定数フィールド値

PROTOCOL

public static final java.lang.String PROTOCOL
メールサーバーのデフォルトプロトコル "pop3"

関連項目:
定数フィールド値

PORT

public static final int PORT
メールサーバーのデフォルトポート番号 -1

関連項目:
定数フィールド値

MBOX

public static final java.lang.String MBOX
メールサーバーのデフォルトメールボックス "INBOX"

関連項目:
定数フィールド値

CHARSET

public static final java.lang.String CHARSET
メールのデフォルトエンコード "ISO-2022-JP" Windwos-31J , MS932 , ISO-2022-JP を指定します。

関連項目:
定数フィールド値
コンストラクタの詳細

MailRX

public MailRX()
メソッドの詳細

start

public void start()
           throws javax.mail.MessagingException,
                  javax.mail.NoSuchProviderException
レシーバーを開始します。

例外:
javax.mail.MessagingException
javax.mail.NoSuchProviderException

setHost

public void setHost(java.lang.String host)
メールサーバーをセットします。

パラメータ:
host - String
例外:
java.lang.IllegalArgumentException - 引数が null の場合。

setUser

public void setUser(java.lang.String user)
受信ユーザーをセットします。

パラメータ:
user - String
例外:
java.lang.IllegalArgumentException - 引数が null の場合。

setPasswd

public void setPasswd(java.lang.String passwd)
パスワードをセットします。

パラメータ:
passwd - String
例外:
java.lang.IllegalArgumentException - 引数が null の場合。

setProtocol

public void setProtocol(java.lang.String protocol)
受信プロトコルをセットします。

パラメータ:
protocol - String
例外:
java.lang.IllegalArgumentException - 引数が null の場合。

setPort

public void setPort(int port)
ポート番号をセットします。

パラメータ:
port - int

setMbox

public void setMbox(java.lang.String mbox)
受信メイルボックスをセットします。

パラメータ:
mbox - String
例外:
java.lang.IllegalArgumentException - 引数が null の場合。

setMailReceiveListener

public void setMailReceiveListener(MailReceiveListener listener)
メール受信毎に発生するイベントを伝えるリスナーをセットします。

パラメータ:
listener - MailReceiveListener

setDelete

public void setDelete(boolean deleteFlag)
メッセージをメールサーバーから削除するかどうかをセットします。

パラメータ:
deleteFlag - boolean 削除するかどうか true:行う/false:行わない

setCharset

public void setCharset(java.lang.String charset)
文字エンコーディングをセットします。 文字エンコーディングには、Windwos-31J , MS932 , ISO-2022-JP を指定できます。 デフォルトは、SystemResource.properties ファイルの MAIL_DEFAULT_CHARSET 属性で 設定できます。

パラメータ:
charset - String
例外:
java.lang.IllegalArgumentException - 引数が null の場合。

setMaxRowCount

public void setMaxRowCount(int maxRowCount)
maxRowCountをセットします。

パラメータ:
maxRowCount - String

addMatchTerm

public void addMatchTerm(HybsEntry matchTerm)
メール検索する場合のマッチ条件のキーと値の HybsEntry をセットします。 Subject,From,Body,それ以外は、Header 文字列をキーにします。

パラメータ:
matchTerm - HybsEntry

setDebug

public void setDebug(boolean debug)
デバッグ情報の表示を行うかどうかをセットします。

パラメータ:
debug - boolean

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception
コマンドから実行できる、テスト用の main メソッドです。 java org.opengion.fukurou.mail.MailTX .... で、複数の添付ファイルを送付することができます。

パラメータ:
args - String[]
例外:
java.lang.Exception

openGion 5.3.9.0

Webアプリケーションフレームワーク openGion
SourceForge.JPCopyright (c) 2009 The openGion Project.