|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
public interface FetchMailPro
メールサーバからメールを取得する上級インターフェース。
このインターフェースの実装クラスでメールサーバの情報を設定します。
FetchMail
インターフェースと異なり、メール取得時に例外が発生しても、
メールサーバとの接続は切断されません。finally
ブロックを使用するなりして
メールサーバとの接続を確実に切断できるようにすることを推奨します。
このインターフェース実装クラスのインスタンスは、メールサーバとの接続を保持するため、
スレッドセーフではありません。
DIコンテナでの使用の際はシングルトンでインスタンスを取得しないように注意してください。
FetchMail
メソッドの概要 | |
---|---|
void |
changeFolder(String folderName)
指定された名前のフォルダに移動します。 |
void |
connect()
メールサーバに接続し、「INBOX」フォルダをオープンします。 |
void |
disconnect()
メールサーバとの接続を切断します。 |
ReceivedMail |
getMail(int num)
現在のフォルダにある指定されたメッセージ番号のメールをReceivedMailに変換して返します。 |
ReceivedMail |
getMail(int num,
boolean delete)
現在のフォルダにある指定されたメッセージ番号のメールをReceivedMailに変換して返します。 |
int |
getMailCount()
現在のフォルダに届いているメール数を返します。 |
ReceivedMail[] |
getMails(boolean delete)
現在のフォルダにある全メールをReceivedMailに変換して返します。 |
javax.mail.internet.MimeMessage |
getMessage(int num)
現在のフォルダにある指定されたメッセージ番号のメールを返します。 |
javax.mail.internet.MimeMessage[] |
getMessages(boolean delete)
現在のフォルダにある全メールを返します。 |
boolean |
isConnected()
メールサーバと接続しているかどうか判定します。 |
メソッドの詳細 |
---|
void connect() throws MailException
MailException
- メールサーバとの接続に失敗した場合void disconnect() throws MailException
MailException
- メールサーバとの接続切断に失敗した場合int getMailCount() throws MailException
MailException
ReceivedMail getMail(int num) throws MailException
メッセージはサーバから削除されません。
num
- メッセージ番号。1始まり。
MailException
- メール取得に失敗した場合ReceivedMail getMail(int num, boolean delete) throws MailException
num
- メッセージ番号。1始まり。delete
- 指定された番号のメッセージをサーバから削除する場合 true を指定
MailException
- メール取得に失敗した場合ReceivedMail[] getMails(boolean delete) throws MailException
delete
- メール取得後にサーバからメールを削除する場合 true
MailException
- メール取得に失敗した場合javax.mail.internet.MimeMessage getMessage(int num) throws MailException
num
- メッセージ番号。1始まり。
MailException
- メール取得に失敗した場合Folder.getMessage(int)
javax.mail.internet.MimeMessage[] getMessages(boolean delete) throws MailException
delete
- メール取得後にサーバからメールを削除する場合 true
MailException
- メール取得に失敗した場合void changeFolder(String folderName) throws MailException
注: このメソッドは、メールサーバがimapサーバの時にのみ使用可能です。
folderName
- 移動先のフォルダ名
MailException
boolean isConnected()
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |