net.iotgw.mail.pop3

类 POP3Message

java.lang.Object

javax.mail.Message

javax.mail.internet.MimeMessage

net.iotgw.mail.pop3.POP3Message

所有已实现的接口:

MimePart, Part, ReadableMime

public class POP3Message
extends MimeMessage
implements ReadableMime

A POP3 Message. Just like a MimeMessage except that some things are not supported.

作者:

Bill Shannon

嵌套类概要

从类继承的嵌套类/接口 javax.mail.internet.MimeMessage

MimeMessage.RecipientType

字段概要

从类继承的字段 javax.mail.internet.MimeMessage

cachedContent, 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) Add this value to the existing values for this header_name.
void	addHeaderLine(String line) Add a raw RFC822 header-line.
Enumeration<String>	getAllHeaderLines() Get all header lines as an Enumeration of Strings.
Enumeration<Header>	getAllHeaders() Return all the headers from this Message as an enumeration of Header objects.
protected InputStream	getContentStream() Produce the raw bytes of the content.
String[]	getHeader(String name) Get all the headers for this header_name.
String	getHeader(String name, String delimiter) Get all the headers for this header name, returned as a single String, with headers separated by the delimiter.
Enumeration<String>	getMatchingHeaderLines(String[] names) Get matching header lines as an Enumeration of Strings.
Enumeration<Header>	getMatchingHeaders(String[] names) Return matching headers from this Message as an Enumeration of Header objects.
InputStream	getMimeStream() Return the MIME format stream corresponding to this message part.
Enumeration<String>	getNonMatchingHeaderLines(String[] names) Get non-matching header lines as an Enumeration of Strings.
Enumeration<Header>	getNonMatchingHeaders(String[] names) Return non-matching headers from this Message as an Enumeration of Header objects.
Date	getReceivedDate() Returns the Date on this message was received.
int	getSize() Return the size of the content of this message in bytes.
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) Remove all headers with this name.
void	saveChanges() POP3 message can't be changed.
void	setFlags(Flags newFlags, boolean set) Set the specified flags on this message to the specified value.
void	setHeader(String name, String value) Set the value for this header_name.
InputStream	top(int n) Fetch the header of the message and the first n lines of the raw content of the message.
void	writeTo(OutputStream os, String[] ignoreList) Output the message as an RFC 822 format stream, without specified headers.

从类继承的方法 javax.mail.internet.MimeMessage

addFrom, addRecipients, addRecipients, createInternetHeaders, createMimeMessage, getAllRecipients, getContent, getContentID, getContentLanguage, getContentMD5, getContentType, getDataHandler, getDescription, getDisposition, getEncoding, getFileName, getFlags, getFrom, getInputStream, getLineCount, getMessageID, getRawInputStream, getRecipients, getReplyTo, getSender, getSentDate, getSubject, isMimeType, isSet, parse, reply, reply, setContent, setContent, setContentID, setContentLanguage, setContentMD5, setDataHandler, setDescription, setDescription, setDisposition, setFileName, setFrom, setFrom, setFrom, setRecipients, setRecipients, setReplyTo, setSender, setSentDate, setSubject, setSubject, setText, setText, setText, updateHeaders, updateMessageID, writeTo

从类继承的方法 javax.mail.Message

addRecipient, getFolder, getMessageNumber, getSession, 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)
            throws MessagingException

抛出:

MessagingException

方法详细资料

setFlags

public void setFlags(Flags newFlags,
                     boolean set)
              throws MessagingException

Set the specified flags on this message to the specified value.

覆盖:

setFlags 在类中 MimeMessage

参数:

newFlags - the flags to be set

set - the value to be set

抛出:

IllegalWriteException - if the underlying implementation does not support modification

MessagingException - for other failures

另请参阅:

MessageChangedEvent

getSize

public int getSize()
            throws MessagingException

Return the size of the content of this message in bytes. Returns -1 if the size cannot be determined.

Note that this number may not be an exact measure of the content size and may or may not account for any transfer encoding of the content.

指定者:

getSize 在接口中 Part

覆盖:

getSize 在类中 MimeMessage

返回:

size of content in bytes

抛出:

MessagingException - for failures

getContentStream

protected InputStream getContentStream()
                                throws MessagingException

Produce the raw bytes of the content. The data is fetched using the POP3 RETR command.

覆盖:

getContentStream 在类中 MimeMessage

返回:

an InputStream containing the raw bytes

抛出:

MessagingException - for failures

另请参阅:

MimeMessage.contentStream

getMimeStream

public InputStream getMimeStream()
                          throws MessagingException

Return the MIME format stream corresponding to this message part.

指定者:

getMimeStream 在接口中 ReadableMime

返回:

the MIME format stream

抛出:

MessagingException - for failures

从以下版本开始:

JavaMail 1.4.5

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 - for failures

getHeader

public String[] getHeader(String name)
                   throws MessagingException

Get all the headers for this header_name. Note that certain headers may be encoded as per RFC 2047 if they contain non US-ASCII characters and these should be decoded.

指定者:

getHeader 在接口中 Part

覆盖:

getHeader 在类中 MimeMessage

参数:

name - name of header

返回:

array of headers

抛出:

MessagingException - for failures

另请参阅:

MimeUtility

getReceivedDate

public Date getReceivedDate()
                     throws MessagingException

从类复制的说明: MimeMessage

Returns the Date on this message was received. Returns null if this date cannot be obtained.

Note that RFC 822 does not define a field for the received date. Hence only implementations that can provide this date need return a valid value.

This implementation returns null.

覆盖:

getReceivedDate 在类中 MimeMessage

返回:

the date this message was received

抛出:

MessagingException - for failures

getHeader

public String getHeader(String name,
                        String delimiter)
                 throws MessagingException

Get all the headers for this header name, returned as a single String, with headers separated by the delimiter. If the delimiter is null, only the first header is returned.

指定者:

getHeader 在接口中 MimePart

覆盖:

getHeader 在类中 MimeMessage

参数:

name - the name of this header

delimiter - delimiter between returned headers

返回:

the value fields for all headers with this name

抛出:

MessagingException - for failures

setHeader

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

Set the value for this header_name. Throws IllegalWriteException because POP3 messages are read-only.

指定者:

setHeader 在接口中 Part

覆盖:

setHeader 在类中 MimeMessage

参数:

name - header name

value - header value

抛出:

IllegalWriteException - because the underlying implementation does not support modification

IllegalStateException - if this message is obtained from a READ_ONLY folder.

MessagingException - for other failures

另请参阅:

MimeUtility

addHeader

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

Add this value to the existing values for this header_name. Throws IllegalWriteException because POP3 messages are read-only.

指定者:

addHeader 在接口中 Part

覆盖:

addHeader 在类中 MimeMessage

参数:

name - header name

value - header value

抛出:

IllegalWriteException - because the underlying implementation does not support modification

IllegalStateException - if this message is obtained from a READ_ONLY folder.

MessagingException - for other failures

另请参阅:

MimeUtility

removeHeader

public void removeHeader(String name)
                  throws MessagingException

Remove all headers with this name. Throws IllegalWriteException because POP3 messages are read-only.

指定者:

removeHeader 在接口中 Part

覆盖:

removeHeader 在类中 MimeMessage

参数:

name - the name of this header

抛出:

IllegalWriteException - because the underlying implementation does not support modification

IllegalStateException - if this message is obtained from a READ_ONLY folder.

MessagingException - for other failures

getAllHeaders

public Enumeration<Header> getAllHeaders()
                                  throws MessagingException

Return all the headers from this Message as an enumeration of Header objects.

Note that certain headers may be encoded as per RFC 2047 if they contain non US-ASCII characters and these should be decoded.

指定者:

getAllHeaders 在接口中 Part

覆盖:

