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

## com.sun.mail.imap
クラス IMAPBodyPart

    java.lang.Object
      javax.mail.BodyPart
          javax.mail.internet.MimeBodyPart
              com.sun.mail.imap.IMAPBodyPart

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

    public final class IMAPBodyPart

extends MimeBodyPart

フィールドの概要

クラス javax.mail.internet.MimeBodyPart から継承されたフィールド
`content, contentStream, dh, headers`

クラス javax.mail.BodyPart から継承されたフィールド
`parent`

インタフェース javax.mail.Part から継承されたフィールド
`ATTACHMENT, INLINE`

コンストラクタの概要
`protected` | `IMAPBodyPart(com.sun.mail.imap.protocol.BODYSTRUCTURE bs, String sid, IMAPMessage message)` コンストラクタです。

メソッドの概要
`void` | `addHeader(String name, String value)` この値をこの header_name の既存値に追加します。
`void` | `addHeaderLine(String line)` ヘッダ行をこの本文部分に追加します。
`Enumeration` | `getAllHeaderLines()` 全てのヘッダ行を String の列挙型として取得します。
`Enumeration` | `getAllHeaders()` この Message の全てのヘッダを Header オブジェクトの列挙型として返します。
`String` | `getContentID()` "Content-ID" ヘッダフィールドの値を返します。
`String` | `getContentMD5()` "Content-MD5" ヘッダフィールドの値を返します。
`protected InputStream` | `getContentStream()` 内容の生バイトを生成します。
`String` | `getContentType()` RFC 822 "Content-Type" ヘッダフィールドの値を返します。
`DataHandler` | `getDataHandler()` この本文部分の内容の DataHandler を返します。
`String` | `getDescription()` この本文部分の "Content-Description" ヘッダフィールドを返します。
`String` | `getDisposition()` "Content-Disposition" ヘッダフィールドの値を返します。
`String` | `getEncoding()` "Content-Transfer-Encoding" ヘッダフィールドからの内容転送エンコーディングを返します。
`String` | `getFileName()` この本文部分に関連付けられたファイル名を取得します。
`String[]` | `getHeader(String name)` この header_name の全てのヘッダを取得します。
`int` | `getLineCount()` この Part の内容の行数を返します。
`Enumeration` | `getMatchingHeaderLines(String[] names)` 一致するヘッダ行を String の列挙型として取得します。
`Enumeration` | `getMatchingHeaders(String[] names)` この Message の一致するヘッダを Header オブジェクトの列挙型として返します。
`Enumeration` | `getNonMatchingHeaderLines(String[] names)` 一致しないヘッダ行を String の列挙型として取得します。
`Enumeration` | `getNonMatchingHeaders(String[] names)` この Message の一致しないヘッダを Header オブジェクトの列挙型として返します。
`int` | `getSize()` この本文部分の内容サイズをバイト単位で返します。
`void` | `removeHeader(String name)` この名前を持つ全てのヘッダを削除します。
`void` | `setContent(Multipart mp)` このメソッドは本文部分の内容を Multipart オブジェクトに設定します。
`void` | `setContent(Object o, String type)` この本文部分の内容を設定する為の簡易メソッドです。
`void` | `setContentMD5(String md5)` この本文部分の "Content-MD5" ヘッダフィールドを設定します。
`void` | `setDataHandler(DataHandler content)` このメソッドは、この本文部分の内容を設定する為の仕組みを提供します。
`void` | `setDescription(String description, String charset)` この本文部分の "Content-Description" ヘッダを設定します。
`void` | `setDisposition(String disposition)` この本文部分の "Content-Disposition" ヘッダフィールドを設定します。
`void` | `setFileName(String filename)` 可能であれば、この本文部分に関連付けられたファイル名を設定します。
`void` | `setHeader(String name, String value)` この header_name の値を設定します。
`protected void` | `updateHeaders()` この本文部分の内容を検査し、適切な MIME ヘッダを更新します。

クラス javax.mail.internet.MimeBodyPart から継承されたメソッド
`attachFile, attachFile, getContent, getContentLanguage, getHeader, getInputStream, getRawInputStream, isMimeType, saveFile, saveFile, setContentID, setContentLanguage, setDescription, setText, setText, setText, writeTo`

クラス javax.mail.BodyPart から継承されたメソッド
`getParent`

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

コンストラクタの詳細

### IMAPBodyPart

    protected IMAPBodyPart(com.sun.mail.imap.protocol.BODYSTRUCTURE bs,
                           String sid,
                           IMAPMessage message)

  コンストラクタです。

  パラメータ:
    `bs` -
    `sid` -
    `message` -

メソッドの詳細

### updateHeaders

    protected void updateHeaders()

  クラス `MimeBodyPart` の記述:
  この本文部分の内容を検査し、適切な MIME ヘッダを更新します。 ここで設定される一般的なヘッダは `Content-Type` と `Content-Transfer-Encoding` です。 ヘッダの更新は次の 2 つの場合に必要になります。
  - メールアプリケーションにより作成されるメッセージは、内部ヘッダを満たす為に、 ある時点でこのメソッドをアクティブにする必要があります。
  - Store から読み込まれるメッセージは全てのヘッダを格納場所から取得するので、これは必要ではありません。 但し、メッセージが編集可能で内容又はメッセージ構造に編集が行われた場合、 ヘッダの再同期が必要となる場合があります。
  どちらの場合も、このメソッドは通常 `Message.saveChanges` メソッドにより呼び出されます。

  オーバーライド:
    クラス `MimeBodyPart` 内の `updateHeaders`

### getSize

    public int getSize()
                throws MessagingException

  クラス `MimeBodyPart` の記述:
  この本文部分の内容サイズをバイト単位で返します。 サイズが識別できない場合は -1 を返します。

  この数値は内容サイズの正確な測定値でない可能性があり、 内容の転送エンコーディングを示す事もそうでない事もある点に注意して下さい。

  この実装は、`content` 配列 のサイズ (null でない場合)、 又は `contentStream` が null でなく、 `available` メソッドが正の数を返す場合、 その数をサイズとして返します。それ以外の場合は -1 を返します。

  定義:
    インタフェース `Part` 内の `getSize`
  オーバーライド:
    クラス `MimeBodyPart` 内の `getSize`
  戻り値:
    バイト単位のサイズ、又は不明の場合 -1
  例外:
    `MessagingException`

### getLineCount

    public int getLineCount()
                     throws MessagingException

  クラス `MimeBodyPart` の記述:
  この Part の内容の行数を返します。 この数値が識別できない場合は -1 を返します。

  この数値は内容の長さの正確な測定値でない可能性があり、 内容の転送エンコーディングを示す事もそうでない事もある点に注意して下さい。

  この実装は -1 を返します。

  定義:
    インタフェース `Part` 内の `getLineCount`
  オーバーライド:
    クラス `MimeBodyPart` 内の `getLineCount`
  戻り値:
    行数、又は不明の場合 -1
  例外:
    `MessagingException`

### getContentType

    public String getContentType()
                          throws MessagingException

  クラス `MimeBodyPart` の記述:
  RFC 822 "Content-Type" ヘッダフィールドの値を返します。 これは、この本文部分の内容のコンテンツ形式を表します。 この値は null であってはなりません。 このフィールドが使用可能でない場合、"text/plain" が返されます。

  この実装は `getHeader(name)` を使用し、 必要なヘッダフィールドを取得します。

  定義:
    インタフェース `Part` 内の `getContentType`
  オーバーライド:
    クラス `MimeBodyPart` 内の `getContentType`
  戻り値:
    この本文部分の Content-Type
  例外:
    `MessagingException`
  関連項目:
    `DataHandler`

### getDisposition

    public String getDisposition()
                          throws MessagingException

  クラス `MimeBodyPart` の記述:
  "Content-Disposition" ヘッダフィールドの値を返します。これはこの部分の処置を表します。 この部分がどの様にユーザに提示されるかを示します。

  Content-Disposition フィールドが使用できない場合は null が返されます。

  この実装は `getHeader(name)` を使用し、必要なヘッダフィールドを取得します。

  定義:
    インタフェース `Part` 内の `getDisposition`
  オーバーライド:
    クラス `MimeBodyPart` 内の `getDisposition`
  戻り値:
    この Part の処置、又は不明の場合は null
  例外:
    `MessagingException`
  関連項目:
    `MimeBodyPart.headers`

