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

## com.ozacc.mail.fetch.impl
クラス FetchMailProImpl

    java.lang.Object
      com.ozacc.mail.fetch.impl.FetchMailProImpl

すべての実装されたインタフェース:
  FetchMailPro

    public class FetchMailProImpl

extends Object
implements FetchMailPro

`FetchMail`インターフェースの実装クラス。

このクラスのインスタンスは、インスタンス変数を用いて状態を保持するため、 ステートレスではありません。ステートフルです。

導入されたバージョン:
  1.2
バージョン:
  $Id: FetchMailProImpl.java,v 1.1.2.13 2005/04/10 05:22:24 otsuka Exp $
作成者:
  Tomohiro Otsuka, gaku

フィールドの概要
`static String` | `DEFAULT_HOST` デフォルトのSMTPサーバ。
`static int` | `DEFAULT_PORT` デフォルトのポート。
`static String` | `DEFAULT_PROTOCOL` デフォルトのプロトコル。

コンストラクタの概要
`FetchMailProImpl()` コンストラクタ。

メソッドの概要
`void` | `changeFolder(String folderName)` 指定された名前のフォルダに移動します。
`void` | `connect()` メールサーバに接続し、「INBOX」フォルダをオープンします。
`void` | `disconnect()` メールサーバとの接続を切断します。
`String` | `getHost()` メールサーバのホスト名、またはIPアドレスを返します。
`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)` 現在のフォルダにある全メールを返します。
`String` | `getPassword()` メールサーバの認証パスワードを返します。
`int` | `getPort()`
`String` | `getProtocol()` メール受信に使用するプロトコロルをセットします。
`String` | `getUsername()`
`boolean` | `isConnected()` メールサーバと接続しているかどうか判定します。
`boolean` | `isJavaMailLogEnabled()` JavaMailのデバッグが有効かどうか判定します。
`void` | `setHost(String host)` メールサーバのホスト名、またはIPアドレスをセットします。
`void` | `setJavaMailLogEnabled(boolean javaMailLogEnabled)` JavaMailのデバッグを有効にするかどうか指定します。
`void` | `setMailConverter(MailConverter mailConverter)` MailConveterインターフェースの実装インスタンスをセットします。
`void` | `setPassword(String password)` メールサーバの認証パスワード名をセットします。
`void` | `setPort(int port)` メール受信に使用するポート番号をセットします。
`void` | `setProtocol(String protocol)` メール受信に使用するプロトコロルをセットします。
`void` | `setUsername(String username)` メールサーバの認証ユーザ名をセットします。

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

フィールドの詳細

### DEFAULT_HOST

    public static final String DEFAULT_HOST

  デフォルトのSMTPサーバ。「localhost」

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

### DEFAULT_PROTOCOL

    public static final String DEFAULT_PROTOCOL

  デフォルトのプロトコル。「pop3」

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

### DEFAULT_PORT

    public static final int DEFAULT_PORT

  デフォルトのポート。「-1」
  -1はプロトコルに応じた適切なポートを設定する特別な値。

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

コンストラクタの詳細

### FetchMailProImpl

    public FetchMailProImpl()

  コンストラクタ。

メソッドの詳細

### connect

    public void connect()
                 throws MailException

  インタフェース `FetchMailPro` の記述:
  メールサーバに接続し、「INBOX」フォルダをオープンします。

  定義:
    インタフェース `FetchMailPro` 内の `connect`
  例外:
    `MailException` - メールサーバとの接続に失敗した場合
  関連項目:
    `FetchMailPro.connect()`

### disconnect

    public void disconnect()
                    throws MailException

  インタフェース `FetchMailPro` の記述:
  メールサーバとの接続を切断します。接続されていなければ何も行いません。

  定義:
    インタフェース `FetchMailPro` 内の `disconnect`
  例外:
    `MailException` - メールサーバとの接続切断に失敗した場合
  関連項目:
    `FetchMailPro.disconnect()`

### changeFolder

    public void changeFolder(String folderName)
                      throws MailException

  インタフェース `FetchMailPro` の記述:
  指定された名前のフォルダに移動します。 フォルダ名は"INBOX/XXXX"のように、INBOXからのパス指定します。

  注: このメソッドは、メールサーバがimapサーバの時にのみ使用可能です。

  定義:
    インタフェース `FetchMailPro` 内の `changeFolder`
  パラメータ:
    `folderName` - 移動先のフォルダ名
  例外:
    `MailException`
  関連項目:
    `FetchMailPro.changeFolder(java.lang.String)`

### getMailCount

    public int getMailCount()
                     throws MailException

  インタフェース `FetchMailPro` の記述:
  現在のフォルダに届いているメール数を返します。

  定義:
    インタフェース `FetchMailPro` 内の `getMailCount`
  戻り値:
    現在のフォルダにあるメール数
  例外:
    `MailException`
  関連項目:
    `FetchMailPro.getMailCount()`

### getMail

    public ReceivedMail getMail(int num)
                         throws MailException

  インタフェース `FetchMailPro` の記述:
  現在のフォルダにある指定されたメッセージ番号のメールをReceivedMailに変換して返します。 メッセージ番号は1始まりです。

  メッセージはサーバから削除されません。

  定義:
    インタフェース `FetchMailPro` 内の `getMail`
  パラメータ:
    `num` - メッセージ番号。1始まり。
  戻り値:
    指定されたメッセージ番号のReceivedMailインスタンス
  例外:
    `MailException` - メール取得に失敗した場合
  関連項目:
    `FetchMailPro.getMail(int)`

