public class POP3Message extends MimeMessage implements ReadableMime
MimeMessage.RecipientType
cachedContent, content, contentStream, dh, flags, headers, modified, saved
ATTACHMENT, INLINE
Constructor and Description |
---|
POP3Message(Folder folder,
int msgno) |
Modifier and Type | Method and Description |
---|---|
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.
|
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.
|
addFrom, addRecipients, addRecipients, createInternetHeaders, createMimeMessage, 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, 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
addRecipient, getFolder, getMessageNumber, getSession, isExpunged, match, setExpunged, setFlag, setMessageNumber, setRecipient
public POP3Message(Folder folder, int msgno) throws MessagingException
MessagingException
public void setFlags(Flags newFlags, boolean set) throws MessagingException
setFlags
in class MimeMessage
newFlags
- the flags to be setset
- the value to be setIllegalWriteException
- if the underlying
implementation does not support modificationMessagingException
- for other failuresMessageChangedEvent
public int getSize() throws MessagingException
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
in interface Part
getSize
in class MimeMessage
MessagingException
- for failuresprotected InputStream getContentStream() throws MessagingException
getContentStream
in class MimeMessage
MessagingException
- for failuresMimeMessage.contentStream
public InputStream getMimeStream() throws MessagingException
getMimeStream
in interface ReadableMime
MessagingException
- for failurespublic void invalidate(boolean invalidateHeaders)
invalidateHeaders
is true, invalidate the headers
as well.invalidateHeaders
- invalidate the headers as well?public InputStream top(int n) throws MessagingException
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 fetchMessagingException
- for failurespublic String[] getHeader(String name) throws MessagingException
getHeader
in interface Part
getHeader
in class MimeMessage
name
- name of headerMessagingException
- for failuresMimeUtility
public String getHeader(String name, String delimiter) throws MessagingException
null
, only the first header is
returned.getHeader
in interface MimePart
getHeader
in class MimeMessage
name
- the name of this headerdelimiter
- delimiter between returned headersMessagingException
- for failurespublic void setHeader(String name, String value) throws MessagingException
setHeader
in interface Part
setHeader
in class MimeMessage
name
- header namevalue
- header valueIllegalWriteException
- because the underlying
implementation does not support modificationIllegalStateException
- if this message is
obtained from a READ_ONLY folder.MessagingException
- for other failuresMimeUtility
public void addHeader(String name, String value) throws MessagingException
addHeader
in interface Part
addHeader
in class MimeMessage
name
- header namevalue
- header valueIllegalWriteException
- because the underlying
implementation does not support modificationIllegalStateException
- if this message is
obtained from a READ_ONLY folder.MessagingException
- for other failuresMimeUtility
public void removeHeader(String name) throws MessagingException
removeHeader
in interface Part
removeHeader
in class MimeMessage
name
- the name of this headerIllegalWriteException
- because the underlying
implementation does not support modificationIllegalStateException
- if this message is
obtained from a READ_ONLY folder.MessagingException
- for other failurespublic Enumeration<Header> getAllHeaders() throws MessagingException
Note that certain headers may be encoded as per RFC 2047 if they contain non US-ASCII characters and these should be decoded.
getAllHeaders
in interface Part
getAllHeaders
in class MimeMessage
MessagingException
- for failuresMimeUtility
public Enumeration<Header> getMatchingHeaders(String[] names) throws MessagingException
getMatchingHeaders
in interface Part
getMatchingHeaders
in class MimeMessage
names
- the headers to matchMessagingException
- for failurespublic Enumeration<Header> getNonMatchingHeaders(String[] names) throws MessagingException
getNonMatchingHeaders
in interface Part
getNonMatchingHeaders
in class MimeMessage
names
- the headers to not matchMessagingException
- for failurespublic void addHeaderLine(String line) throws MessagingException
addHeaderLine
in interface MimePart
addHeaderLine
in class MimeMessage
line
- the line to addIllegalWriteException
- because the underlying
implementation does not support modificationIllegalStateException
- if this message is
obtained from a READ_ONLY folder.MessagingException
- for other failurespublic Enumeration<String> getAllHeaderLines() throws MessagingException
getAllHeaderLines
in interface MimePart
getAllHeaderLines
in class MimeMessage
MessagingException
- for failurespublic Enumeration<String> getMatchingHeaderLines(String[] names) throws MessagingException
getMatchingHeaderLines
in interface MimePart
getMatchingHeaderLines
in class MimeMessage
names
- the headers to returnMessagingException
- for failurespublic Enumeration<String> getNonMatchingHeaderLines(String[] names) throws MessagingException
getNonMatchingHeaderLines
in interface MimePart
getNonMatchingHeaderLines
in class MimeMessage
names
- the headers to not returnMessagingException
- for failurespublic void saveChanges() throws MessagingException
saveChanges
in class MimeMessage
IllegalWriteException
- because the underlying
implementation does not support modificationMessagingException
- for other failurespublic void writeTo(OutputStream os, String[] ignoreList) throws IOException, MessagingException
writeTo
in class MimeMessage
os
- the stream to write toignoreList
- the headers to not include in the outputIOException
- if an error occurs writing to the stream
or if an error is generated by the
javax.activation layer.MessagingException
- for other failuresDataHandler.writeTo(java.io.OutputStream)
Copyright © 2019 Eclipse Foundation. Use is subject to license terms.