ERMailer Class Reference

Collaboration diagram for ERMailer:

Collaboration graph
[legend]

List of all members.

Classes

class  DefaultFactory
interface  Factory

Public Member Functions

ERMailDelivery createMailDeliveryForMailMessage (ERCMailMessage message) throws MessagingException
String messageTitlePrefix ()
void processOutgoingMail ()
void sendMailMessages (NSArray mailMessages)

Static Public Member Functions

static Factory factory ()
static ERMailer instance ()
static ERMailer newMailer ()
static void setFactory (Factory value)

Static Public Attributes

static final Logger log = Logger.getLogger(ERMailer.class)

Static Protected Member Functions

static boolean shouldDeleteSentMail ()

Protected Attributes

String messageTitlePrefix

Static Protected Attributes

static Factory factory
static ERMailer instance

Static Private Attributes

static final boolean _warnOnGeneralAdaptorExceptionLockingMessage


Detailed Description

Mailer bridge class. Used to pull mail out of the ERMailMessage entity and send it via the ERJavaMail framework for sending mail.

Member Function Documentation

ERMailDelivery createMailDeliveryForMailMessage ( ERCMailMessage  message  )  throws MessagingException

Creates a ERMailDelivery for a given MailMessage.

Parameters:
message mail message
Returns:
a mail delevery object

static Factory factory (  )  [static]

Gets the current factory. If the factory is unset, sets the factory to the default factory.

Returns:
the factory

static ERMailer instance (  )  [static]

Gets the shared mailer instance.

Returns:
mailer singleton

The message title prefix is used to distiguish emails generated in different environments.

Returns:
message title prefix

static ERMailer newMailer (  )  [static]

Instantiates a new mailer instance using the factory and returns it.

Returns:
a new mailer instance.

void processOutgoingMail (  ) 

Fetches all mail that is ready to be sent from the ERMailMessage table and sends the message using the ERJavaMail framework for sending messages.

void sendMailMessages ( NSArray  mailMessages  ) 

Sends an array of ERCMailMessage objects.

Parameters:
mailMessages array of messages to send

static void setFactory ( Factory  value  )  [static]

Sets the factory.

Parameters:
value new factory value

static boolean shouldDeleteSentMail (  )  [static, protected]


Member Data Documentation

final boolean _warnOnGeneralAdaptorExceptionLockingMessage [static, private]

Initial value:

        ERXProperties.booleanForKeyWithDefault("er.javamail.mailer.ERMailer.WarnOnGeneralAdaptorExceptionLockingMessage", true)

Factory factory [static, protected]

ERMailer instance [static, protected]

holds a reference to the shared instance

final Logger log = Logger.getLogger(ERMailer.class) [static]

logging support

Caches the message title prefix


The documentation for this class was generated from the following file:

Generated on Sat May 26 06:43:22 2012 for Project Wonder by  doxygen 1.5.8