getAllHeaders 在类中 MimeMessage

返回:

array of header objects

抛出:

MessagingException - for failures

另请参阅:

MimeUtility

getMatchingHeaders

public Enumeration<Header> getMatchingHeaders(String[] names)
                                       throws MessagingException

Return matching headers from this Message as an Enumeration of Header objects.

指定者:

getMatchingHeaders 在接口中 Part

覆盖:

getMatchingHeaders 在类中 MimeMessage

参数:

names - the headers to match

返回:

enumeration of Header objects

抛出:

MessagingException - for failures

getNonMatchingHeaders

public Enumeration<Header> getNonMatchingHeaders(String[] names)
                                          throws MessagingException

Return non-matching headers from this Message as an Enumeration of Header objects.

指定者:

getNonMatchingHeaders 在接口中 Part

覆盖:

getNonMatchingHeaders 在类中 MimeMessage

参数:

names - the headers to not match

返回:

enumeration of Header objects

抛出:

MessagingException - for failures

addHeaderLine

public void addHeaderLine(String line)
                   throws MessagingException

Add a raw RFC822 header-line. Throws IllegalWriteException because POP3 messages are read-only.

指定者:

addHeaderLine 在接口中 MimePart

覆盖:

addHeaderLine 在类中 MimeMessage

参数:

line - the line to add

抛出:

IllegalWriteException - because the underlying implementation does not support modification

IllegalStateException - if this message is obtained from a READ_ONLY folder.

MessagingException - for other failures

getAllHeaderLines

public Enumeration<String> getAllHeaderLines()
                                      throws MessagingException

Get all header lines as an Enumeration of Strings. A Header line is a raw RFC822 header-line, containing both the "name" and "value" field.

指定者:

getAllHeaderLines 在接口中 MimePart

覆盖:

getAllHeaderLines 在类中 MimeMessage

返回:

an Enumeration of Strings

抛出:

MessagingException - for failures

getMatchingHeaderLines

public Enumeration<String> getMatchingHeaderLines(String[] names)
                                           throws MessagingException

Get matching header lines as an Enumeration of Strings. A Header line is a raw RFC822 header-line, containing both the "name" and "value" field.

指定者:

getMatchingHeaderLines 在接口中 MimePart

覆盖:

getMatchingHeaderLines 在类中 MimeMessage

参数:

names - the headers to return

返回:

an Enumeration of Strings

抛出:

MessagingException - for failures

getNonMatchingHeaderLines

public Enumeration<String> getNonMatchingHeaderLines(String[] names)
                                              throws MessagingException

Get non-matching header lines as an Enumeration of Strings. A Header line is a raw RFC822 header-line, containing both the "name" and "value" field.

指定者:

getNonMatchingHeaderLines 在接口中 MimePart

覆盖:

getNonMatchingHeaderLines 在类中 MimeMessage

参数:

names - the headers to not return

返回:

an Enumeration of Strings

抛出:

MessagingException - for failures

saveChanges

public void saveChanges()
                 throws MessagingException

POP3 message can't be changed. This method throws IllegalWriteException.

覆盖:

saveChanges 在类中 MimeMessage

抛出:

IllegalWriteException - because the underlying implementation does not support modification

MessagingException - for other failures

writeTo

public void writeTo(OutputStream os,
                    String[] ignoreList)
             throws IOException,
                    MessagingException

Output the message as an RFC 822 format stream, without specified headers. If the property "mail.pop3.cachewriteto" is set to "true", and ignoreList is null, and the message hasn't already been cached as a side effect of other operations, the message content is cached before being written. Otherwise, the message is streamed directly to the output stream without being cached.

覆盖:

writeTo 在类中 MimeMessage

参数:

os - the stream to write to

ignoreList - the headers to not include in the output

抛出:

IOException - if an error occurs writing to the stream or if an error is generated by the javax.activation layer.

MessagingException - for other failures

另请参阅:

DataHandler.writeTo(java.io.OutputStream)