com.knowgate.mail

Class MailHeadersHelper

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.knowgate.mail.MailHeadersHelper

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class MailHeadersHelper
extends DefaultHandler

Set of utility functions for managing MimeMessage headers

Version:

8.0

Author:

Sergio Montoro Ten

Constructor Summary

Constructors

Constructor and Description
MailHeadersHelper()
MailHeadersHelper(javax.mail.internet.MimeMessage oMimeMsg)

Method Summary

Modifier and Type	Method and Description
static String	computeContentMD5(byte[] byArray)
String	decodeMessageId() Get decoded Message Id
static String	decodeMessageId(javax.mail.internet.MimeMessage oMimeMsg) Get decoded Message Id
String	decodeMessageId(String sDefault) Get decoded Message Id
String	getContentID()
static String	getContentID(javax.mail.internet.MimeMessage oMsg)
String	getContentMD5()
static String	getContentMD5(javax.mail.internet.MimeMessage oMsg)
String	getContentType()
static String	getContentType(javax.mail.internet.MimeMessage oMsg)
String	getDescription()
static String	getDescription(javax.mail.internet.MimeMessage oMsg)
String	getDisposition()
static String	getDisposition(javax.mail.internet.MimeMessage oMsg)
String	getEncoding()
static String	getEncoding(javax.mail.internet.MimeMessage oMsg)
String	getFileName()
static String	getFileName(javax.mail.internet.MimeMessage oMsg)
javax.mail.Flags	getFlags()
static javax.mail.Flags	getFlags(javax.mail.internet.MimeMessage oMsg)
javax.mail.internet.InternetAddress	getFrom()
String	getMessageID()
static String	getMessageID(javax.mail.internet.MimeMessage oMsg)
String	getPriority()
static String	getPriority(javax.mail.internet.MimeMessage oMsg)
Timestamp	getReceivedTimestamp()
static Timestamp	getReceivedTimestamp(javax.mail.internet.MimeMessage oMsg)
Timestamp	getSentTimestamp()
static Timestamp	getSentTimestamp(javax.mail.internet.MimeMessage oMsg)
String	getSubject()
static String	getSubject(javax.mail.internet.MimeMessage oMsg)
boolean	isSpam()
static boolean	isSpam(javax.mail.internet.MimeMessage oMsg)
void	setMessage(javax.mail.internet.MimeMessage oMimeMsg)
String	toXML() Get headers in XML format

Methods inherited from class org.xml.sax.helpers.DefaultHandler

characters, endDocument, endElement, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

MailHeadersHelper

public MailHeadersHelper()

MailHeadersHelper

public MailHeadersHelper(javax.mail.internet.MimeMessage oMimeMsg)

Method Detail

setMessage

public void setMessage(javax.mail.internet.MimeMessage oMimeMsg)

decodeMessageId

public static String decodeMessageId(javax.mail.internet.MimeMessage oMimeMsg)
                              throws javax.mail.MessagingException,
                                     UnsupportedEncodingException

Get decoded Message Id

This method first calls MimeMessage.getMessageID() If nothing is returned then it tries to retrieve header X-Qmail-Scanner-Message-ID or Resent-Message-ID.
If neither Message-Id nor X-Qmail-Scanner-Message-ID nor Resent-Message-ID headers are found then a message id is assigned by using the message sent date and from address like:
<20050722140022.sender@domain.com> The result is then decoded by calling MimeUtility.decodeText() before being returned

Parameters:

oMimeMsg - MimeMessage

Returns:

String Decoded value of Message Id.

Throws:

javax.mail.MessagingException

UnsupportedEncodingException

decodeMessageId

public String decodeMessageId()
                       throws javax.mail.MessagingException,
                              UnsupportedEncodingException

Get decoded Message Id

This method first calls MimeMessage.getMessageID() If nothing is returned then it tries to retrieve header X-Qmail-Scanner-Message-ID or Resent-Message-ID.
If neither Message-Id nor X-Qmail-Scanner-Message-ID nor Resent-Message-ID headers are found then a message id is assigned by using the message sent date and from address like:
<20050722140022.sender@domain.com> The result is then decoded by calling MimeUtility.decodeText() before being returned

Returns:

String Decoded value of Message Id.

Throws:

javax.mail.MessagingException

