パッケージ jakarta.mail.internet
インターフェース MimePart
- すべてのスーパーインターフェース:
Part
- すべての既知の実装クラス:
MimeBodyPart
、MimeMessage
、PreencodedMimeBodyPart
public interface MimePart extends Part
MimePart インターフェースは、MIME(RFC2045、セクション 2.4)で定義されたエンティティをモデル化します。MimePart は Part インターフェースを継承して、RFC822 および MIME 固有のセマンティクスと属性を追加します。MimeMessage および MimeBodyPart クラスの基本インターフェースを提供します
RFC822 および MIME ヘッダーに関する注意RFC822 および MIME ヘッダーフィールドに は、US-ASCII 文字のみを含める必要があります。ヘッダーに US-ASCII 以外の文字が含まれている場合は、RFC 2047 の規則に従ってエンコードする必要があります。このパッケージで提供されている MimeUtility クラスを使用して、これを実現できます。
setHeader
、addHeader
、addHeaderLine
メソッドの呼び出し元は、指定されたヘッダーの MIME 要件を適用する責任があります。さらに、これらのヘッダーフィールドは、トランスポートの行長制限(SMTP の場合は 1000 バイト)を超える場合は、送信する前に折りたたむ(折り返す)必要があります。受信したヘッダーが折りたたまれている可能性があります。アプリケーションは、必要に応じてヘッダーを折りたたんだり展開したりする責任があります。- 作成者:
- John Mani
- 関連事項:
MimeUtility
,Part
フィールドサマリー
インターフェース jakarta.mail.Part から継承されたフィールド
ATTACHMENT, INLINE
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 void
addHeaderLine(StringSE line)
生の RFC822 ヘッダー行を追加します。EnumerationSE<StringSE>
getAllHeaderLines()
すべてのヘッダー行を文字列の列挙として取得します。StringSE
getContentID()
このパーツのコンテンツ ID を取得します。StringSE[]
getContentLanguage()
この MimePart の Content-Language ヘッダーで指定されている言語タグを取得します。StringSE
getContentMD5()
このパートの Content-MD5 ダイジェストを取得します。StringSE
getEncoding()
このパートの転送エンコーディングを取得します。StringSE
getHeader(StringSE name, StringSE delimiter)
このヘッダーで使用可能なすべてのヘッダーフィールドの値を取得します。値は区切り文字で区切られ、単一の文字列として返されます。EnumerationSE<StringSE>
getMatchingHeaderLines(StringSE[] names)
一致するヘッダー行を文字列の列挙として取得します。EnumerationSE<StringSE>
getNonMatchingHeaderLines(StringSE[] names)
一致しないヘッダー行を文字列の列挙として取得します。void
setContentLanguage(StringSE[] languages)
この MimePart の Content-Language ヘッダーを設定します。void
setContentMD5(StringSE md5)
このパーツの Content-MD5 を設定します。void
setText(StringSE text)
指定された文字列をこのパーツのコンテンツとして設定する便利なメソッド。MIME 型は "text/plain" です。void
setText(StringSE text, StringSE charset)
指定された文字列をこのパーツのコンテンツとして設定する便利なメソッド。MIME 型は "text/plain" で、指定された文字セットを使用します。void
setText(StringSE text, StringSE charset, StringSE subtype)
指定された String をこのパートのコンテンツとして設定する簡易メソッド。プライマリ MIME 型は「テキスト」で、指定された MIME サブ型を使用します。インターフェース jakarta.mail.Part から継承されたメソッド
addHeader, getAllHeaders, getContent, getContentType, getDataHandler, getDescription, getDisposition, getFileName, getHeader, getInputStream, getLineCount, getMatchingHeaders, getNonMatchingHeaders, getSize, isMimeType, removeHeader, setContent, setContent, setDataHandler, setDescription, setDisposition, setFileName, setHeader, writeTo
メソッドの詳細
getHeader
StringSE getHeader(StringSE name, StringSE delimiter) throws MessagingException
このヘッダーで使用可能なすべてのヘッダーフィールドの値を取得します。値は区切り文字で区切られた単一の文字列として返されます。区切り文字がnull
の場合、最初の値のみが返されます。- パラメーター:
name
- このヘッダーの名前delimiter
- 返された文字列のフィールド間の区切り文字- 戻り値:
- この名前のすべてのヘッダーの値フィールド
- 例外:
MessagingException
- 失敗
addHeaderLine
void addHeaderLine(StringSE line) throws MessagingException
生の RFC822 ヘッダー行を追加します。- パラメーター:
line
- 追加する行- 例外:
IllegalWriteException
- 基本となる実装が変更をサポートしていない場合IllegalStateExceptionSE
- このパーツが READ_ONLY フォルダーから取得された場合MessagingException
- その他の障害の場合
getAllHeaderLines
EnumerationSE<StringSE> getAllHeaderLines() throws MessagingException
すべてのヘッダー行を文字列の列挙として取得します。ヘッダー行は生の RFC822 ヘッダー行であり、「名前」フィールドと「値」フィールドの両方が含まれています。- 戻り値:
- 文字列の列挙
- 例外:
MessagingException
- 失敗
getMatchingHeaderLines
EnumerationSE<StringSE> getMatchingHeaderLines(StringSE[] names) throws MessagingException
一致するヘッダー行を文字列の列挙として取得します。ヘッダー行は生の RFC822 ヘッダー行であり、「名前」フィールドと「値」フィールドの両方が含まれています。- パラメーター:
names
- 返すヘッダー- 戻り値:
- 文字列の列挙
- 例外:
MessagingException
- 失敗
getNonMatchingHeaderLines
EnumerationSE<StringSE> getNonMatchingHeaderLines(StringSE[] names) throws MessagingException
一致しないヘッダー行を文字列の列挙として取得します。ヘッダー行は生の RFC822 ヘッダー行であり、「名前」フィールドと「値」フィールドの両方が含まれています。- パラメーター:
names
- 返さないヘッダー- 戻り値:
- 文字列の列挙
- 例外:
MessagingException
- 失敗
getEncoding
StringSE getEncoding() throws MessagingException
このパートの転送エンコーディングを取得します。- 戻り値:
- content-transfer-encoding
- 例外:
MessagingException
- 失敗
getContentID
StringSE getContentID() throws MessagingException
このパーツのコンテンツ ID を取得します。存在しない場合は null を返します。- 戻り値:
- コンテンツ ID
- 例外:
MessagingException
- 失敗
getContentMD5
StringSE getContentMD5() throws MessagingException
このパートの Content-MD5 ダイジェストを取得します。存在しない場合は null を返します。- 戻り値:
- content-MD5
- 例外:
MessagingException
- 失敗
setContentMD5
void setContentMD5(StringSE md5) throws MessagingException
このパーツの Content-MD5 を設定します。- パラメーター:
md5
- MD5 値- 例外:
IllegalWriteException
- 基本となる実装が変更をサポートしていない場合IllegalStateExceptionSE
- このパーツが READ_ONLY フォルダーから取得された場合MessagingException
getContentLanguage
StringSE[] getContentLanguage() throws MessagingException
この MimePart の Content-Language ヘッダーで指定されている言語タグを取得します。Content-Language ヘッダーは RFC 1766 で定義されています。このヘッダーが使用できない場合、null
を返します。- 戻り値:
- コンテンツ言語文字列の配列
- 例外:
MessagingException
- 失敗
setContentLanguage
void setContentLanguage(StringSE[] languages) throws MessagingException
この MimePart の Content-Language ヘッダーを設定します。Content-Language ヘッダーは RFC1766 で定義されています。- パラメーター:
languages
- 言語タグの配列- 例外:
IllegalWriteException
- 基本となる実装が変更をサポートしていない場合IllegalStateExceptionSE
- このパーツが READ_ONLY フォルダーから取得された場合MessagingException
setText
void setText(StringSE text) throws MessagingException
指定された文字列をこのパーツのコンテンツとして設定する便利なメソッド。MIME 型は "text/plain" です。文字列に US-ASCII 以外の文字が含まれている場合。プラットフォームのデフォルトの文字セットを使用してエンコードされます。文字セットは、"charset" パラメーターの設定にも使用されます。text
が大きい場合、このメソッドはすべての文字をスキャンして、使用する文字セットを決定する必要があるため、パフォーマンスが低下する可能性があることに注意してください。文字セットが既知の場合は、文字セットパラメーターを受け取る
setText
メソッドを使用します。- 次で指定:
- インターフェース
Part
のsetText
- パラメーター:
text
- 設定するテキストコンテンツ- 例外:
MessagingException
- エラーが発生した場合- 関連事項:
setText(String text, String charset)
setText
void setText(StringSE text, StringSE charset) throws MessagingException
指定された文字列をこのパーツのコンテンツとして設定する便利なメソッド。MIME 型は "text/plain" で、指定された文字セットを使用します。指定された Unicode 文字列は、指定された文字セットを使用して文字セットエンコードされます。文字セットは、"charset" パラメーターの設定にも使用されます。- パラメーター:
text
- 設定するテキストコンテンツcharset
- テキストに使用する文字セット- 例外:
MessagingException
- エラーが発生した場合
setText
void setText(StringSE text, StringSE charset, StringSE subtype) throws MessagingException
指定された文字列をこのパーツのコンテンツとして設定し、プライマリ MIME 型が "text" で指定された MIME サブ型を使用する便利なメソッド。指定された Unicode 文字列は、指定された文字セットを使用して文字セットエンコードされます。文字セットは、"charset" パラメーターの設定にも使用されます。- パラメーター:
text
- 設定するテキストコンテンツcharset
- テキストに使用する文字セットsubtype
- 使用する MIME サブ型 (例: "html" )- 例外:
MessagingException
- エラーが発生した場合- 導入:
- JavaMail 1.4