com.knowgate.hipermail

Class HeadersHelper

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.knowgate.hipermail.HeadersHelper

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class HeadersHelper
extends org.xml.sax.helpers.DefaultHandler

Set of utility functions for managing MimeMessage headers

Version:

7.0

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	computeContentMD5(byte[] byArray)
java.lang.String	decodeMessageId() 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.
static java.lang.String	decodeMessageId(javax.mail.internet.MimeMessage oMimeMsg) 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.
java.lang.String	decodeMessageId(java.lang.String sDefault) Get decoded Message Id
java.lang.String	getContentID()
static java.lang.String	getContentID(javax.mail.internet.MimeMessage oMsg)
java.lang.String	getContentMD5()
static java.lang.String	getContentMD5(javax.mail.internet.MimeMessage oMsg)
java.lang.String	getContentType()
static java.lang.String	getContentType(javax.mail.internet.MimeMessage oMsg)
java.lang.String	getDescription()
static java.lang.String	getDescription(javax.mail.internet.MimeMessage oMsg)
java.lang.String	getDisposition()
static java.lang.String	getDisposition(javax.mail.internet.MimeMessage oMsg)
java.lang.String	getEncoding()
static java.lang.String	getEncoding(javax.mail.internet.MimeMessage oMsg)
java.lang.String	getFileName()
static java.lang.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()
java.lang.String	getMessageID()
static java.lang.String	getMessageID(javax.mail.internet.MimeMessage oMsg)
java.lang.String	getPriority()
static java.lang.String	getPriority(javax.mail.internet.MimeMessage oMsg)
java.sql.Timestamp	getReceivedTimestamp()
static java.sql.Timestamp	getReceivedTimestamp(javax.mail.internet.MimeMessage oMsg)
java.sql.Timestamp	getSentTimestamp()
static java.sql.Timestamp	getSentTimestamp(javax.mail.internet.MimeMessage oMsg)
java.lang.String	getSubject()
static java.lang.String	getSubject(javax.mail.internet.MimeMessage oMsg)
java.lang.String	getText()
boolean	isSpam()
static boolean	isSpam(javax.mail.internet.MimeMessage oMsg)
void	setMessage(javax.mail.internet.MimeMessage oMimeMsg)
java.lang.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

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

Constructor Detail

HeadersHelper

public HeadersHelper()

HeadersHelper

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

Method Detail

setMessage

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

decodeMessageId

public static java.lang.String decodeMessageId(javax.mail.internet.MimeMessage oMimeMsg)
                                        throws javax.mail.MessagingException,
                                               java.io.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

java.io.UnsupportedEncodingException

decodeMessageId

public java.lang.String decodeMessageId()
                                 throws javax.mail.MessagingException,
                                        java.io.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

java.io.UnsupportedEncodingException

decodeMessageId

public java.lang.String decodeMessageId(java.lang.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 java.lang.String getContentType(javax.mail.internet.MimeMessage oMsg)
                                       throws java.io.UnsupportedEncodingException,
                                              javax.mail.MessagingException

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

getContentType

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

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

getContentID

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

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

getContentID

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

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

getMessageID

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

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

getMessageID

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

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

getDisposition

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

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

getDisposition

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

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

getContentMD5

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

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

computeContentMD5

public static java.lang.String computeContentMD5(byte[] byArray)

getContentMD5

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

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

getDescription

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

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

getDescription

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

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

getFileName

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

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

getFileName

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

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

getEncoding

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

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

getEncoding

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

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

getSubject

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

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

getSubject

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

Throws:

java.io.UnsupportedEncodingException

javax.mail.MessagingException

getSentTimestamp

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

Throws:

javax.mail.MessagingException

getSentTimestamp

public java.sql.Timestamp getSentTimestamp()
                                    throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getReceivedTimestamp

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

Throws:

javax.mail.MessagingException

getReceivedTimestamp

public java.sql.Timestamp getReceivedTimestamp()
                                        throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getPriority

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

Throws:

javax.mail.MessagingException

getPriority

public java.lang.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

getText

public java.lang.String getText()
                         throws javax.mail.MessagingException,
                                java.io.IOException

Throws:

javax.mail.MessagingException

java.io.IOException

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 java.lang.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