com.sun.mail.pop3
クラス POP3Message

java.lang.Object
  上位を拡張 javax.mail.Message
      上位を拡張 javax.mail.internet.MimeMessage
          上位を拡張 com.sun.mail.pop3.POP3Message
すべての実装されたインタフェース:
MimePart, Part

public final class POP3Message
extends MimeMessage

POP3 メッセージです。 MimeMessage の幾つかの物はサポートされません。


入れ子のクラスの概要
 
クラス javax.mail.internet.MimeMessage から継承された入れ子のクラス/インタフェース
MimeMessage.RecipientType
 
フィールドの概要
 
クラス javax.mail.internet.MimeMessage から継承されたフィールド
content, contentStream, dh, flags, headers, modified, saved
 
クラス javax.mail.Message から継承されたフィールド
expunged, msgnum, session
 
インタフェース javax.mail.Part から継承されたフィールド
ATTACHMENT, INLINE
 
コンストラクタの概要
POP3Message(Folder folder, int msgno)
          コンストラクタです。
 
メソッドの概要
 void addHeader(String name, String value)
          この値をこの header_name の既存値に追加します。
 void addHeaderLine(String line)
          生の RFC822 ヘッダ行を追加します。
 Enumeration getAllHeaderLines()
          全てのヘッダ行を String の Enumeration として取得します。
 Enumeration getAllHeaders()
          この Message の全てのヘッダを Header オブジェクトの列挙として返します。
protected  InputStream getContentStream()
          内容の生バイトを生成します。
 String[] getHeader(String name)
          この header_name の全てのヘッダを取得します。
 String getHeader(String name, String delimiter)
          このヘッダ名の全てのヘッダを取得し、区切り文字で区切られたヘッダが単一の String として返されます。
 Enumeration getMatchingHeaderLines(String[] names)
          一致するヘッダ行を String の Enumeration として取得します。
 Enumeration getMatchingHeaders(String[] names)
          この Message から一致するヘッダを Header オブジェクトの Enumeration として返します。
 Enumeration getNonMatchingHeaderLines(String[] names)
          一致しないヘッダ行を String の Enumeration として取得します。
 Enumeration getNonMatchingHeaders(String[] names)
          この Message から一致しないヘッダを Header オブジェクトの Enumeration として返します。
 int getSize()
          このメッセージの内容サイズをバイト単位で返します。
 void invalidate(boolean invalidateHeaders)
          Invalidate the cache of content for this message object, causing it to be fetched again from the server the next time it is needed.
 void removeHeader(String name)
          この名前を持つ全てのヘッダを削除します。
 void saveChanges()
          POP3 メッセージは変更できません。
 void setFlags(Flags newFlags, boolean set)
          このメッセージに指定されたフラグを指定した値で設定します。
 void setHeader(String name, String value)
          この header_name の値を設定します。
 InputStream top(int n)
          Fetch the header of the message and the first n lines of the raw content of the message.
 
クラス javax.mail.internet.MimeMessage から継承されたメソッド
addFrom, addRecipients, addRecipients, createInternetHeaders, getAllRecipients, getContent, getContentID, getContentLanguage, getContentMD5, getContentType, getDataHandler, getDescription, getDisposition, getEncoding, getFileName, getFlags, getFrom, getInputStream, getLineCount, getMessageID, getRawInputStream, getReceivedDate, getRecipients, getReplyTo, getSender, getSentDate, getSubject, isMimeType, isSet, parse, reply, setContent, setContent, setContentID, setContentLanguage, setContentMD5, setDataHandler, setDescription, setDescription, setDisposition, setFileName, setFrom, setFrom, setRecipients, setRecipients, setReplyTo, setSender, setSentDate, setSubject, setSubject, setText, setText, updateHeaders, writeTo, writeTo
 
クラス javax.mail.Message から継承されたメソッド
addRecipient, getFolder, getMessageNumber, isExpunged, match, setExpunged, setFlag, setMessageNumber, setRecipient
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

POP3Message

public POP3Message(Folder folder,
                   int msgno)
コンストラクタです。

メソッドの詳細

setFlags

public void setFlags(Flags newFlags,
                     boolean set)
              throws MessagingException
このメッセージに指定されたフラグを指定した値で設定します。

オーバーライド:
クラス MimeMessage 内の setFlags
パラメータ:
newFlags - 設定するフラグ
set - 設定する値
例外:
MessagingException
IllegalWriteException - 実装が既存値の変更をサポートしない場合
関連項目:
MessageChangedEvent

getSize

public int getSize()
            throws MessagingException
このメッセージの内容サイズをバイト単位で返します。 サイズが識別できない場合は -1 を返します。

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

定義:
インタフェース Part 内の getSize
オーバーライド:
クラス MimeMessage 内の getSize
戻り値:
内容バイトのサイズ
例外:
MessagingException

getContentStream

protected InputStream getContentStream()
                                throws MessagingException
内容の生バイトを生成します。 データは POP3 RETR コマンドを使用してフェッチされます。

オーバーライド:
クラス MimeMessage 内の getContentStream
例外:
MessagingException
関連項目:
MimeMessage.contentStream

invalidate

public void invalidate(boolean invalidateHeaders)
Invalidate the cache of content for this message object, causing it to be fetched again from the server the next time it is needed. If invalidateHeaders is true, invalidate the headers as well.

パラメータ:
invalidateHeaders - invalidate the headers as well?

