public class MailRX
extends java.lang.Object
MailRX は、POP3/IMAPプロトコルによるメール受信プログラムです。 メールへの接続条件(host,user,passwd など)と、選択条件(matchTermなど)を指定し、 MailReceiveListener をセットして、start() メソッドを呼びます。 実際のメール処理は、MailReceiveListener を介して、1メールずつ処理します。 添付ファイルを処理する場合は、MailAttachFiles クラスを使用します。 host メールサーバー(必須) user メールを取得するログインユーザー(必須) passwd メールを取得するログインパスワード(必須) protocol 受信サーバーのプロトコル[imap/pop3]を指定(初期値:pop3) port 受信サーバーのポートを指定(初期値:-1) useSSL SSL接続するかどうか[true:する/false:しない]を指定(初期値:false:しない) mbox 受信サーバーのメールボックスを指定(初期値:INBOX) maxRowCount 受信メールの最大取り込み件数(初期値:100)(0:[無制限]) charset メールのデフォルトエンコード(初期値:ISO-2022-JP) matchTerm 受信メールを選択する条件のMINEntryオブジェクト delete 検索後、メールをサーバーから削除するかどうかを、true/falseで指定(初期値:false)。 ※ 6.3.8.0 (2015/09/11) useSSL属性は、protocolに、pop3s/imaps を指定した場合、 自動的に、ture に設定するようにしています。
修飾子とタイプ | フィールドと説明 |
---|---|
static java.lang.String |
CHARSET
メールのデフォルトエンコード 「="ISO-2022-JP"」
Windwos-31J , MS932 , UTF-8 , ISO-2022-JP を指定します。
|
static boolean |
DELETE_MESSAGE
検索後、メールをサーバーから削除するかどうかを、true/falseで指定します 「=false」
|
static int |
MAX_ROW_COUNT
受信メールの最大取り込み件数を指定します 「=100」
|
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)
文字エンコーディングをセットします(初期値:ISO-2022-JP)。
|
void |
setDebug(boolean debug)
デバッグ情報の表示を行うかどうかをセットします。
|
void |
setDelete(boolean deleteFlag)
メッセージをメールサーバーから削除するかどうかをセットします(初期値:false)。
|
void |
setHost(java.lang.String host)
メールサーバーをセットします(必須)。
|
void |
setMailReceiveListener(MailReceiveListener listener)
メール受信毎に発生するイベントを伝えるリスナーをセットします。
|
void |
setMaxRowCount(int maxCount)
最大取り込み件数をセットします(初期値:100)(0:[無制限])。
|
void |
setMbox(java.lang.String mbox)
受信メイルボックスをセットします(初期値:INBOX)。
|
void |
setPasswd(java.lang.String passwd)
パスワードをセットします(必須)。
|
void |
setPort(int port)
ポート番号をセットします(初期値:-1)。
|
void |
setProtocol(java.lang.String prtcol)
受信プロトコル(pop3/imap等)をセットします(初期値:pop3)。
|
void |
setUser(java.lang.String user)
受信ユーザーをセットします(必須)。
|
void |
start()
レシーバーを開始します。
|
void |
useSSL(boolean isSSL)
SSL接続するかどうかをセットします(初期値:false:しない)。
|
public static final int MAX_ROW_COUNT
public static final boolean DELETE_MESSAGE
public static final java.lang.String PROTOCOL
public static final int PORT
public static final java.lang.String MBOX
public static final java.lang.String CHARSET
public void start() throws javax.mail.MessagingException, javax.mail.NoSuchProviderException
javax.mail.MessagingException
- レシーバー処理中に、なんらかのエラーが発生した場合。javax.mail.NoSuchProviderException
- なんらかのエラーが発生した場合。public void setHost(java.lang.String host)
host
- メールサーバーjava.lang.IllegalArgumentException
- 引数が null の場合。public void setUser(java.lang.String user)
user
- 受信ユーザーjava.lang.IllegalArgumentException
- 引数が null の場合。public void setPasswd(java.lang.String passwd)
passwd
- パスワードjava.lang.IllegalArgumentException
- 引数が null の場合。public void setProtocol(java.lang.String prtcol)
prtcol
- 受信プロトコル名java.lang.IllegalArgumentException
- 引数が null の場合。PROTOCOL
public void setPort(int port)
port
- ポート番号PORT
public void useSSL(boolean isSSL)
isSSL
- SSL接続するかどうか[true:する/false:しない]を指定public void setMbox(java.lang.String mbox)
mbox
- 受信メイルボックス名java.lang.IllegalArgumentException
- 引数が null の場合。MBOX
public void setMailReceiveListener(MailReceiveListener listener)
listener
- MailReceiveリスナーpublic void setDelete(boolean deleteFlag)
deleteFlag
- 削除するかどうか[true:行う/false:行わない]DELETE_MESSAGE
public void setCharset(java.lang.String charset)
charset
- 文字エンコーディングjava.lang.IllegalArgumentException
- 引数が null の場合。CHARSET
public void setMaxRowCount(int maxCount)
maxCount
- 最大取り込み件数MAX_ROW_COUNT
public void addMatchTerm(HybsEntry matchTerm)
matchTerm
- HybsEntryオブジェクトpublic void setDebug(boolean debug)
debug
- 有無[true/false]public static void main(java.lang.String[] args) throws javax.mail.MessagingException
args
- 引数配列javax.mail.MessagingException
- なんらかのエラーが発生した場合。Webアプリケーションフレームワーク openGionCopyright (c) 2009 The openGion Project.