|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Objectjavax.mail.Message
javax.mail.internet.MimeMessage
com.sun.mail.imap.IMAPMessage
public class IMAPMessage
このクラスはIMAPMessageオブジェクトを実装します。
An IMAPMessage object starts out as a light-weight object. It gets filled-in incrementally when a request is made for some item. Or when a prefetch is done using the FetchProfile.
An IMAPMessage has a messageNumber and a sequenceNumber. The messageNumber is its index into its containing folder's messageCache. The sequenceNumber is its IMAP sequence-number.
入れ子のクラスの概要 |
---|
クラス javax.mail.internet.MimeMessage から継承された入れ子のクラス/インタフェース |
---|
MimeMessage.RecipientType |
フィールドの概要 | |
---|---|
protected com.sun.mail.imap.protocol.BODYSTRUCTURE |
bs
|
protected com.sun.mail.imap.protocol.ENVELOPE |
envelope
|
protected String |
sectionId
|
クラス javax.mail.internet.MimeMessage から継承されたフィールド |
---|
content, contentStream, dh, flags, headers, modified, saved |
クラス javax.mail.Message から継承されたフィールド |
---|
expunged, folder, msgnum, session |
インタフェース javax.mail.Part から継承されたフィールド |
---|
ATTACHMENT, INLINE |
コンストラクタの概要 | |
---|---|
protected |
IMAPMessage(IMAPFolder folder,
int msgnum,
int seqnum)
コンストラクタです。 |
protected |
IMAPMessage(Session session)
IMAPNestedMessage で使用されるコンストラクタです。 |
メソッドの概要 | |
---|---|
void |
addFrom(Address[] addresses)
指定されたアドレスを既存の "From" フィールドに追加します。 |
void |
addHeader(String name,
String value)
この値をこの header_name の既存値に追加します。 |
void |
addHeaderLine(String line)
生 RFC 822 ヘッダ行を追加します。 |
void |
addRecipients(Message.RecipientType type,
Address[] addresses)
指定されたアドレスを指定された受信者タイプに追加します。 |
protected void |
checkExpunged()
|
protected void |
forceCheckExpunged()
Do a NOOP to force any untagged EXPUNGE responses and then check if this message is expunged. |
Enumeration |
getAllHeaderLines()
Get all header-lines. |
Enumeration |
getAllHeaders()
全てのヘッダを取得します。 |
String |
getContentID()
Content-ID を取得します。 |
String[] |
getContentLangauge()
|
String |
getContentMD5()
Content-MD5 を取得します。 |
protected InputStream |
getContentStream()
Get all the bytes for this message. |
String |
getContentType()
Content-Type を取得します。 |
DataHandler |
getDataHandler()
このメッセージの DataHandler オブジェクトを取得します。 |
String |
getDescription()
デコードされた Content-Description を取得します。 |
String |
getDisposition()
Content-Disposition を取得します。 |
String |
getEncoding()
Content-Transfer-Encoding を取得します。 |
protected int |
getFetchBlockSize()
|
String |
getFileName()
"filename" ディスポジション パラメータを取得します。 |
Flags |
getFlags()
このメッセージの Flags を取得します。 |
Address[] |
getFrom()
"From" 属性を取得します。 |
String[] |
getHeader(String name)
指定された名前のヘッダを取得します。 |
String |
getHeader(String name,
String delimiter)
指定された名前のヘッダを取得します。 |
String |
getInReplyTo()
|
int |
getLineCount()
Get the total number of lines. |
Enumeration |
getMatchingHeaderLines(String[] names)
Get all matching header-lines. |
Enumeration |
getMatchingHeaders(String[] names)
一致するヘッダを取得します。 |
protected Object |
getMessageCacheLock()
Get the messageCacheLock, associated with this Message's Folder. |
String |
getMessageID()
Message-ID を取得します。 |
Enumeration |
getNonMatchingHeaderLines(String[] names)
Get all non-matching headerlines. |
Enumeration |
getNonMatchingHeaders(String[] names)
一致しないヘッダを取得します。 |
boolean |
getPeek()
|
protected com.sun.mail.imap.protocol.IMAPProtocol |
getProtocol()
このメッセージのフォルダのプロトコル接続を取得します。 |
Date |
getReceivedDate()
受信日時 (INTERNALDATE) を取得します。 |
Address[] |
getRecipients(Message.RecipientType type)
Get the desired Recipient type. |
Address[] |
getReplyTo()
ReplyTo アドレスを取得します。 |
Address |
getSender()
Returns the value of the RFC 822 "Sender" header field. |
Date |
getSentDate()
送信日時を取得します。 |
protected int |
getSequenceNumber()
Get this message's IMAP sequence number. |
int |
getSize()
メッセージサイズを取得します。 |
String |
getSubject()
デコードされた件名を取得します。 |
protected long |
getUID()
|
void |
invalidateHeaders()
|
boolean |
isSet(Flags.Flag flag)
Test if the given Flags are set in this message. |
void |
removeHeader(String name)
この名前を持つ全てのヘッダを削除します。 |
void |
setContentID(String cid)
このメッセージの "Content-ID" ヘッダフィールドを設定します。 |
void |
setContentLanguage(String[] as)
この MimePart の "Content-Language" ヘッダを設定します。 |
void |
setContentMD5(String md5)
このメッセージの "Content-MD5" ヘッダフィールドを設定します。 |
void |
setDataHandler(DataHandler content)
このメソッドはこのパートの内容を設定するための仕組みを提供します。 |
void |
setDescription(String description,
String charset)
このメッセージの "Content-Description" ヘッダフィールドを設定します。 |
void |
setDisposition(String disposition)
このメッセージの "Content-Disposition" ヘッダフィールドを設定します。 |
protected void |
setExpunged(boolean set)
この Message の消去済みフラグを設定します。 |
void |
setFileName(String filename)
可能であれば、この部分に関連付けられたファイル名を設定します。 |
void |
setFlags(Flags flag,
boolean set)
Set/Unset the given flags in this message. |
void |
setFrom(Address address)
RFC 822 "From" ヘッダフィールドを設定します。 |
void |
setHeader(String name,
String value)
この header_name の値を設定します。 |
protected void |
setMessageNumber(int msgnum)
Wrapper around the protected method Message.setMessageNumber() to make that method accessible to IMAPFolder. |
void |
setPeek(boolean flag)
|
void |
setRecipients(Message.RecipientType type,
Address[] addresses)
指定された受信者のタイプを指定されたアドレスに設定します。 |
void |
setReplyTo(Address[] addresses)
RFC 822 "Reply-To" ヘッダフィールドを設定します。 |
void |
setSender(Address address)
Set the RFC 822 "Sender" header field. |
void |
setSentDate(Date d)
RFC 822 "Date" ヘッダフィールドを設定します。 |
protected void |
setSequenceNumber(int seqnum)
Set this message's IMAP sequence number. |
void |
setSubject(String subject,
String charset)
"Subject" ヘッダフィールドを設定します。 |
protected void |
setUID(long uid)
|
void |
writeTo(OutputStream os)
Write out the bytes into the given outputstream. |
クラス javax.mail.internet.MimeMessage から継承されたメソッド |
---|
addRecipients, createInternetHeaders, createMimeMessage, getAllRecipients, getContent, getContentLanguage, getInputStream, getRawInputStream, isMimeType, parse, reply, saveChanges, setContent, setContent, setDescription, setFrom, setRecipients, setSubject, setText, setText, setText, updateHeaders, updateMessageID, writeTo |
クラス javax.mail.Message から継承されたメソッド |
---|
addRecipient, getFolder, getMessageNumber, isExpunged, match, setFlag, setRecipient |
クラス java.lang.Object から継承されたメソッド |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
フィールドの詳細 |
---|
protected com.sun.mail.imap.protocol.BODYSTRUCTURE bs
protected com.sun.mail.imap.protocol.ENVELOPE envelope
protected String sectionId
コンストラクタの詳細 |
---|
protected IMAPMessage(IMAPFolder folder, int msgnum, int seqnum)
protected IMAPMessage(Session session)
メソッドの詳細 |
---|
protected com.sun.mail.imap.protocol.IMAPProtocol getProtocol() throws FolderClosedException
FolderClosedException
protected Object getMessageCacheLock()
protected int getSequenceNumber()
protected final void setSequenceNumber(int seqnum)
protected final void setMessageNumber(int msgnum)
Message
内の setMessageNumber
protected final long getUID()
protected final void setUID(long uid)
protected final void setExpunged(boolean set)
Message
の記述:
Message
内の setExpunged
set
- 消去済みフラグprotected void checkExpunged() throws MessageRemovedException
MessageRemovedException
protected final void forceCheckExpunged() throws MessageRemovedException, FolderClosedException
MessageRemovedException
FolderClosedException
protected int getFetchBlockSize()
public final Address[] getFrom() throws MessagingException
MimeMessage
内の getFrom
MessagingException
MimeMessage.headers
public final void setFrom(Address address) throws MessagingException
MimeMessage
の記述: null
の場合は、このヘッダが削除されます。
MimeMessage
内の setFrom
address
- このメッセージの送信者
MessagingException
IllegalWriteException
- 実装が既存値の変更をサポートしない場合public final void addFrom(Address[] addresses) throws MessagingException
MimeMessage
の記述:
MimeMessage
内の addFrom
addresses
- このメッセージの送信者
IllegalWriteException
- 実装が既存値の変更をサポートしない場合
MessagingException
public Address getSender() throws MessagingException
MimeMessage
の記述: null
is returned.
This implementation uses the getHeader
method
to obtain the requisite header field.
MimeMessage
内の getSender
MessagingException
MimeMessage.headers
public void setSender(Address address) throws MessagingException
MimeMessage
の記述: null
,
this header is removed.
MimeMessage
内の setSender
address
- the sender of this message
MessagingException
public final Address[] getRecipients(Message.RecipientType type) throws MessagingException
MimeMessage
内の getRecipients
type
- 受信者の型
MessagingException
- ヘッダが取得できない場合
AddressException
- ヘッダの形式に誤りがある場合MimeMessage.headers
,
Message.RecipientType.TO
,
Message.RecipientType.CC
,
Message.RecipientType.BCC
,
MimeMessage.RecipientType.NEWSGROUPS
public final void setRecipients(Message.RecipientType type, Address[] addresses) throws MessagingException
MimeMessage
の記述: null
の場合は、対応する受信者フィールドが削除されます。
MimeMessage
内の setRecipients
type
- 受信者タイプaddresses
- アドレス
MessagingException
IllegalWriteException
- 実装が既存値の変更をサポートしない場合MimeMessage.getRecipients(javax.mail.Message.RecipientType)
public final void addRecipients(Message.RecipientType type, Address[] addresses) throws MessagingException
MimeMessage
の記述:
MimeMessage
内の addRecipients
type
- 受信者タイプaddresses
- アドレス
MessagingException
IllegalWriteException
- 実装が既存値の変更をサポートしない場合public final Address[] getReplyTo() throws MessagingException
MimeMessage
内の getReplyTo
MessagingException
MimeMessage.headers
public final void setReplyTo(Address[] addresses) throws MessagingException
MimeMessage
の記述: null
の場合は、このヘッダが削除されます。
MimeMessage
内の setReplyTo
addresses
- 返信の送信先のアドレス
MessagingException
IllegalWriteException
- 実装が既存値の変更をサポートしない場合
MethodNotSupportedException
- 実装がこの属性の設定をサポートしない場合public final String getSubject() throws MessagingException
MimeMessage
内の getSubject
MessagingException
MimeMessage.headers
public final void setSubject(String subject, String charset) throws MessagingException
MimeMessage
の記述: 文字セットエンコーディング処理が失敗する場合、MessagingException がスローされ、 UnsupportedEncodingException が MessagingException 内の入れ子にされた例外のチェーンに含まれることに注意して下さい。
MimeMessage
内の setSubject
subject
- 件名charset
- 文字セット
MessagingException
- 文字セット変換が失敗すると、UnsupportedEncodingException が例外チェーンに含まれる場合がありますpublic final Date getSentDate() throws MessagingException
MimeMessage
内の getSentDate
MessagingException
public final void setSentDate(Date d) throws MessagingException
MimeMessage
の記述: null
の場合は既存の "Date" フィールドが削除されます。
MimeMessage
内の setSentDate
d
- このメッセージの送信日付
MessagingException
IllegalWriteException
- 実装が既存値の変更をサポートしない場合public final Date getReceivedDate() throws MessagingException
MimeMessage
内の getReceivedDate
MessagingException
public int getSize() throws MessagingException
Note that this returns RFC822.SIZE. That is, it's the size of the whole message, header and body included.
Part
内の getSize
MimeMessage
内の getSize
MessagingException
public final int getLineCount() throws MessagingException
Returns the "body_fld_lines" field from the BODYSTRUCTURE. Note that this field is available only for text/plain and message/rfc822 types
Part
内の getLineCount
MimeMessage
内の getLineCount
MessagingException
public String[] getContentLangauge() throws MessagingException
MessagingException
public void setContentLanguage(String[] as) throws MessagingException
MimeMessage
の記述:
MimePart
内の setContentLanguage
MimeMessage
内の setContentLanguage
as
- 言語タグの配列
MessagingException
public String getInReplyTo() throws MessagingException
MessagingException
public final String getContentType() throws MessagingException
Part
内の getContentType
MimeMessage
内の getContentType
MessagingException
DataHandler
public final String getDisposition() throws MessagingException
Part
内の getDisposition
MimeMessage
内の getDisposition
MessagingException
Part.ATTACHMENT
,
Part.INLINE
,
Part.getFileName()
public void setDisposition(String disposition) throws MessagingException
MimeMessage
の記述: disposition
が null の場合は、
既存の全ての "Content-Disposition" ヘッダフィールドが削除されます。
Part
内の setDisposition
MimeMessage
内の setDisposition
disposition
- この Part の処置
MessagingException
IllegalWriteException
- 実装がこのヘッダの変更をサポートしない場合Part.ATTACHMENT
,
Part.INLINE
,
Part.setFileName(java.lang.String)
public final String getEncoding() throws MessagingException
MimePart
内の getEncoding
MimeMessage
内の getEncoding
MessagingException
public final String getContentID() throws MessagingException
MimePart
内の getContentID
MimeMessage
内の getContentID
MessagingException
public final void setContentID(String cid) throws MessagingException
MimeMessage
の記述: cid
パラメータが null の場合は、
既存の全ての "Content-ID" が削除されます。
MimeMessage
内の setContentID
MessagingException
public final String getContentMD5() throws MessagingException
MimePart
内の getContentMD5
MimeMessage
内の getContentMD5
MessagingException
public final void setContentMD5(String md5) throws MessagingException
MimeMessage
の記述:
MimePart
内の setContentMD5
MimeMessage
内の setContentMD5
md5
- コンテンツ ID
MessagingException
public final String getDescription() throws MessagingException
Part
内の getDescription
MimeMessage
内の getDescription
MessagingException
public final void setDescription(String description, String charset) throws MessagingException
MimeMessage
の記述: null
の場合は、
既存の全ての "Content-Description" フィールドが削除されます。description に US-ASCII 以外の文字が含まれる場合は、 指定された文字セットを使用してエンコードされます。 description に US-ASCII 文字だけが含まれる場合は、 エンコーディングは行われず、そのまま使用されます。
文字セットエンコーディング処理が失敗する場合、 MessagingException がスローされ、 UnsupportedEncodingException が MessagingException 内の入れ子にされた例外のチェーンに含まれることに注意して下さい。
MimeMessage
内の setDescription
description
- Descriptioncharset
- キャラクタエンコーディング
MessagingException
- 文字セット変換が失敗すると、UnsupportedEncodingException が例外チェーンに含まれる場合がありますpublic final String getMessageID() throws MessagingException
MimeMessage
内の getMessageID
MessagingException
- このフィールドの取得により例外が発生する場合MessageIDTerm
public final String getFileName() throws MessagingException
Part
内の getFileName
MimeMessage
内の getFileName
MessagingException
- このフィールドの取得により例外が発生する場合public final void setFileName(String filename) throws MessagingException
MimeMessage
の記述: このメッセージの "Content-Disposition" ヘッダフィールドにおける "filename" パラメータを設定します。
Part
内の setFileName
MimeMessage
内の setFileName
filename
- この Part に関連付けるファイル名
IllegalWriteException
- 実装がこのヘッダの変更をサポートしない場合
MessagingException
protected final InputStream getContentStream() throws MessagingException
MimeMessage
内の getContentStream
MessagingException
MimeMessage.getContentStream()
public DataHandler getDataHandler() throws MessagingException
Part
内の getDataHandler
MimeMessage
内の getDataHandler
MessagingException
public final void setDataHandler(DataHandler content) throws MessagingException
MimeMessage
の記述:
Part
内の setDataHandler
MimeMessage
内の setDataHandler
content
- コンテンツの DataHandler
MessagingException
IllegalWriteException
- 実装がこのヘッダの変更をサポートしない場合public final void writeTo(OutputStream os) throws IOException, MessagingException
Part
内の writeTo
MimeMessage
内の writeTo
IOException
- ストリームへの書き込み中にエラーが発生する場合、
又は javax.activation レイヤによりエラーが生成される場合
MessagingException
- 書き込まれるデータを取り出す時にエラーが発生した場合DataHandler
public final String[] getHeader(String name) throws MessagingException
Part
内の getHeader
MimeMessage
内の getHeader
name
- ヘッダの名前
MessagingException
MimeUtility
public final String getHeader(String name, String delimiter) throws MessagingException
MimePart
内の getHeader
MimeMessage
内の getHeader
name
- このヘッダの名前delimiter
- 区切り文字
MessagingException
public final void setHeader(String name, String value) throws MessagingException
MimeMessage
の記述:
Part
内の setHeader
MimeMessage
内の setHeader
name
- ヘッダ名value
- ヘッダ値
MessagingException
IllegalWriteException
- 実装がこのヘッダの変更をサポートしない場合MimeUtility
public final void addHeader(String name, String value) throws MessagingException
MimeMessage
の記述:
Part
内の addHeader
MimeMessage
内の addHeader
name
- ヘッダ名value
- ヘッダ値
MessagingException
IllegalWriteException
- 実装がこのヘッダの変更をサポートしない場合MimeUtility
public final void removeHeader(String name) throws MessagingException
MimeMessage
の記述:
Part
内の removeHeader
MimeMessage
内の removeHeader
name
- このヘッダの名前
MessagingException
IllegalWriteException
- 実装がこのヘッダの変更をサポートしない場合public final Enumeration getAllHeaders() throws MessagingException
Part
内の getAllHeaders
MimeMessage
内の getAllHeaders
MessagingException
MimeUtility
public final Enumeration getMatchingHeaders(String[] names) throws MessagingException
Part
内の getMatchingHeaders
MimeMessage
内の getMatchingHeaders
MessagingException
public final Enumeration getNonMatchingHeaders(String[] names) throws MessagingException
Part
内の getNonMatchingHeaders
MimeMessage
内の getNonMatchingHeaders
MessagingException
public final void addHeaderLine(String line) throws MessagingException
MimeMessage
の記述:
MimePart
内の addHeaderLine
MimeMessage
内の addHeaderLine
MessagingException
public final Enumeration getAllHeaderLines() throws MessagingException
MimePart
内の getAllHeaderLines
MimeMessage
内の getAllHeaderLines
MessagingException
public final Enumeration getMatchingHeaderLines(String[] names) throws MessagingException
MimePart
内の getMatchingHeaderLines
MimeMessage
内の getMatchingHeaderLines
MessagingException
public final Enumeration getNonMatchingHeaderLines(String[] names) throws MessagingException
MimePart
内の getNonMatchingHeaderLines
MimeMessage
内の getNonMatchingHeaderLines
MessagingException
public Flags getFlags() throws MessagingException
MimeMessage
内の getFlags
MessagingException
Flags
public boolean isSet(Flags.Flag flag) throws MessagingException
MimeMessage
内の isSet
flag
- フラグ
MessagingException
Flags.Flag
,
Flags.Flag.ANSWERED
,
Flags.Flag.DELETED
,
Flags.Flag.DRAFT
,
Flags.Flag.FLAGGED
,
Flags.Flag.RECENT
,
Flags.Flag.SEEN
public void setFlags(Flags flag, boolean set) throws MessagingException
MimeMessage
内の setFlags
flag
- 設定されるフラグを含む Flags オブジェクトset
- 設定される値
MessagingException
IllegalWriteException
- 実装が既存値の変更をサポートしない場合MessageChangedEvent
public void setPeek(boolean flag)
public boolean getPeek()
public void invalidateHeaders()
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |