public class InternetHeaders
extends java.lang.Object
Header
objects. This class is mostly intended for service providers. MimeMessage and MimeBody use this class for holding their headers.
RFC822 and MIME header fields must contain only
US-ASCII characters. If a header contains non US-ASCII characters,
it must be encoded as per the rules in RFC 2047. The MimeUtility
class provided in this package can be used to to achieve this.
Callers of the setHeader
, addHeader
, and
addHeaderLine
methods are responsible for enforcing
the MIME requirements for the specified headers. In addition, these
header fields must be folded (wrapped) before being sent if they
exceed the line length limitation for the transport (1000 bytes for
SMTP). Received headers may have been folded. The application is
responsible for folding and unfolding headers as appropriate.
The current implementation supports the System property
mail.mime.ignorewhitespacelines
, which if set to true
will cause a line containing only whitespace to be considered
a blank line terminating the header.
MimeUtility
Constructor and Description |
---|
InternetHeaders()
Create an empty InternetHeaders object.
|
InternetHeaders(java.io.InputStream is)
Read and parse the given RFC822 message stream till the
blank line separating the header from the body.
|
InternetHeaders(java.io.InputStream is,
boolean allowutf8)
Read and parse the given RFC822 message stream till the
blank line separating the header from the body.
|
Modifier and Type | Method and Description |
---|---|
void |
addHeader(java.lang.String name,
java.lang.String value)
Add a header with the specified name and value to the header list.
|
void |
addHeaderLine(java.lang.String line)
Add an RFC822 header line to the header store.
|
java.util.Enumeration<java.lang.String> |
getAllHeaderLines()
Return all the header lines as an Enumeration of Strings.
|
java.util.Enumeration<Header> |
getAllHeaders()
Return all the headers as an Enumeration of
Header objects. |
java.lang.String[] |
getHeader(java.lang.String name)
Return all the values for the specified header.
|
java.lang.String |
getHeader(java.lang.String name,
java.lang.String delimiter)
Get all the headers for this header name, returned as a single
String, with headers separated by the delimiter.
|
java.util.Enumeration<java.lang.String> |
getMatchingHeaderLines(java.lang.String[] names)
Return all matching header lines as an Enumeration of Strings.
|
java.util.Enumeration<Header> |
getMatchingHeaders(java.lang.String[] names)
Return all matching
Header objects. |
java.util.Enumeration<java.lang.String> |
getNonMatchingHeaderLines(java.lang.String[] names)
Return all non-matching header lines
|
java.util.Enumeration<Header> |
getNonMatchingHeaders(java.lang.String[] names)
Return all non-matching
Header objects. |
void |
load(java.io.InputStream is)
Read and parse the given RFC822 message stream till the
blank line separating the header from the body.
|
void |
load(java.io.InputStream is,
boolean allowutf8)
Read and parse the given RFC822 message stream till the
blank line separating the header from the body.
|
void |
removeHeader(java.lang.String name)
Remove all header entries that match the given name
|
void |
setHeader(java.lang.String name,
java.lang.String value)
Change the first header line that matches name
to have value, adding a new header if no existing header
matches.
|
public InternetHeaders()
public InternetHeaders(java.io.InputStream is) throws MessagingException
For efficiency, wrap a BufferedInputStream around the actual input stream and pass it as the parameter.
No placeholder entries are inserted; the original order of the headers is preserved.
is
- RFC822 input streamMessagingException
- for any I/O error reading the streampublic InternetHeaders(java.io.InputStream is, boolean allowutf8) throws MessagingException
For efficiency, wrap a BufferedInputStream around the actual input stream and pass it as the parameter.
No placeholder entries are inserted; the original order of the headers is preserved.
is
- RFC822 input streamallowutf8
- if UTF-8 encoded headers are allowedMessagingException
- for any I/O error reading the streampublic void load(java.io.InputStream is) throws MessagingException
Note that the header lines are added into this InternetHeaders object, so any existing headers in this object will not be affected. Headers are added to the end of the existing list of headers, in order.
is
- RFC822 input streamMessagingException
- for any I/O error reading the streampublic void load(java.io.InputStream is, boolean allowutf8) throws MessagingException
Note that the header lines are added into this InternetHeaders object, so any existing headers in this object will not be affected. Headers are added to the end of the existing list of headers, in order.
is
- RFC822 input streamallowutf8
- if UTF-8 encoded headers are allowedMessagingException
- for any I/O error reading the streampublic java.lang.String[] getHeader(java.lang.String name)
null
if no headers with the specified name exist.name
- header namepublic java.lang.String getHeader(java.lang.String name, java.lang.String delimiter)
null
, only the first header is
returned. Returns null
if no headers with the specified name exist.name
- header namedelimiter
- delimiterpublic void setHeader(java.lang.String name, java.lang.String value)
Note that RFC822 headers can only contain US-ASCII characters
name
- header namevalue
- header valuepublic void addHeader(java.lang.String name, java.lang.String value)
The current implementation knows about the preferred order of most
well-known headers and will insert headers in that order. In
addition, it knows that Received
headers should be
inserted in reverse order (newest before oldest), and that they
should appear at the beginning of the headers, preceeded only by
a possible Return-Path
header.
Note that RFC822 headers can only contain US-ASCII characters.
name
- header namevalue
- header valuepublic void removeHeader(java.lang.String name)
name
- header namepublic java.util.Enumeration<Header> getAllHeaders()
Header
objects.public java.util.Enumeration<Header> getMatchingHeaders(java.lang.String[] names)
Header
objects.names
- the headers to returnpublic java.util.Enumeration<Header> getNonMatchingHeaders(java.lang.String[] names)
Header
objects.names
- the headers to not returnpublic void addHeaderLine(java.lang.String line)
Note that RFC822 headers can only contain US-ASCII characters
line
- raw RFC822 header linepublic java.util.Enumeration<java.lang.String> getAllHeaderLines()
public java.util.Enumeration<java.lang.String> getMatchingHeaderLines(java.lang.String[] names)
names
- the headers to returnpublic java.util.Enumeration<java.lang.String> getNonMatchingHeaderLines(java.lang.String[] names)
names
- the headers to not returnCopyright © 2010 - 2020 Adobe. All Rights Reserved