概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## jp.sourceforge.livez.mail
クラス MailRetriever

    java.lang.Object
      jp.sourceforge.livez.mail.MailRetriever

    public final class MailRetriever

extends Object

メール受信機能を提供するクラスです。

作成者:
  杉澤 浩二

フィールドの概要
`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`

フィールドの詳細

### profile

    protected MailProfile profile

  メールプロファイル情報を保持します。

### session

    protected Session session

  メールセッションを保持します。

コンストラクタの詳細

### MailRetriever

    public MailRetriever(MailProfile profile,
                         boolean debug)
                  throws NoSuchProviderException

  メールプロファイル情報からクラスを構築するコンストラクタです。

  パラメータ:
    `profile` - メールプロファイル情報
    `debug` - デバッグモード
  例外:
    `NoSuchProviderException` - プロファイルで指定された受信プロトコルのプロバイダが見つからない場合

### MailRetriever

    public MailRetriever(MailProfile profile)
                  throws NoSuchProviderException

  メールプロファイル情報からクラスを構築するコンストラクタです。

  パラメータ:
    `profile` - メールプロファイル情報
  例外:
    `NoSuchProviderException` - プロファイルで指定された受信プロトコルのプロバイダが見つからない場合

メソッドの詳細

### connect

    public void connect()
                 throws MessagingException

  メール受信サーバへ接続します。

  接続に使用されるユーザ名及びパスワードはメールプロファイル中に含められた物が使用されます。

  例外:
    `MessagingException`

### setCurrentFolder

    public void setCurrentFolder(boolean expunge,
                                 String name,
                                 boolean readOnly)
                          throws MessagingException

  カレントフォルダを設定します。

  パラメータ:
    `expunge` - 現在のカレントフォルダに対して
    `name` - フォルダ名
    `readOnly` - 読取り専用で開くかどうか
  例外:
    `MessagingException`

### setCurrentFolder

    public void setCurrentFolder(boolean expunge,
                                 String name)
                          throws MessagingException

  カレントフォルダを設定します。

  パラメータ:
    `expunge` -
    `name` -
  例外:
    `MessagingException`

### setCurrentFolder

    public void setCurrentFolder(String path,
                                 boolean readOnly)
                          throws MessagingException

  カレントフォルダを設定します。

  パラメータ:
    `path` -
    `readOnly` -
  例外:
    `MessagingException`

### setCurrentFolder

    public void setCurrentFolder(String path)
                          throws MessagingException

  カレントフォルダを設定します。

  パラメータ:
    `path` -
  例外:
    `MessagingException`

### disconnect

    public void disconnect()

  メール受信サーバから切断します。

### disconnect

    public void disconnect(boolean expunge)

  メール受信サーバから切断します。

  パラメータ:
    `expunge` -

### isConnected

    public boolean isConnected()

  メール受信サーバへの接続状況を返します。

  戻り値:
    サーバへ接続されている場合は `true` を、それ以外の場合は `false` を返します。

### isOpen

    public boolean isOpen()

  カレントフォルダが開かれているかどうかを返します。

  戻り値:
    カレントフォルダが開かれている場合のみ `true` を返します。それ以外の場合は `false` を返します。

### getFolderNames

    public String[] getFolderNames()
                            throws MessagingException

  サブフォルダの一覧を返します。

  例外:
    `MessagingException`

### getAllFolderNames

    public String[] getAllFolderNames()
                               throws MessagingException

  フォルダの一覧を返します。

  例外:
    `MessagingException`

### getNewMessageCount

    public int getNewMessageCount()
                           throws MessagingException

  現在のフォルダ中の新規メッセージの数を取得します。

  POP3 プロトコルの場合は必ず 0 が返ります。

  例外:
    `MessagingException`

### getUnreadMessageCount

    public int getUnreadMessageCount()
                              throws MessagingException

  現在のフォルダ中の未読メッセージの数を取得します。

  POP3 プロトコルの場合は、新着であっても未読としてカウントされます。

  例外:
    `MessagingException`

### getMessageCount

    public int getMessageCount()
                        throws MessagingException

  例外:
    `MessagingException`