### setDisposition

    public void setDisposition(String disposition)
                        throws MessagingException

  クラス `MimeBodyPart` の記述:
  この本文部分の "Content-Disposition" ヘッダフィールドを設定します。 処置が null の場合は、既存の全ての "Content-Disposition" ヘッダフィールドが削除されます。

  定義:
    インタフェース `Part` 内の `setDisposition`
  オーバーライド:
    クラス `MimeBodyPart` 内の `setDisposition`
  パラメータ:
    `disposition` - この Part の処置
  例外:
    `MessagingException`
    `IllegalWriteException` - 実装がこのヘッダの変更をサポートしない場合
  関連項目:
    `Part.ATTACHMENT`, `Part.INLINE`, `Part.setFileName(java.lang.String)`

### getEncoding

    public String getEncoding()
                       throws MessagingException

  クラス `MimeBodyPart` の記述:
  "Content-Transfer-Encoding" ヘッダフィールドからの内容転送エンコーディングを返します。 ヘッダが使用できない場合、又はその値が存在しない場合は `null` を返します。

  この実装は `getHeader(name)` を使用し、必要なヘッダフィールドを取得します。

  定義:
    インタフェース `MimePart` 内の `getEncoding`
  オーバーライド:
    クラス `MimeBodyPart` 内の `getEncoding`
  戻り値:
    内容転送エンコーディング
  例外:
    `MessagingException`
  関連項目:
    `MimeBodyPart.headers`

### getContentID

    public String getContentID()
                        throws MessagingException

  クラス `MimeBodyPart` の記述:
  "Content-ID" ヘッダフィールドの値を返します。フィールドが使用できない場合、 又はその値が存在しない場合は `null` を返します。

  この実装は `getHeader(name)` を使用し、必要なヘッダフィールドを取得します。

  定義:
    インタフェース `MimePart` 内の `getContentID`
  オーバーライド:
    クラス `MimeBodyPart` 内の `getContentID`
  戻り値:
    コンテンツ ID
  例外:
    `MessagingException`

### getContentMD5

    public String getContentMD5()
                         throws MessagingException

  クラス `MimeBodyPart` の記述:
  "Content-MD5" ヘッダフィールドの値を返します。フィールドが使用できない場合、 又はその値が存在しない場合は `null` を返します。

  この実装は `getHeader(name)` を使用し、必要なヘッダフィールドを取得します。

  定義:
    インタフェース `MimePart` 内の `getContentMD5`
  オーバーライド:
    クラス `MimeBodyPart` 内の `getContentMD5`
  戻り値:
    コンテンツ MD5
  例外:
    `MessagingException`

### setContentMD5

    public void setContentMD5(String md5)
                       throws MessagingException

  クラス `MimeBodyPart` の記述:
  この本文部分の "Content-MD5" ヘッダフィールドを設定します。

  定義:
    インタフェース `MimePart` 内の `setContentMD5`
  オーバーライド:
    クラス `MimeBodyPart` 内の `setContentMD5`
  パラメータ:
    `md5` - コンテンツ ID
  例外:
    `MessagingException`

### getDescription

    public String getDescription()
                          throws MessagingException

  クラス `MimeBodyPart` の記述:
  この本文部分の "Content-Description" ヘッダフィールドを返します。 これは通常一部の情報をこの部分に関連付けます。このフィールドが使用できない場合、 又はその値が存在しない場合は `null` を返します。

  Content-Description フィールドが RFC 2047 に従ってエンコーディングされている場合、 デコードされ、Unicode に変換されます。デコーディングまたは変換が失敗した場合、 生データがそのまま返されます。

  この実装は `getHeader(name)` を使用し、必要なヘッダフィールドを取得します。

  定義:
    インタフェース `Part` 内の `getDescription`
  オーバーライド:
    クラス `MimeBodyPart` 内の `getDescription`
  戻り値:
    内容の説明
  例外:
    `MessagingException`