top

public InputStream top(int n)
                throws MessagingException
Fetch the header of the message and the first n lines of the raw content of the message. The headers and data are available in the returned InputStream.

パラメータ:
n - number of lines of content to fetch
戻り値:
InputStream containing the message headers and n content lines
例外:
MessagingException

getHeader

public String[] getHeader(String name)
                   throws MessagingException
この header_name の全てのヘッダを取得します。 ヘッダが US-ASCII 以外の文字を含む場合、 RFC 2047 に基づきエンコードされているので、 デコードが必要となる事に注意して下さい。

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

getHeader

public String getHeader(String name,
                        String delimiter)
                 throws MessagingException
このヘッダ名の全てのヘッダを取得し、区切り文字で区切られたヘッダが単一の String として返されます。 delimiter が null の場合は、最初のヘッダだけが返されます。

定義:
インタフェース MimePart 内の getHeader
オーバーライド:
クラス MimeMessage 内の getHeader
パラメータ:
name - このヘッダの名前
delimiter - 区切り文字
戻り値:
この名前を持つ全てのヘッダに対する値フィールド
例外:
MessagingException

setHeader

public void setHeader(String name,
                      String value)
               throws MessagingException
この header_name の値を設定します。 POP3 メッセージは読込み専用なので IllegalWriteException をスローします。

定義:
インタフェース Part 内の setHeader
オーバーライド:
クラス MimeMessage 内の setHeader
パラメータ:
name - ヘッダの名前
value - ヘッダの値
例外:
IllegalWriteException - 実装が変更をサポートしない場合
IllegalStateException - このメッセージが READ_ONLY フォルダから取得された場合
MessagingException
関連項目:
MimeUtility

addHeader

public void addHeader(String name,
                      String value)
               throws MessagingException
この値をこの header_name の既存値に追加します。 POP3 メッセージは読込み専用なので IllegalWriteException をスローします。

定義:
インタフェース Part 内の addHeader
オーバーライド:
クラス MimeMessage 内の addHeader
パラメータ:
name - ヘッダ名
value - ヘッダ値
例外:
IllegalWriteException - 実装が変更をサポートしない場合
IllegalStateException - このメッセージが READ_ONLY フォルダから取得された場合
MessagingException
関連項目:
MimeUtility

removeHeader

public void removeHeader(String name)
                  throws MessagingException
この名前を持つ全てのヘッダを削除します。 POP3 メッセージは読込み専用なので IllegalWriteException をスローします。

定義:
インタフェース Part 内の removeHeader
オーバーライド:
クラス MimeMessage 内の removeHeader
パラメータ:
name - このヘッダの名前
例外:
IllegalWriteException - 実装が変更をサポートしない場合
IllegalStateException - このメッセージが READ_ONLY フォルダから取得された場合
MessagingException

getAllHeaders

public Enumeration getAllHeaders()
                          throws MessagingException
この Message の全てのヘッダを Header オブジェクトの列挙として返します。

ヘッダが US-ASCII 以外の文字を含む場合、 RFC 2047 にもとづいてエンコードされているので、 デコードが必要となる事に注意して下さい。

定義:
インタフェース Part 内の getAllHeaders
オーバーライド:
クラス MimeMessage 内の getAllHeaders
戻り値:
ヘッダオブジェクトの配列
例外:
MessagingException
関連項目:
MimeUtility

getMatchingHeaders

public Enumeration getMatchingHeaders(String[] names)
                               throws MessagingException
この Message から一致するヘッダを Header オブジェクトの Enumeration として返します。

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

getNonMatchingHeaders

public Enumeration getNonMatchingHeaders(String[] names)
                                  throws MessagingException
この Message から一致しないヘッダを Header オブジェクトの Enumeration として返します。

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

addHeaderLine

public void addHeaderLine(String line)
                   throws MessagingException
生の RFC822 ヘッダ行を追加します。 POP3 メッセージは読込み専用なので IllegalWriteException をスローします。

定義:
インタフェース MimePart 内の addHeaderLine
オーバーライド:
クラス MimeMessage 内の addHeaderLine
例外:
IllegalWriteException - 実装が変更をサポートしない場合
IllegalStateException - このメッセージが READ_ONLY フォルダから取得された場合
MessagingException

getAllHeaderLines

public Enumeration getAllHeaderLines()
                              throws MessagingException
全てのヘッダ行を String の Enumeration として取得します。 Header 行は生の RFC 822 ヘッダ行であり、"name" 及び "value" の両フィールドを含みます。

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

getMatchingHeaderLines

public Enumeration getMatchingHeaderLines(String[] names)
                                   throws MessagingException
一致するヘッダ行を String の Enumeration として取得します。 Header 行は生の RFC 822 ヘッダ行であり、"name" 及び "value" の両フィールドを含みます。

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

getNonMatchingHeaderLines

public Enumeration getNonMatchingHeaderLines(String[] names)
                                      throws MessagingException
一致しないヘッダ行を String の Enumeration として取得します。 Header 行は生の RFC 822 ヘッダ行であり、"name" 及び "value" の両フィールドを含みます。

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

saveChanges

public void saveChanges()
                 throws MessagingException
POP3 メッセージは変更できません。 このメソッドは IllegalWriteException をスローします。

オーバーライド:
クラス MimeMessage 内の saveChanges
例外:
IllegalWriteException - 実装が変更をサポートしない場合
MessagingException