com.knowgate.hipermail

Class RecipientsHelper

java.lang.Object

com.knowgate.hipermail.RecipientsHelper

public class RecipientsHelper
extends java.lang.Object

Helper class for working with recipients lists

Version:

5.0

Constructor Summary

Constructors

Constructor and Description
RecipientsHelper() Default Constructor
RecipientsHelper(javax.mail.internet.MimeMessage oMsg) Create RecipientsHelper and fill it with MimeMessage recipients
RecipientsHelper(java.lang.String sWorkAreaGUID) Construct and set default workarea for this recipients helper

Method Summary

Methods

Modifier and Type	Method and Description
static int	acknowledgeNotification(JDCConnection oCon, com.sun.mail.dsn.MultipartReport oCnt)
void	addRecipients(javax.mail.Address[] oAddrs, javax.mail.Message.RecipientType oRecTp) Add recipients of a given type
static void	clearRecipientsForMessage(JDCConnection oConn, java.lang.String sGuMimeMsg) Delete rows at k_inet_addrs table for given message
java.lang.String[]	getAddresses(javax.mail.Message.RecipientType oRecTp) Get array with recipients of a given type
static javax.mail.internet.InternetAddress	getFromAddress(javax.mail.internet.MimeMessage oMsg)
javax.mail.Address[]	getRecipients(javax.mail.Message.RecipientType oRecTp) Get array with recipients of a given type
static javax.mail.internet.InternetAddress	getReplyAddress(javax.mail.internet.MimeMessage oMsg)
boolean	hasLists() If called after parseRecipientsList(), this methods returns whether or not any distribution list was expanded during the parsing process
static java.lang.String	joinAddressList(javax.mail.Address[] aRecipients) Join mail addresses array on a single String
void	parseRecipientsList(JDCConnection oAdCn, java.lang.String sDelimitedList, javax.mail.Message.RecipientType oRecTp) Parse a String of comma or semicolon delimited addresses Addresses may be of any format accepted by DBInetAddr.parseAddress() method.
void	setRecipients(javax.mail.Address[] oAddrs, javax.mail.Message.RecipientType oRecTp)
void	setRecipients(javax.mail.internet.MimeMessage oMsg)

Methods inherited from class java.lang.Object

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

Constructor Detail

RecipientsHelper

public RecipientsHelper()

Default Constructor

RecipientsHelper

public RecipientsHelper(java.lang.String sWorkAreaGUID)

Construct and set default workarea for this recipients helper

RecipientsHelper

public RecipientsHelper(javax.mail.internet.MimeMessage oMsg)
                 throws javax.mail.MessagingException

Create RecipientsHelper and fill it with MimeMessage recipients

Parameters:

oMsg - MimeMessage

Throws:

javax.mail.MessagingException

Method Detail

hasLists

public boolean hasLists()

If called after parseRecipientsList(), this methods returns whether or not any distribution list was expanded during the parsing process

Returns:

boolean

getAddresses

public java.lang.String[] getAddresses(javax.mail.Message.RecipientType oRecTp)

Get array with recipients of a given type

Parameters:

oRecTp - RecipientType

Returns:

InternetAddress[]

getRecipients

public javax.mail.Address[] getRecipients(javax.mail.Message.RecipientType oRecTp)

Get array with recipients of a given type

Parameters:

oRecTp - RecipientType

Returns:

InternetAddress[]

setRecipients

public void setRecipients(javax.mail.Address[] oAddrs,
                 javax.mail.Message.RecipientType oRecTp)
                   throws java.lang.ClassCastException

Throws:

java.lang.ClassCastException

setRecipients

public void setRecipients(javax.mail.internet.MimeMessage oMsg)
                   throws java.lang.ClassCastException,
                          javax.mail.MessagingException

Throws:

java.lang.ClassCastException

javax.mail.MessagingException

addRecipients

public void addRecipients(javax.mail.Address[] oAddrs,
                 javax.mail.Message.RecipientType oRecTp)
                   throws java.lang.ClassCastException

Add recipients of a given type

Parameters:

oAddrs - InternetAddress[]

oRecTp - RecipientType

Throws:

java.lang.ClassCastException

joinAddressList

public static java.lang.String joinAddressList(javax.mail.Address[] aRecipients)

Join mail addresses array on a single String

Parameters:

aRecipients - Address[]

Returns:

String Mail addresses delimited by semicolons

parseRecipientsList

public void parseRecipientsList(JDCConnection oAdCn,
                       java.lang.String sDelimitedList,
                       javax.mail.Message.RecipientType oRecTp)
                         throws java.sql.SQLException,
                                java.lang.IndexOutOfBoundsException,
                                java.lang.NullPointerException,
                                javax.mail.internet.AddressException,
                                java.io.UnsupportedEncodingException

Parse a String of comma or semicolon delimited addresses

Addresses may be of any format accepted by DBInetAddr.parseAddress() method.
Distribution lists present at input string are expanded into BCC internal array.
Distribution list names begin with "list@" and end with ".list".
Or, also distribution list names are enclosed by brackets like "{this is a list}"
Thus if "engineers" is the GUID of a list containing members luke@engineers.com,peter@engineers.com then TO "jhon@code.com,martin@maths.com,list@engineers.list,steve@maths.com" will be parsed as
TO jhon@code.com,martin@maths.com,steve@maths.com
BCC luke@engineers.com,peter@engineers.com

Parameters:

oAdCn - JDCConnection

sDelimitedList - String with addresses to be parsed

oRecTp - RecipientType

Throws:

java.sql.SQLException

java.lang.IndexOutOfBoundsException

java.lang.NullPointerException

javax.mail.internet.AddressException

java.io.UnsupportedEncodingException

clearRecipientsForMessage

public static void clearRecipientsForMessage(JDCConnection oConn,
                             java.lang.String sGuMimeMsg)
                                      throws java.sql.SQLException

Delete rows at k_inet_addrs table for given message

Parameters:

oConn - JDCConnection

sGuMimeMsg - String GUID of message which addresses are to be cleared

Throws:

java.sql.SQLException

getFromAddress

public static javax.mail.internet.InternetAddress getFromAddress(javax.mail.internet.MimeMessage oMsg)
                                                          throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getReplyAddress

public static javax.mail.internet.InternetAddress getReplyAddress(javax.mail.internet.MimeMessage oMsg)
                                                           throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

acknowledgeNotification

public static int acknowledgeNotification(JDCConnection oCon,
                          com.sun.mail.dsn.MultipartReport oCnt)
                                   throws java.sql.SQLException,
                                          java.io.IOException,
                                          javax.mail.MessagingException

Throws:

java.sql.SQLException

java.io.IOException

javax.mail.MessagingException