パッケージ jakarta.mail

クラス Multipart

java.lang.ObjectSE
jakarta.mail.Multipart
既知の直属サブクラス
MimeMultipart
public abstract class Multipart extends ObjectSE
マルチパートは、複数のボディパーツを保持するコンテナーです。マルチパートは、そのサブパートを取得および設定するメソッドを提供します。

Multipart は、ほとんどの Multipart DataContentHandlers によって返されるコンテンツオブジェクトの基本クラスとしても機能します。例: ソースが "multipart/signed" データソースである DataHandler で getContent() を呼び出すと、Multipart の適切なサブクラスが返される場合があります。

一部のメッセージングシステムは、マルチパートのさまざまなサブ型を提供します。例: MIME は、「代替」、「混合」、「関連」、「並列」、「符号付き」などを含むサブ型のセットを指定します。

マルチパートは抽象クラスです。サブクラスは実際の実装を提供します。

作成者:
John Mani

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    protected StringSE
    contentType
    このフィールドは、このマルチパートオブジェクトのコンテンツ型を指定します。
    protected Part
    parent
    既知の場合、この Multipart を含む Part。
    protected VectorSE<BodyPart>
    parts
    BodyPart オブジェクトのベクトル。
    protected final StreamProvider
    streamProvider
    ストリームプロバイダーのインスタンス。

  • コンストラクターの概要

    コンストラクター
    修飾子
    コンストラクター
    説明
    protected
    Multipart()
    デフォルトコンストラクター。

  • 方法の概要

    修飾子と型
    メソッド
    説明
    void
    addBodyPart(BodyPart part)
    マルチパートにパートを追加します。
    void
    addBodyPart(BodyPart part, int index)
    index の位置に BodyPart を追加します。
    BodyPart
    getBodyPart(int index)
    指定されたパートを取得します。
    StringSE
    getContentType()
    このマルチパートのコンテンツ型を返します。
    int
    getCount()
    囲まれた BodyPart オブジェクトの数を返します。
    Part
    getParent()
    この Multipart オブジェクトを含む Part を返します。不明な場合は null を返します。
    void
    removeBodyPart(int index)
    指定された場所（0 から始まる）のパーツを削除します。
    boolean
    removeBodyPart(BodyPart part)
    マルチパートメッセージから指定されたパートを削除します。
    protected void
    setMultipartDataSource(MultipartDataSource mp)
    与えられた MultipartDataSource からこの Multipart オブジェクトをセットアップします。
    void
    setParent(Part parent)
    この Multipart の親を指定された Part に設定します。
    abstract void
    writeTo(OutputStreamSE os)
    適切にエンコードされたバイトストリームを指定された OutputStream に出力します。

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

  • フィールドの詳細

    • parts

      protected VectorSE<BodyPart> parts
      BodyPart オブジェクトのベクトル。

    • contentType

      protected StringSE contentType
      このフィールドは、このマルチパートオブジェクトのコンテンツ型を指定します。デフォルトは "multipart/mixed" です。

    • parent

      protected Part parent
      既知の場合、この Multipart を含む Part。
      導入:
      JavaMail 1.1

    • streamProvider

      protected final StreamProvider streamProvider
      ストリームプロバイダーのインスタンス。
      導入:
      JavaMail 2.1

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

    • Multipart

      protected Multipart()
      デフォルトのコンストラクター。空の Multipart オブジェクトが作成されます。

  • メソッドの詳細

    • setMultipartDataSource

      protected void setMultipartDataSource(MultipartDataSource mp) throws MessagingException
      与えられた MultipartDataSource からこの Multipart オブジェクトをセットアップします。

      このメソッドは、MultipartDataSource の BodyPart オブジェクトをこのマルチパートに追加します。このマルチパートの contentType は、MultipartDataSource の contentType に設定されます。

      このメソッドは通常、すでに個々のボディパーツに事前に解析されているマルチパートデータソース（IMAP データソースなど）があるが、特定のマルチパートサブ型を表す適切なマルチパートサブクラスを作成する必要がある場合に使用されます。

      パラメーター:
      mp - マルチパートデータソース
      例外:
      MessagingException - 失敗

    • getContentType

      public StringSE getContentType()
      このマルチパートのコンテンツ型を返します。

      この実装は、contentType フィールドの値を返すだけです。

      戻り値:
      content-type
      関連事項:

    • getCount

      public int getCount() throws MessagingException
      囲まれた BodyPart オブジェクトの数を返します。
      戻り値:
      パーツ数
      例外:
      MessagingException - 失敗
      関連事項:

    • getBodyPart

      public BodyPart getBodyPart(int index) throws MessagingException
      指定されたパートを取得します。パーツには 0 から始まる番号が付けられています。
      パラメーター:
      index - 目的のパートのインデックス
      戻り値:
      一部
      例外:
      IndexOutOfBoundsExceptionSE - 指定されたインデックスが範囲外の場合。
      MessagingException - その他の障害の場合

    • removeBodyPart

      public boolean removeBodyPart(BodyPart part) throws MessagingException
      マルチパートメッセージから指定されたパートを削除します。削除されたパーツの後のすべてのパーツを 1 つ下に移動します。
      パラメーター:
      part - 削除する部分
      戻り値:
      パーツが削除された場合は true、そうでない場合は false
      例外:
      MessagingException - そのようなパートが存在しない場合
      IllegalWriteException - 基本となる実装が既存の値の変更をサポートしていない場合

    • removeBodyPart

      public void removeBodyPart(int index) throws MessagingException
      指定された場所（0 から始まる）のパーツを削除します。削除されたパーツの後のすべてのパーツを 1 つ下に移動します。
      パラメーター:
      index - 削除するパーツのインデックス
      例外:
      IndexOutOfBoundsExceptionSE - 指定されたインデックスが範囲外の場合。
      IllegalWriteException - 基本となる実装が既存の値の変更をサポートしていない場合
      MessagingException - その他の障害の場合

    • addBodyPart

      public void addBodyPart(BodyPart part) throws MessagingException
      マルチパートにパートを追加します。BodyPart が既存のパーツのリストに追加されます。
      パラメーター:
      part - 追加するパーツ
      例外:
      IllegalWriteException - 基本となる実装が既存の値の変更をサポートしていない場合
      MessagingException - その他の障害の場合

    • addBodyPart

      public void addBodyPart(BodyPart part, int index) throws MessagingException
      index の位置に BodyPart を追加します。index がリストの最後のものでない場合、後続の部分は上にシフトされます。index が存在するパーツの数より大きい場合、BodyPart が末尾に追加されます。
      パラメーター:
      part - 挿入する BodyPart
      index - パーツを挿入する場所
      例外:
      IllegalWriteException - 基本となる実装が既存の値の変更をサポートしていない場合
      MessagingException - その他の障害の場合

    • writeTo

      public abstract void writeTo(OutputStreamSE os) throws IOExceptionSE, MessagingException
      適切にエンコードされたバイトストリームを指定された OutputStream に出力します。実装サブクラスは、使用する適切なエンコーディングアルゴリズムを決定します。バイトストリームは通常、送信に使用されます。
      パラメーター:
      os - 書き込むストリーム
      例外:
      IOExceptionSE - IO 関連の例外が発生した場合
      MessagingException - その他の障害の場合

    • getParent

      public Part getParent()
      この Multipart オブジェクトを含む Part を返します。不明な場合は null を返します。
      戻り値:
      親パート
      導入:
      JavaMail 1.1

    • setParent

      public void setParent(Part parent)
      この Multipart の親を指定された Part に設定します。通常、Message または BodyPart setContent(Multipart) メソッドによって呼び出されます。Multipart が含まれている Part から削除されている場合、parent は null である可能性があります。
      パラメーター:
      parent - 親パート
      導入:
      JavaMail 1.1