|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Objectjp.sourceforge.livez.mail.MailRetriever
public final class MailRetriever
メール受信機能を提供するクラスです。
フィールドの概要 | |
---|---|
protected MailProfile |
profile
メールプロファイル情報を保持します。 |
protected Session |
session
メールセッションを保持します。 |
コンストラクタの概要 | |
---|---|
MailRetriever(MailProfile profile)
メールプロファイル情報からクラスを構築するコンストラクタです。 |
|
MailRetriever(MailProfile profile,
boolean debug)
メールプロファイル情報からクラスを構築するコンストラクタです。 |
メソッドの概要 | |
---|---|
void |
appendMessages(MailMessage message)
指定された MailMessage を現在のフォルダに追加します。 |
void |
appendMessages(MimeMessage message)
指定された MimeMessage を現在のフォルダに追加します。 |
void |
connect()
メール受信サーバへ接続します。 |
void |
copyMessage(MailMessage mail,
String folder)
現在のフォルダから指定された MailMessage を別のフォルダにコピーします。 |
protected void |
copyMessage(MimeMessage message,
String folder)
現在のフォルダから指定された MimeMessage を別のフォルダにコピーします。 |
boolean |
createFolder(String path)
path で指定されたフォルダを作成し有効にします。 |
boolean |
deleteFolder(String path)
path で指定されたフォルダを削除します。 |
void |
disconnect()
メール受信サーバから切断します。 |
void |
disconnect(boolean expunge)
メール受信サーバから切断します。 |
String[] |
getAllFolderNames()
フォルダの一覧を返します。 |
String[] |
getFolderNames()
サブフォルダの一覧を返します。 |
MailMessage[] |
getMailMessages()
メールを受信し、MailMessage の配列として返します。 |
MailMessage[] |
getMailMessages(Flags.Flag flag,
boolean match)
指定されたフラグに関連するメッセージの配列を返します。 |
int |
getMessageCount()
|
Message[] |
getMessages()
|
MimeMessage[] |
getMimeMessages()
メールを受信し、MimeMessage の配列として返します。 |
int |
getNewMessageCount()
現在のフォルダ中の新規メッセージの数を取得します。 |
int |
getUnreadMessageCount()
現在のフォルダ中の未読メッセージの数を取得します。 |
boolean |
isConnected()
メール受信サーバへの接続状況を返します。 |
boolean |
isExistsFolder(String path)
指定されたフォルダが存在するかどうかを返します。 |
boolean |
isOpen()
カレントフォルダが開かれているかどうかを返します。 |
boolean |
renameFolder(String path1,
String path2)
フォルダ名を変更します。 |
Message[] |
search(SearchTerm term)
指定された検索基準に一致するメッセージについて現在のフォルダを検索します。 |
MailMessage[] |
searchMailMessages(SearchTerm term)
指定された検索基準に一致するメッセージについて現在のフォルダを検索します。 |
MimeMessage[] |
searchMimeMessages(SearchTerm term)
指定された検索基準に一致するメッセージについて現在のフォルダを検索します。 |
void |
setCurrentFolder(boolean expunge,
String name)
カレントフォルダを設定します。 |
void |
setCurrentFolder(boolean expunge,
String name,
boolean readOnly)
カレントフォルダを設定します。 |
void |
setCurrentFolder(String path)
カレントフォルダを設定します。 |
void |
setCurrentFolder(String path,
boolean readOnly)
カレントフォルダを設定します。 |
クラス java.lang.Object から継承されたメソッド |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
フィールドの詳細 |
---|
protected MailProfile profile
protected Session session
コンストラクタの詳細 |
---|
public MailRetriever(MailProfile profile, boolean debug) throws NoSuchProviderException
profile
- メールプロファイル情報debug
- デバッグモード
NoSuchProviderException
- プロファイルで指定された受信プロトコルのプロバイダが見つからない場合public MailRetriever(MailProfile profile) throws NoSuchProviderException
profile
- メールプロファイル情報
NoSuchProviderException
- プロファイルで指定された受信プロトコルのプロバイダが見つからない場合メソッドの詳細 |
---|
public void connect() throws MessagingException
接続に使用されるユーザ名及びパスワードはメールプロファイル中に含められた物が使用されます。
MessagingException
public void setCurrentFolder(boolean expunge, String name, boolean readOnly) throws MessagingException
expunge
- 現在のカレントフォルダに対してname
- フォルダ名readOnly
- 読取り専用で開くかどうか
MessagingException
public void setCurrentFolder(boolean expunge, String name) throws MessagingException
expunge
- name
-
MessagingException
public void setCurrentFolder(String path, boolean readOnly) throws MessagingException
path
- readOnly
-
MessagingException
public void setCurrentFolder(String path) throws MessagingException
path
-
MessagingException
public void disconnect()
public void disconnect(boolean expunge)
expunge
- public boolean isConnected()
true
を、それ以外の場合は false
を返します。public boolean isOpen()
true
を返します。それ以外の場合は false
を返します。public String[] getFolderNames() throws MessagingException
MessagingException
public String[] getAllFolderNames() throws MessagingException
MessagingException
public int getNewMessageCount() throws MessagingException
POP3 プロトコルの場合は必ず 0 が返ります。
MessagingException
public int getUnreadMessageCount() throws MessagingException
POP3 プロトコルの場合は、新着であっても未読としてカウントされます。
MessagingException
public int getMessageCount() throws MessagingException
MessagingException
public boolean isExistsFolder(String path) throws MessagingException
path
-
MessagingException
public boolean createFolder(String path) throws MessagingException
指定されたフォルダが既に存在する場合は無視されます。
path
- パス
MessagingException
public boolean renameFolder(String path1, String path2) throws MessagingException
path1
- 変更前のフォルダ名path2
- 変更後のフォルダ名
MessagingException
public boolean deleteFolder(String path) throws MessagingException
path
- パス
MessagingException
public Message[] getMessages() throws MessagingException
MessagingException
public MimeMessage[] getMimeMessages() throws MessagingException
MessagingException
public MailMessage[] getMailMessages() throws MessagingException
MessagingException
public MailMessage[] getMailMessages(Flags.Flag flag, boolean match) throws MessagingException
flag
- フラグmatch
- true の場合はフラグと一致するメッセージを、それ以外の場合はフラグと一致しないメッセージを抽出します
MessagingException
public void appendMessages(MailMessage message) throws MessagingException
message
- MailMessage
MessagingException
- 追加が失敗した場合public void appendMessages(MimeMessage message) throws MessagingException
message
- MimeMessage
MessagingException
- 追加が失敗した場合public void copyMessage(MailMessage mail, String folder) throws MessagingException
mail
- MailMessagefolder
- メッセージのコピー先フォルダ名
MessagingException
protected void copyMessage(MimeMessage message, String folder) throws MessagingException
message
- MimeMessagefolder
- メッセージのコピー先フォルダ名
MessagingException
public Message[] search(SearchTerm term) throws MessagingException
term
- 検索基準
MessagingException
public MimeMessage[] searchMimeMessages(SearchTerm term) throws MessagingException
term
- 検索基準
MessagingException
public MailMessage[] searchMailMessages(SearchTerm term) throws MessagingException
term
- 検索基準
MessagingException
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |