Package com.sun.xml.messaging.saaj.packaging.mime.internet

Class InternetHeaders

  • public final class InternetHeaders
extends Object
    InternetHeaders is a utility class that manages RFC822 style headers. Given an RFC822 format message stream, it reads lines until 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:
    John Mani, Bill Shannon
    See Also:
    MimeUtility

    • Constructor Detail

      • InternetHeaders

        public InternetHeaders()
        Create an empty InternetHeaders object.

      • InternetHeaders

        public InternetHeaders​(InputStream is)
                throws MessagingException
        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 - RFC822 input stream
        Throws:
        MessagingException - in case of error

    • Method Detail

      • load

        public void load​(InputStream is)
          throws MessagingException
        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 - RFC822 input stream
        Throws:
        MessagingException - in case of error

      • getHeader

        public String[] getHeader​(String name)
        Return all the values for the specified header. The values are String objects. Returns null if no headers with the specified name exist.
        Parameters:
        name - header name
        Returns:
        array of header values, or null if none

      • 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. Returns null if no headers with the specified name exist.
        Parameters:
        delimiter - delimiter
        name - header name
        Returns:
        the value fields for all headers with this name, or null if none

      • 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 - header name
        value - header value

      • 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 - header name
        value - header value

      • removeHeader

        public void removeHeader​(String name)
        Remove all header entries that match the given name
        Parameters:
        name - header name

      • getAllHeaders

        public FinalArrayList<com.sun.xml.messaging.saaj.packaging.mime.internet.hdr> getAllHeaders()
        Return all the headers as an Enumeration of Header objects.
        Returns:
        Header objects

      • 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 List<String> getAllHeaderLines()
        Return all the header lines as a collection
        Returns:
        list of header lines.