lazyj.mail

Class MailHeader

java.lang.Object

lazyj.mail.Header

lazyj.mail.MailHeader

All Implemented Interfaces:

java.lang.Comparable<MailHeader>

Direct Known Subclasses:

Mail

public class MailHeader
extends Header
implements java.lang.Comparable<MailHeader>

Wrapper for the global mail headers that extracts typical fields into the class fields.

Since:

2006-10-06

Author:

costing

Field Summary

Fields

Modifier and Type	Field and Description
boolean	bConfirmation If this is a read confirmation of a previously sent mail.
boolean	bEstimatedHasAttachments This only an assumption about the attachment status.
boolean	bOld True if this mail was displayed before, false otherwise; set by higher-level code.
boolean	bRequestRcpt Whether or not to request read confirmation from the recipients of this mail
java.util.HashMap<java.lang.String,java.lang.String>	hmHeaders Supplemental headers to be added when sending the mail
int	iFolder Folder ID; set by higher-level code
int	iMailID Unique mail ID; set by higher-level code
int	iMailSize Total size of this mail; set by higher-level code.
int	iPriority Message priority.
int	iStatus Mail status; set by higher-level code (0=new, 1=read)
MailDate	mdDate The Date field of the header
java.lang.String	sBCC Blind carbon copies
java.lang.String	sCC Carbon copies of this mail
java.lang.String	sConfirmation The text to send when confirming the read of an email
java.lang.String	sContentType Content type
java.lang.String	sEncoding Encoding used to embed the text / attachments / ...
java.lang.String	sFrom Sender of the mail
java.lang.String	sMessageID Message ID, used to thread emails
java.lang.String	sNotification Where to send the notification that this mail was read
java.lang.String	sOrigMessageID The original message ID that is confirmed to be read
java.lang.String	sReplyTo Where to ask the receiver to send the replies to
java.lang.String	sReturnPath Where to ask the servers on the way to report errors in case that the delivery is not possible
java.lang.String	sShortFrom Just the name part of the sender
java.lang.String	sSubject Mail subject
java.lang.String	sTo Destination(s) for this mail

Fields inherited from class lazyj.mail.Header

mHeaders, sBoundary, sCompleteHeader

Constructor Summary

Constructors

Constructor and Description
MailHeader() Empty constructor, initialize fields to default values.
MailHeader(java.lang.String sHeader) Initialize the fields based on this actual header.

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(java.lang.String sKey, java.lang.String sValue) Add an extra header to be put in the mail that is sent.
int	compareTo(MailHeader o) Default sorting methods for the mails: by the date
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	toString() A reconstruction of the headers.

Methods inherited from class lazyj.mail.Header

getOriginalHeader, getValue, main

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

sFrom

public java.lang.String sFrom

Sender of the mail

sShortFrom

public java.lang.String sShortFrom

Just the name part of the sender

sTo

public java.lang.String sTo

Destination(s) for this mail

sCC

public java.lang.String sCC

Carbon copies of this mail

sBCC

public java.lang.String sBCC

Blind carbon copies

sSubject

public java.lang.String sSubject

Mail subject

sContentType

public java.lang.String sContentType

Content type

sReplyTo

public java.lang.String sReplyTo

Where to ask the receiver to send the replies to

sReturnPath

public java.lang.String sReturnPath

Where to ask the servers on the way to report errors in case that the delivery is not possible

sEncoding

public java.lang.String sEncoding

Encoding used to embed the text / attachments / ...

sNotification

public java.lang.String sNotification

Where to send the notification that this mail was read

sMessageID

public java.lang.String sMessageID

Message ID, used to thread emails

mdDate

public MailDate mdDate

The Date field of the header

iMailID

public int iMailID

Unique mail ID; set by higher-level code

iStatus

public int iStatus

Mail status; set by higher-level code (0=new, 1=read)

bOld

public boolean bOld

True if this mail was displayed before, false otherwise; set by higher-level code.

iFolder

public int iFolder

Folder ID; set by higher-level code

iMailSize

public int iMailSize

Total size of this mail; set by higher-level code.

iPriority

public int iPriority

Message priority.

bEstimatedHasAttachments

public boolean bEstimatedHasAttachments

This only an assumption about the attachment status. This assumption is based on the content-type. When an email has attachments it typically has some content-types, that are not there when the mail does not contain any attachments. Since this assumption can be broken by some mail clients, use this only as an indication. It is good for example to display a special icon in folder listings, since it doesn't hurt, and it doesn't actually take time to decode the mail.

bConfirmation

public boolean bConfirmation

If this is a read confirmation of a previously sent mail.

sConfirmation

public java.lang.String sConfirmation

The text to send when confirming the read of an email

sOrigMessageID

public java.lang.String sOrigMessageID

The original message ID that is confirmed to be read

bRequestRcpt

public boolean bRequestRcpt

Whether or not to request read confirmation from the recipients of this mail

hmHeaders

public java.util.HashMap<java.lang.String,java.lang.String> hmHeaders

Supplemental headers to be added when sending the mail

Constructor Detail

MailHeader

public MailHeader()

Empty constructor, initialize fields to default values.

MailHeader

public MailHeader(java.lang.String sHeader)

Initialize the fields based on this actual header.

Parameters:

sHeader - original mail header

Method Detail

addHeader

public void addHeader(java.lang.String sKey,
             java.lang.String sValue)

Add an extra header to be put in the mail that is sent.

Parameters:

sKey - header name

sValue - value for this key

toString

public java.lang.String toString()

A reconstruction of the headers.

Overrides:

toString in class java.lang.Object

Returns:

a correct mail header, built from the internal fields

compareTo

public int compareTo(MailHeader o)

Default sorting methods for the mails: by the date

Specified by:

compareTo in interface java.lang.Comparable<MailHeader>

Parameters:

o - object to compare to

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object