### setDescription

    public void setDescription(String description,
                               String charset)
                        throws MessagingException

  クラス `MimeBodyPart` の記述:
  この本文部分の "Content-Description" ヘッダを設定します。 description パラメータが `null` の場合は、 既存の全ての "Content-Description" フィールドが削除されます。

  description に US-ASCII 以外の文字が含まれる場合は、 指定された文字セットを使用してエンコードされます。 description に US-ASCII 文字だけが含まれる場合は、 エンコーディングは行われず、そのまま使用されます。

  文字セットエンコーディング処理が失敗する場合、MessagingException がスローされ、 UnsupportedEncodingException が MessagingException 内の入れ子にされた 例外のチェーンに含まれる事に注意して下さい。

  オーバーライド:
    クラス `MimeBodyPart` 内の `setDescription`
  パラメータ:
    `description` - 説明
    `charset` - エンコーディングのための文字セット
  例外:
    `MessagingException` - 文字セット変換が失敗すると、 UnsupportedEncodingException が例外チェーンに含まれる場合があります。

### getFileName

    public String getFileName()
                       throws MessagingException

  クラス `MimeBodyPart` の記述:
  この本文部分に関連付けられたファイル名を取得します。

  この本文部分の "Content-Disposition" ヘッダフィールドにおける "filename" パラメータの値を返します。 このパラメータが使用できない場合は、この 本文部分の "Content-Type" ヘッダフィールドにおける "name" パラメータの値を返します。 両方とも存在しない場合は `null` を返します。

  定義:
    インタフェース `Part` 内の `getFileName`
  オーバーライド:
    クラス `MimeBodyPart` 内の `getFileName`
  戻り値:
    ファイル名
  例外:
    `MessagingException`

### setFileName

    public void setFileName(String filename)
                     throws MessagingException

  クラス `MimeBodyPart` の記述:
  可能であれば、この本文部分に関連付けられたファイル名を設定します。

  この本文部分の "Content-Disposition" ヘッダフィールドにおける "filename" パラメータを設定します。

  定義:
    インタフェース `Part` 内の `setFileName`
  オーバーライド:
    クラス `MimeBodyPart` 内の `setFileName`
  パラメータ:
    `filename` - この Part に関連付けるファイル名
  例外:
    `IllegalWriteException` - 実装がこのヘッダの変更をサポートしない場合
    `MessagingException`

### getContentStream

    protected InputStream getContentStream()
                                    throws MessagingException

  クラス `MimeBodyPart` の記述:
  内容の生バイトを生成します。 このメソッドは内容の DataHandler オブジェクトを作成する時に使用されます。 Part 内容だけの別個の入力ストリームを提供可能な サブクラスはこのメソッドをオーバーライドする場合があります。

  オーバーライド:
    クラス `MimeBodyPart` 内の `getContentStream`
  例外:
    `MessagingException`
  関連項目:
    `MimeBodyPart.content`, `MimeMessage.getContentStream()`

### getDataHandler

    public DataHandler getDataHandler()
                               throws MessagingException

  クラス `MimeBodyPart` の記述:
  この本文部分の内容の DataHandler を返します。

  ここで提供される実装は、丁度 MimeMessage の実装の様に機能します。

  定義:
    インタフェース `Part` 内の `getDataHandler`
  オーバーライド:
    クラス `MimeBodyPart` 内の `getDataHandler`
  戻り値:
    コンテンツの DataHandler
  例外:
    `MessagingException`
  関連項目:
    `MimeMessage.getDataHandler()`

### setDataHandler

    public void setDataHandler(DataHandler content)
                        throws MessagingException

  クラス `MimeBodyPart` の記述:
  このメソッドは、この本文部分の内容を設定する為の仕組みを提供します。 指定された DataHandler オブジェクトは、実際の内容をラップしなければなりません。

  定義:
    インタフェース `Part` 内の `setDataHandler`
  オーバーライド:
    クラス `MimeBodyPart` 内の `setDataHandler`
  パラメータ:
    `content` - コンテンツの DataHandler
  例外:
    `MessagingException`
    `IllegalWriteException` - 実装がこのヘッダの変更をサポートしない場合

