パッケージ jakarta.mail

クラス FetchProfile

  • public class FetchProfile
extends ObjectSE
    クライアントは、FetchProfile を使用して、メッセージの範囲についてサーバーからプリフェッチするメッセージ属性をリストします。

    フォルダーから取得したメッセージは軽量のオブジェクトであり、通常、実際のメッセージへの空の参照として始まります。そのようなメッセージオブジェクトは、その特定のメッセージで適切な get *() メソッドが呼び出されると、「オンデマンド」で入力されます。特定のサーバーベースのメッセージアクセスプロトコル（例: IMAP）では、1 回のリクエストでさまざまなメッセージのメッセージ属性をバッチフェッチできます。ある範囲のメッセージにメッセージ属性を使用したいクライアント（例: ヘッダーリストにトップレベルのヘッダーを表示するため）は、そのようなサーバーによって提供される最適化を使用したい場合があります。FetchProfile を使用すると、クライアントはこの要望をサーバーに示すことができます。

    バックエンドサービスがそのようなプロファイルの簡単で効率的なフェッチを許可しない場合があるため、実装は FetchProfiles をサポートする義務を負わないことに注意してください。

    FetchProfile の使用箇所を示すサンプルコードを以下に示します。

    
  Message[] msgs = folder.getMessages();

  FetchProfile fp = new FetchProfile();
  fp.add(FetchProfile.Item.ENVELOPE);
  fp.add("X-mailer");
  folder.fetch(msgs, fp);

    作成者:
    John Mani, Bill Shannon
    関連事項:
    Folder.fetch(jakarta.mail.Message[], jakarta.mail.FetchProfile)

    • ネストされたクラスのサマリー

      ネストされたクラス  
      修飾子と型 クラス 説明
      static class FetchProfile.Item
      この内部クラスは、FetchProfile でリクエストできるすべてのアイテムの基本クラスです。

    • コンストラクターのサマリー

      コンストラクター  
      コンストラクター 説明
      FetchProfile()
      空の FetchProfile を作成します。

    • コンストラクターの詳細

      • FetchProfile

        public FetchProfile()
        空の FetchProfile を作成します。

    • メソッドの詳細

      • add

        public void add​(StringSE headerName)
        指定したヘッダーフィールドを、プリフェッチする属性のリストに追加します。
        パラメーター:
        headerName - プリフェッチされるヘッダー

      • contains

        public boolean contains​(FetchProfile.Item item)
        フェッチプロファイルに指定された特別なアイテムが含まれている場合は true を返します。
        パラメーター:
        item - テストするアイテム
        戻り値:
        フェッチプロファイルに特定の特別なアイテムが含まれている場合は true

      • contains

        public boolean contains​(StringSE headerName)
        フェッチプロファイルに指定されたヘッダー名が含まれている場合は true を返します。
        パラメーター:
        headerName - テストするヘッダー
        戻り値:
        フェッチプロファイルに指定されたヘッダー名が含まれている場合は true

      • getItems

        public FetchProfile.Item[] getItems()
        このプロファイルで設定されたアイテムを取得します。
        戻り値:
        このプロファイルで設定されたアイテム

      • getHeaderNames

        public StringSE[] getHeaderNames()
        このプロファイルで設定されているヘッダーフィールドの名前を取得します。
        戻り値:
        このプロファイルで設定されたヘッダー