### getMail

    public ReceivedMail getMail(int num,
                                boolean delete)
                         throws MailException

  インタフェース `FetchMailPro` の記述:
  現在のフォルダにある指定されたメッセージ番号のメールをReceivedMailに変換して返します。 メッセージ番号は1始まりです。 指定した番号のメッセージをサーバから削除するかどうかを指定できます。

  定義:
    インタフェース `FetchMailPro` 内の `getMail`
  パラメータ:
    `num` - メッセージ番号。1始まり。
    `delete` - 指定された番号のメッセージをサーバから削除する場合 true を指定
  戻り値:
    指定されたメッセージ番号のReceivedMailインスタンス
  例外:
    `MailException` - メール取得に失敗した場合
  関連項目:
    `FetchMailPro.getMail(int, boolean)`

### getMails

    public ReceivedMail[] getMails(boolean delete)
                            throws MailException

  インタフェース `FetchMailPro` の記述:
  現在のフォルダにある全メールをReceivedMailに変換して返します。

  定義:
    インタフェース `FetchMailPro` 内の `getMails`
  パラメータ:
    `delete` - メール取得後にサーバからメールを削除する場合 true
  戻り値:
    現在のフォルダにある全メールのReceivedMailインスタンス
  例外:
    `MailException` - メール取得に失敗した場合
  関連項目:
    `FetchMailPro.getMails(boolean)`

### getMessage

    public javax.mail.internet.MimeMessage getMessage(int num)
                                               throws MailException

  インタフェース `FetchMailPro` の記述:
  現在のフォルダにある指定されたメッセージ番号のメールを返します。 メッセージ番号は1始まりです。

  定義:
    インタフェース `FetchMailPro` 内の `getMessage`
  パラメータ:
    `num` - メッセージ番号。1始まり。
  戻り値:
    指定された番号のMimeMessageインスタンス
  例外:
    `MailException` - メール取得に失敗した場合
  関連項目:
    `FetchMailPro.getMessage(int)`

### getMessages

    public javax.mail.internet.MimeMessage[] getMessages(boolean delete)
                                                  throws MailException

  インタフェース `FetchMailPro` の記述:
  現在のフォルダにある全メールを返します。

  定義:
    インタフェース `FetchMailPro` 内の `getMessages`
  パラメータ:
    `delete` - メール取得後にサーバからメールを削除する場合 true
  戻り値:
    現在のフォルダにある全メールのMimeMessageインスタンス
  例外:
    `MailException` - メール取得に失敗した場合

### isConnected

    public boolean isConnected()

  インタフェース `FetchMailPro` の記述:
  メールサーバと接続しているかどうか判定します。

  定義:
    インタフェース `FetchMailPro` 内の `isConnected`
  戻り値:
    接続している場合 true
  関連項目:
    `FetchMailPro.isConnected()`

### getHost

    public String getHost()

  メールサーバのホスト名、またはIPアドレスを返します。

  戻り値:
    メールサーバのホスト名、またはIPアドレス

### setHost

    public void setHost(String host)

  メールサーバのホスト名、またはIPアドレスをセットします。 デフォルトは localhost です。

  パラメータ:
    `host` - メールサーバのホスト名、またはIPアドレス

### getPassword

    public String getPassword()

  メールサーバの認証パスワードを返します。

  戻り値:
    メールサーバの認証パスワード

### setPassword

    public void setPassword(String password)

  メールサーバの認証パスワード名をセットします。

  パラメータ:
    `password` - メールサーバの認証パスワード

### getProtocol

    public String getProtocol()

  メール受信に使用するプロトコロルをセットします。

  戻り値:
    プロトコル

### setProtocol

    public void setProtocol(String protocol)

  メール受信に使用するプロトコロルをセットします。 現在サポートされているプロトコルは、「pop3」と「imap」の二つです。 デフォルトは「pop3」です。

  POP3サーバへの認証をAPOPで行いたい場合は、プロトコル名ではありませんが、 「apop」を指定してください。APOP認証を使用するには、JavaMail 1.3.2以降が必要です。

  パラメータ:
    `protocol` - プロトコル

### getUsername

    public String getUsername()

  戻り値:
    認証ユーザ名

### setUsername

    public void setUsername(String username)

  メールサーバの認証ユーザ名をセットします。

  パラメータ:
    `username` - 認証ユーザ名

### getPort

    public int getPort()

  戻り値:
    ポート番号

### setPort

    public void setPort(int port)

  メール受信に使用するポート番号をセットします。 プロトコルに応じたポート番号が自動的に使用されますので、通常ここでポート番号をセットする必要はありません。

  パラメータ:
    `port` - ポート番号

### isJavaMailLogEnabled

    public boolean isJavaMailLogEnabled()

  JavaMailのデバッグが有効かどうか判定します。

  戻り値:
    JavaMailのデバッグが有効な場合 ture

### setJavaMailLogEnabled

    public void setJavaMailLogEnabled(boolean javaMailLogEnabled)

  JavaMailのデバッグを有効にするかどうか指定します。 有効にすると、`System.out`のデバッグメッセージが出力されます。
  デフォルトは無効になっています。

  パラメータ:
    `javaMailLogEnabled` - The javaMailLogEnabled to set.
  関連項目:
    `javax.mail.session#setDebug(boolean)`

### setMailConverter

    public void setMailConverter(MailConverter mailConverter)

  MailConveterインターフェースの実装インスタンスをセットします。 デフォルトでは、MailConverterImplが使用されます。

  パラメータ:
    `mailConverter` - MailConveterインターフェースの実装インスタンス
  関連項目:
    `com.ozacc.mail.fetch.MailConveter`, `com.ozacc.mail.fetch.impl.MailConveterImpl`

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

Copyright © 2004-2006 OZACC. All Rights Reserved.