### setContent

    public void setContent(Object o,
                           String type)
                    throws MessagingException

  クラス `MimeBodyPart` の記述:
  この本文部分の内容を設定する為の簡易メソッドです。

  コンテンツは DataHandler オブジェクト内にラップされます。これが正しく機能する為に、 指定されたタイプの DataContentHandler クラスが JavaMail 実装に対して使用可能でなければならない事に注意して下さい。 つまり、`setContent(foobar, "application/x-foobar")` を実行する為に、 "application/x-foobar" の DataContentHandler がインストールされている必要があります。 詳細については Java Activation Framework を参照して下さい。

  定義:
    インタフェース `Part` 内の `setContent`
  オーバーライド:
    クラス `MimeBodyPart` 内の `setContent`
  パラメータ:
    `o` - コンテンツオブジェクト
    `type` - オブジェクトの MIME タイプ
  例外:
    `IllegalWriteException` - 実装がこのヘッダの変更をサポートしない場合
    `MessagingException`

### setContent

    public void setContent(Multipart mp)
                    throws MessagingException

  クラス `MimeBodyPart` の記述:
  このメソッドは本文部分の内容を Multipart オブジェクトに設定します。

  定義:
    インタフェース `Part` 内の `setContent`
  オーバーライド:
    クラス `MimeBodyPart` 内の `setContent`
  パラメータ:
    `mp` - Message のコンテンツである multipart オブジェクト
  例外:
    `IllegalWriteException` - 実装がこのヘッダの変更をサポートしない場合
    `MessagingException`

### getHeader

    public String[] getHeader(String name)
                       throws MessagingException

  クラス `MimeBodyPart` の記述:
  この header_name の全てのヘッダを取得します。 ヘッダが US-ASCII 以外の文字を含む場合、RFC 2047 に基づきエンコードされる事があり、 デコードが必要となる事に注意して下さい。

  定義:
    インタフェース `Part` 内の `getHeader`
  オーバーライド:
    クラス `MimeBodyPart` 内の `getHeader`
  パラメータ:
    `name` - ヘッダの名前
  戻り値:
    ヘッダの配列
  例外:
    `MessagingException`
  関連項目:
    `MimeUtility`

### setHeader

    public void setHeader(String name,
                          String value)
                   throws MessagingException

  クラス `MimeBodyPart` の記述:
  この header_name の値を設定します。既存の全てのヘッダ値をこの新しい値で置き換えます。 RFC 822 ヘッダは US-ASCII 文字のみを含まなければならない為、 US-ASCII 以外の文字を含むヘッダは RFC 2047 の規則に従ってエンコードされなければならない事に注意して下さい。

  定義:
    インタフェース `Part` 内の `setHeader`
  オーバーライド:
    クラス `MimeBodyPart` 内の `setHeader`
  パラメータ:
    `name` - ヘッダ名
    `value` - ヘッダ値
  例外:
    `MessagingException`
    `IllegalWriteException` - 実装がこのヘッダの変更をサポートしない場合
  関連項目:
    `MimeUtility`

### addHeader

    public void addHeader(String name,
                          String value)
                   throws MessagingException

  クラス `MimeBodyPart` の記述:
  この値をこの header_name の既存値に追加します。 RFC 822 ヘッダは US-ASCII 文字のみを含まなければならない為、 US-ASCII 以外の文字を含むヘッダは RFC 2047 の規則に従ってエンコードされなければならない事に注意して下さい。

  定義:
    インタフェース `Part` 内の `addHeader`
  オーバーライド:
    クラス `MimeBodyPart` 内の `addHeader`
  パラメータ:
    `name` - ヘッダ名
    `value` - ヘッダ値
  例外:
    `MessagingException`
    `IllegalWriteException` - 実装がこのヘッダの変更をサポートしない場合
  関連項目:
    `MimeUtility`