UnsupportedEncodingException

decodeMessageId

public String decodeMessageId(String sDefault)

Get decoded Message Id

Parameters:

sDefault - String Default value is a Message Id. cannot be found at message headers

Returns:

String

getContentType

public static String getContentType(javax.mail.internet.MimeMessage oMsg)
                             throws UnsupportedEncodingException,
                                    javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

getContentType

public String getContentType()
                      throws UnsupportedEncodingException,
                             javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

getContentID

public static String getContentID(javax.mail.internet.MimeMessage oMsg)
                           throws UnsupportedEncodingException,
                                  javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

getContentID

public String getContentID()
                    throws UnsupportedEncodingException,
                           javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

getMessageID

public static String getMessageID(javax.mail.internet.MimeMessage oMsg)
                           throws UnsupportedEncodingException,
                                  javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

getMessageID

public String getMessageID()
                    throws UnsupportedEncodingException,
                           javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

getDisposition

public static String getDisposition(javax.mail.internet.MimeMessage oMsg)
                             throws UnsupportedEncodingException,
                                    javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

getDisposition

public String getDisposition()
                      throws UnsupportedEncodingException,
                             javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

getContentMD5

public static String getContentMD5(javax.mail.internet.MimeMessage oMsg)
                            throws UnsupportedEncodingException,
                                   javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

computeContentMD5

public static String computeContentMD5(byte[] byArray)

getContentMD5

public String getContentMD5()
                     throws UnsupportedEncodingException,
                            javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

getDescription

public static String getDescription(javax.mail.internet.MimeMessage oMsg)
                             throws UnsupportedEncodingException,
                                    javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

getDescription

public String getDescription()
                      throws UnsupportedEncodingException,
                             javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

getFileName

public static String getFileName(javax.mail.internet.MimeMessage oMsg)
                          throws UnsupportedEncodingException,
                                 javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

getFileName

public String getFileName()
                   throws UnsupportedEncodingException,
                          javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

getEncoding

public static String getEncoding(javax.mail.internet.MimeMessage oMsg)
                          throws UnsupportedEncodingException,
                                 javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

getEncoding

public String getEncoding()
                   throws UnsupportedEncodingException,
                          javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

getSubject

public static String getSubject(javax.mail.internet.MimeMessage oMsg)
                         throws UnsupportedEncodingException,
                                javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

getSubject

public String getSubject()
                  throws UnsupportedEncodingException,
                         javax.mail.MessagingException

Throws:

UnsupportedEncodingException

javax.mail.MessagingException

getSentTimestamp

public static Timestamp getSentTimestamp(javax.mail.internet.MimeMessage oMsg)
                                  throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getSentTimestamp

public Timestamp getSentTimestamp()
                           throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getReceivedTimestamp

public static Timestamp getReceivedTimestamp(javax.mail.internet.MimeMessage oMsg)
                                      throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getReceivedTimestamp

public Timestamp getReceivedTimestamp()
                               throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getPriority

public static String getPriority(javax.mail.internet.MimeMessage oMsg)
                          throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getPriority

public String getPriority()
                   throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getFlags

public static javax.mail.Flags getFlags(javax.mail.internet.MimeMessage oMsg)
                                 throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getFlags

public javax.mail.Flags getFlags()
                          throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getFrom

public javax.mail.internet.InternetAddress getFrom()
                                            throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

isSpam

public static boolean isSpam(javax.mail.internet.MimeMessage oMsg)
                      throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

isSpam

public boolean isSpam()
               throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

toXML

public String toXML()

Get headers in XML format

Returns:

String with syntax:
<msg> <num>[1..n]</num> <id>message unique identifier</id> <len>message length in bytes</len> <type>message content-type</type> <disposition>message content-disposition</disposition> <priority>X-Priority header</priority> <spam>X-Spam-Flag header</spam> <subject><![CDATA[message subject]]></subject> <sent>yyy-mm-dd hh:mi:ss</sent> <received>yyy-mm-dd hh:mi:ss</received> <from><![CDATA[personal name or e-mail of sender]]></from> <to><![CDATA[personal name or e-mail of receiver]]></to> <size>integer size in kilobytes</size> <err>error description (if any)</err> </msg>

Since:

4.0