⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
javax.mail.internet

Class InternetHeaders

java.lang.Object
|
+--javax.mail.internet.InternetHeaders


public class InternetHeaders
extends java.lang.Object

InternetHeaders is a utility class that manages RFC822 style headers. Given a rfc822 format message stream, it reads lines till the blank line that indicates end of header. The input stream is positioned at the start of the body. The lines are stored within the object and can be extracted as either Strings or Header objects.

This class is mostly intended for service providers. MimeMessage and MimeBody use this class for holding their headers.


A note on RFC822 and MIME 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.

Author:

Constructor Summary

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.

Method Summary

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.

Enumeration

getAllHeaderLines()

Return all the header lines as an Enumeration of Strings.

Enumeration

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.

Enumeration

getMatchingHeaderLines(String[] names)

Return all matching header lines as an Enumeration of Strings.

Enumeration

getMatchingHeaders(String[] names)

Return all matching Header objects

Enumeration

getNonMatchingHeaderLines(String[] names)

Return all non-matching header lines

Enumeration

getNonMatchingHeaders(String[] names)

Return all non-matching Header objects

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.

Constructor Details

InternetHeaders

public InternetHeaders()

Create an empty InternetHeaders object.


InternetHeaders

public InternetHeaders(InputStream is)

Read and parse the given rfc822 message stream till the blank line separating the header from the body. The input stream is left positioned at the start of the body. The header lines are stored internally.

For efficiency, wrap a BufferedInputStream around the actual input stream and pass it as the parameter.

Parameters:
is - an rfc822 input stream

Method Details

addHeader

public void addHeader(String name, String value)

Add a header with the specified name and value to the header list.

Note that RFC822 headers can only contain US-ASCII characters.

Parameters:
name - the header name
value - the header value

addHeaderLine

public void addHeaderLine(String line)

Add an RFC822 header line to the header store. If the line starts with a space or tab (a continuation line), add it to the last header line in the list.

Note that RFC822 headers can only contain US-ASCII characters

Parameters:
line - raw rfc822 header line

getAllHeaderLines

public Enumeration getAllHeaderLines()

Return all the header lines as an Enumeration of Strings.


getAllHeaders

public Enumeration getAllHeaders()

Return all the headers as an Enumeration of Header objects


getHeader

public String[] getHeader(String name)

Return all the values for the specified header. The values are String objects.

Parameters:
name - the header name

getHeader

public 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. If the delimiter is null, only the first header is returned.

Parameters:
name - the header name
delimiter - the delimiter
Returns:
the value fields for all headers with this name

getMatchingHeaderLines

public Enumeration getMatchingHeaderLines(String[] names)

Return all matching header lines as an Enumeration of Strings.

Parameters:
names

getMatchingHeaders

public Enumeration getMatchingHeaders(String[] names)

Return all matching Header objects

Parameters:
names - the names to match

getNonMatchingHeaderLines

public Enumeration getNonMatchingHeaderLines(String[] names)

Return all non-matching header lines

Parameters:
names

getNonMatchingHeaders

public Enumeration getNonMatchingHeaders(String[] names)

Return all non-matching Header objects

Parameters:
names - the names not to match

load

public void load(InputStream is)

Read and parse the given rfc822 message stream till the blank line separating the header from the body. Store the header lines inside this InternetHeaders object.

Note that the header lines are added into this InternetHeaders object, so any existing headers in this object will not be affected.

Parameters:
is - an rfc822 input stream

removeHeader

public void removeHeader(String name)

Remove all header entries that match the given name

Parameters:
name - header name

setHeader

public 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. Remove all matching headers but the first.

Note that RFC822 headers can only contain US-ASCII characters

Parameters:
name - the header name
value - the header value