### removeHeader

    public void removeHeader(String name)
                      throws MessagingException

  クラス `MimeBodyPart` の記述:
  この名前を持つ全てのヘッダを削除します。

  定義:
    インタフェース `Part` 内の `removeHeader`
  オーバーライド:
    クラス `MimeBodyPart` 内の `removeHeader`
  パラメータ:
    `name` - このヘッダの名前
  例外:
    `MessagingException`
    `IllegalWriteException` - 実装がこのヘッダの変更をサポートしない場合

### getAllHeaders

    public Enumeration getAllHeaders()
                              throws MessagingException

  クラス `MimeBodyPart` の記述:
  この Message の全てのヘッダを Header オブジェクトの列挙型として返します。

  定義:
    インタフェース `Part` 内の `getAllHeaders`
  オーバーライド:
    クラス `MimeBodyPart` 内の `getAllHeaders`
  戻り値:
    Header オブジェクトの配列
  例外:
    `MessagingException`

### getMatchingHeaders

    public Enumeration getMatchingHeaders(String[] names)
                                   throws MessagingException

  クラス `MimeBodyPart` の記述:
  この Message の一致するヘッダを Header オブジェクトの列挙型として返します。

  定義:
    インタフェース `Part` 内の `getMatchingHeaders`
  オーバーライド:
    クラス `MimeBodyPart` 内の `getMatchingHeaders`
  戻り値:
    Header オブジェクトの配列
  例外:
    `MessagingException`

### getNonMatchingHeaders

    public Enumeration getNonMatchingHeaders(String[] names)
                                      throws MessagingException

  クラス `MimeBodyPart` の記述:
  この Message の一致しないヘッダを Header オブジェクトの列挙型として返します。

  定義:
    インタフェース `Part` 内の `getNonMatchingHeaders`
  オーバーライド:
    クラス `MimeBodyPart` 内の `getNonMatchingHeaders`
  戻り値:
    Header オブジェクトの配列
  例外:
    `MessagingException`

### addHeaderLine

    public void addHeaderLine(String line)
                       throws MessagingException

  クラス `MimeBodyPart` の記述:
  ヘッダ行をこの本文部分に追加します。

  定義:
    インタフェース `MimePart` 内の `addHeaderLine`
  オーバーライド:
    クラス `MimeBodyPart` 内の `addHeaderLine`
  例外:
    `MessagingException`

### getAllHeaderLines

    public Enumeration getAllHeaderLines()
                                  throws MessagingException

  クラス `MimeBodyPart` の記述:
  全てのヘッダ行を String の列挙型として取得します。 Header 行は生の RFC 822 ヘッダ行であり、"name" 及び "value" の両フィールドを含みます。

  定義:
    インタフェース `MimePart` 内の `getAllHeaderLines`
  オーバーライド:
    クラス `MimeBodyPart` 内の `getAllHeaderLines`
  例外:
    `MessagingException`

### getMatchingHeaderLines

    public Enumeration getMatchingHeaderLines(String[] names)
                                       throws MessagingException

  クラス `MimeBodyPart` の記述:
  一致するヘッダ行を String の列挙型として取得します。 Header 行は生の RFC 822 ヘッダ行であり、"name" 及び "value" の両フィールドを含みます。

  定義:
    インタフェース `MimePart` 内の `getMatchingHeaderLines`
  オーバーライド:
    クラス `MimeBodyPart` 内の `getMatchingHeaderLines`
  例外:
    `MessagingException`

### getNonMatchingHeaderLines

    public Enumeration getNonMatchingHeaderLines(String[] names)
                                          throws MessagingException

  クラス `MimeBodyPart` の記述:
  一致しないヘッダ行を String の列挙型として取得します。 Header 行は生の RFC 822 ヘッダ行であり、"name" 及び "value" の両フィールドを含みます。

  定義:
    インタフェース `MimePart` 内の `getNonMatchingHeaderLines`
  オーバーライド:
    クラス `MimeBodyPart` 内の `getNonMatchingHeaderLines`
  例外:
    `MessagingException`

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