org.apache.james.core

Class MailHeaders

java.lang.Object

javax.mail.internet.InternetHeaders

org.apache.james.core.MailHeaders

All Implemented Interfaces:

Serializable, Cloneable

public class MailHeaders
extends javax.mail.internet.InternetHeaders
implements Serializable, Cloneable

This interface defines a container for mail headers. Each header must use MIME format:

 name: value
 

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.mail.internet.InternetHeaders

javax.mail.internet.InternetHeaders.InternetHeader

Field Summary

Fields inherited from class javax.mail.internet.InternetHeaders

headers

Constructor Summary

Constructors

Constructor and Description
MailHeaders() No argument constructor
MailHeaders(InputStream in) Constructor that takes an InputStream containing the contents of the set of mail headers.

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(String arg0, String arg1) If the new header is a Return-Path we get sure that we add it to the top Javamail, at least until 1.4.0 does the wrong thing if it loaded a stream with a return-path in the middle.
void	addHeaderLine(String line)
long	getSize() Return the size of the headers
boolean	isSet(String name) Check if a particular header is present.
boolean	isValid() Check if all REQUIRED headers fields as specified in RFC 822 are present.
void	removeHeader(String name)
void	setHeader(String arg0, String arg1) If the new header is a Return-Path we get sure that we add it to the top Javamail, at least until 1.4.0 does the wrong thing if it loaded a stream with a return-path in the middle.
byte[]	toByteArray() Generate a representation of the headers as a series of bytes.
void	writeTo(OutputStream out) Write the headers to an output stream

Methods inherited from class javax.mail.internet.InternetHeaders

getAllHeaderLines, getAllHeaders, getHeader, getHeader, getMatchingHeaderLines, getMatchingHeaders, getNonMatchingHeaderLines, getNonMatchingHeaders, load

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MailHeaders

public MailHeaders()
            throws javax.mail.MessagingException

No argument constructor

Throws:

javax.mail.MessagingException - if the super class cannot be properly instantiated

MailHeaders

public MailHeaders(InputStream in)
            throws javax.mail.MessagingException

Constructor that takes an InputStream containing the contents of the set of mail headers.

Parameters:

in - the InputStream containing the header data

Throws:

javax.mail.MessagingException - if the super class cannot be properly instantiated based on the stream

Method Detail

writeTo

public void writeTo(OutputStream out)
             throws javax.mail.MessagingException

Write the headers to an output stream

Parameters:

out - the OutputStream to which to write the headers

Throws:

javax.mail.MessagingException

toByteArray

public byte[] toByteArray()
                   throws javax.mail.MessagingException

Generate a representation of the headers as a series of bytes.

Returns:

the byte array containing the headers

Throws:

javax.mail.MessagingException

isSet

public boolean isSet(String name)

Check if a particular header is present.

Returns:

true if the header is present, false otherwise

addHeader

public void addHeader(String arg0,
             String arg1)

If the new header is a Return-Path we get sure that we add it to the top Javamail, at least until 1.4.0 does the wrong thing if it loaded a stream with a return-path in the middle.

Overrides:

addHeader in class javax.mail.internet.InternetHeaders

See Also:

InternetHeaders.addHeader(java.lang.String, java.lang.String)

setHeader

public void setHeader(String arg0,
             String arg1)

If the new header is a Return-Path we get sure that we add it to the top Javamail, at least until 1.4.0 does the wrong thing if it loaded a stream with a return-path in the middle.

Overrides:

setHeader in class javax.mail.internet.InternetHeaders

See Also:

InternetHeaders.setHeader(java.lang.String, java.lang.String)

removeHeader

public void removeHeader(String name)

Overrides:

removeHeader in class javax.mail.internet.InternetHeaders

addHeaderLine

public void addHeaderLine(String line)

Overrides:

addHeaderLine in class javax.mail.internet.InternetHeaders

isValid

public boolean isValid()

Check if all REQUIRED headers fields as specified in RFC 822 are present.

Returns:

true if the headers are present, false otherwise

getSize

public long getSize()

Return the size of the headers

Returns:

size