### isExistsFolder

    public boolean isExistsFolder(String path)
                           throws MessagingException

  指定されたフォルダが存在するかどうかを返します。

  パラメータ:
    `path` -
  例外:
    `MessagingException`

### createFolder

    public boolean createFolder(String path)
                         throws MessagingException

  path で指定されたフォルダを作成し有効にします。

  指定されたフォルダが既に存在する場合は無視されます。

  パラメータ:
    `path` - パス
  例外:
    `MessagingException`

### renameFolder

    public boolean renameFolder(String path1,
                                String path2)
                         throws MessagingException

  フォルダ名を変更します。

  パラメータ:
    `path1` - 変更前のフォルダ名
    `path2` - 変更後のフォルダ名
  戻り値:
    正常にフォルダ名が変更された場合のみ true を返します。
  例外:
    `MessagingException`

### deleteFolder

    public boolean deleteFolder(String path)
                         throws MessagingException

  path で指定されたフォルダを削除します。

  パラメータ:
    `path` - パス
  例外:
    `MessagingException`

### getMessages

    public Message[] getMessages()
                          throws MessagingException

  例外:
    `MessagingException`

### getMimeMessages

    public MimeMessage[] getMimeMessages()
                                  throws MessagingException

  メールを受信し、MimeMessage の配列として返します。

  戻り値:
    MimeMessage の配列
  例外:
    `MessagingException`

### getMailMessages

    public MailMessage[] getMailMessages()
                                  throws MessagingException

  メールを受信し、MailMessage の配列として返します。

  戻り値:
    MailMessage の配列
  例外:
    `MessagingException`

### getMailMessages

    public MailMessage[] getMailMessages(Flags.Flag flag,
                                         boolean match)
                                  throws MessagingException

  指定されたフラグに関連するメッセージの配列を返します。

  パラメータ:
    `flag` - フラグ
    `match` - true の場合はフラグと一致するメッセージを、それ以外の場合はフラグと一致しないメッセージを抽出します
  戻り値:
    MailMessage の配列
  例外:
    `MessagingException`

### appendMessages

    public void appendMessages(MailMessage message)
                        throws MessagingException

  指定された MailMessage を現在のフォルダに追加します。

  パラメータ:
    `message` - MailMessage
  例外:
    `MessagingException` - 追加が失敗した場合

### appendMessages

    public void appendMessages(MimeMessage message)
                        throws MessagingException

  指定された MimeMessage を現在のフォルダに追加します。

  パラメータ:
    `message` - MimeMessage
  例外:
    `MessagingException` - 追加が失敗した場合

### copyMessage

    public void copyMessage(MailMessage mail,
                            String folder)
                     throws MessagingException

  現在のフォルダから指定された MailMessage を別のフォルダにコピーします。

  パラメータ:
    `mail` - MailMessage
    `folder` - メッセージのコピー先フォルダ名
  例外:
    `MessagingException`

### copyMessage

    protected void copyMessage(MimeMessage message,
                               String folder)
                        throws MessagingException

  現在のフォルダから指定された MimeMessage を別のフォルダにコピーします。

  パラメータ:
    `message` - MimeMessage
    `folder` - メッセージのコピー先フォルダ名
  例外:
    `MessagingException`

### search

    public Message[] search(SearchTerm term)
                     throws MessagingException

  指定された検索基準に一致するメッセージについて現在のフォルダを検索します。

  パラメータ:
    `term` - 検索基準
  戻り値:
    一致するメッセージの配列
  例外:
    `MessagingException`

### searchMimeMessages

    public MimeMessage[] searchMimeMessages(SearchTerm term)
                                     throws MessagingException

  指定された検索基準に一致するメッセージについて現在のフォルダを検索します。

  パラメータ:
    `term` - 検索基準
  戻り値:
    一致するメッセージの配列
  例外:
    `MessagingException`

### searchMailMessages

    public MailMessage[] searchMailMessages(SearchTerm term)
                                     throws MessagingException

  指定された検索基準に一致するメッセージについて現在のフォルダを検索します。

  パラメータ:
    `term` - 検索基準
  戻り値:
    一致するメッセージの配列
  例外:
    `MessagingException`

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

Copyright © 2005-2006 Kouji Sugisawa. All rights reserved.