com.libmailcore

Class MessageHeader

java.lang.Object

com.libmailcore.NativeObject

com.libmailcore.MessageHeader

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class MessageHeader
extends NativeObject

Message header.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MessageHeader() Constuctor.
MessageHeader(byte[] headersData) The constructor will parse the data encoded using RFC 822 and initializes the content using those data.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	allExtraHeadersNames() Returns all the names of the custom headers.
java.util.List<Address>	bcc() Returns Bcc.
java.util.List<Address>	cc() Returns Cc.
java.util.Date	date() Returns Date.
java.lang.String	extractedSubject() Returns the extracted subject (removing all the Re:, Fwd:, etc).
java.lang.String	extraHeaderValueForName(java.lang.String name) Returns the value of a custom header.
MessageHeader	forwardHeader() Generates a header that could be used as a base for a forwarded message.
Address	from() Return From.
void	importHeadersData(byte[] data) Parsed the given data in RFC 822 format and sets the headers.
java.util.List<java.lang.String>	inReplyTo() Returns In-Reply-To.
boolean	isMessageIDAutoGenerated() Returns whether the Message-ID has been generated.
java.lang.String	messageID() Returns the Message-ID.
java.lang.String	partialExtractedSubject() Returns extracted subject but do not remove brackets.
java.util.Date	receivedDate() Sets the received date (it's not part of the RFC 822 headers).
java.util.List<java.lang.String>	references() Returns the References.
void	removeExtraHeader(java.lang.String name) Remove a custom header.
MessageHeader	replyHeader(boolean replyAll, java.util.List<Address> excludedRecipients) Generates a header that could be used for a reply message.
java.util.List<Address>	replyTo() Returns Reply-To.
Address	sender() Returns Sender.
void	setBcc(java.util.List<Address> bcc) Sets Bcc.
void	setCc(java.util.List<Address> cc) Sets Cc.
void	setDate(java.util.Date date) Sets Date.
void	setExtraHeader(java.lang.String name, java.lang.String value) Sets a custom header value.
void	setFrom(Address from) Sets From.
void	setInReplyTo(java.util.List<java.lang.String> inReplyTo) Sets In-Reply-To.
void	setMessageID(java.lang.String messageID) Sets the Message-ID.
void	setReceivedDate(java.util.Date date) Returns the received date (it's not part of the RFC 822 headers).
void	setReferences(java.util.List<java.lang.String> references) Sets the References.
void	setReplyTo(java.util.List<Address> replyTo) Sets Reply-To.
void	setSender(Address sender) Set Sender.
void	setSubject(java.lang.String subject) Sets Subject.
void	setTo(java.util.List<Address> to) Sets To.
void	setUserAgent(java.lang.String userAgent) Sets X-Mailer.
java.lang.String	subject() Returns Subject.
java.util.List<Address>	to() Returns To.
java.lang.String	userAgent() Returns X-Mailer.

Methods inherited from class com.libmailcore.NativeObject

clone, finalize, initWithNative, readObject, toString, writeObject

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageHeader

public MessageHeader()

Constuctor.

MessageHeader

public MessageHeader(byte[] headersData)

The constructor will parse the data encoded using RFC 822 and initializes the content using those data.

Method Detail

messageID

public java.lang.String messageID()

Returns the Message-ID.

setMessageID

public void setMessageID(java.lang.String messageID)

Sets the Message-ID.

isMessageIDAutoGenerated

public boolean isMessageIDAutoGenerated()

Returns whether the Message-ID has been generated.

references

public java.util.List<java.lang.String> references()

Returns the References.

setReferences

public void setReferences(java.util.List<java.lang.String> references)

Sets the References.

inReplyTo

public java.util.List<java.lang.String> inReplyTo()

Returns In-Reply-To.

setInReplyTo

public void setInReplyTo(java.util.List<java.lang.String> inReplyTo)

Sets In-Reply-To.

date

public java.util.Date date()

Returns Date.

setDate

public void setDate(java.util.Date date)

Sets Date.

receivedDate

public java.util.Date receivedDate()

Sets the received date (it's not part of the RFC 822 headers).

setReceivedDate

public void setReceivedDate(java.util.Date date)

Returns the received date (it's not part of the RFC 822 headers).

sender

public Address sender()

Returns Sender.

setSender

public void setSender(Address sender)

Set Sender.

from

public Address from()

Return From.

setFrom

public void setFrom(Address from)

Sets From.

to

public java.util.List<Address> to()

Returns To.

setTo

public void setTo(java.util.List<Address> to)

Sets To.

cc

public java.util.List<Address> cc()

Returns Cc.

setCc

public void setCc(java.util.List<Address> cc)

Sets Cc.

bcc

public java.util.List<Address> bcc()

Returns Bcc.

setBcc

public void setBcc(java.util.List<Address> bcc)

Sets Bcc.

replyTo

public java.util.List<Address> replyTo()

Returns Reply-To.

setReplyTo

public void setReplyTo(java.util.List<Address> replyTo)

Sets Reply-To.

subject

public java.lang.String subject()

Returns Subject.

setSubject

public void setSubject(java.lang.String subject)

Sets Subject.

userAgent

public java.lang.String userAgent()

Returns X-Mailer.

setUserAgent

public void setUserAgent(java.lang.String userAgent)

Sets X-Mailer.

setExtraHeader

public void setExtraHeader(java.lang.String name,
                           java.lang.String value)

Sets a custom header value.

removeExtraHeader

public void removeExtraHeader(java.lang.String name)

Remove a custom header.

extraHeaderValueForName

public java.lang.String extraHeaderValueForName(java.lang.String name)

Returns the value of a custom header.

allExtraHeadersNames

public java.util.List<java.lang.String> allExtraHeadersNames()

Returns all the names of the custom headers.

extractedSubject

public java.lang.String extractedSubject()

Returns the extracted subject (removing all the Re:, Fwd:, etc). Also removes brackets.

partialExtractedSubject

public java.lang.String partialExtractedSubject()

Returns extracted subject but do not remove brackets.

importHeadersData

public void importHeadersData(byte[] data)

Parsed the given data in RFC 822 format and sets the headers.

replyHeader

public MessageHeader replyHeader(boolean replyAll,
                                 java.util.List<Address> excludedRecipients)

Generates a header that could be used for a reply message.

forwardHeader

public MessageHeader forwardHeader()

Generates a header that could be used as a base for a forwarded message.