public final class InternetHeaders extends 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.
MimeUtility
Constructor and Description |
---|
InternetHeaders()
Create an empty InternetHeaders object.
|
InternetHeaders(InputStream is)
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(String name,
String value)
Add a header with the specified name and value to the header list.
|
void |
addHeaderLine(String line)
Add an RFC822 header line to the header store.
|
List<String> |
getAllHeaderLines()
Return all the header lines as a collection
|
FinalArrayList<com.sun.xml.messaging.saaj.packaging.mime.internet.hdr> |
getAllHeaders()
Return all the headers as an Enumeration of
Header objects. |
String[] |
getHeader(String name)
Return all the values for the specified header.
|
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.
|
void |
load(InputStream is)
Read and parse the given RFC822 message stream till the
blank line separating the header from the body.
|
void |
removeHeader(String name)
Remove all header entries that match the given name
|
void |
setHeader(String name,
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(InputStream is) throws MessagingException
For efficiency, wrap a BufferedInputStream around the actual input stream and pass it as the parameter.
is
- RFC822 input streamMessagingException
- in case of errorpublic void load(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.
is
- RFC822 input streamMessagingException
- in case of errorpublic String[] getHeader(String name)
null
if no headers with the specified name exist.name
- header namepublic String getHeader(String name, String delimiter)
null
, only the first header is
returned. Returns null
if no headers with the specified name exist.delimiter
- delimitername
- header namepublic void setHeader(String name, String value)
Note that RFC822 headers can only contain US-ASCII characters.
name
- header namevalue
- header valuepublic void addHeader(String name, String value)
name
- header namevalue
- header valuepublic void removeHeader(String name)
name
- header namepublic FinalArrayList<com.sun.xml.messaging.saaj.packaging.mime.internet.hdr> getAllHeaders()
Header
objects.public void addHeaderLine(String line)
Note that RFC822 headers can only contain US-ASCII characters
line
- raw RFC822 header lineCopyright © 2020 JBoss by Red Hat. All rights reserved.