er.corebusinesslogic
Class ERCMailDelivery

java.lang.Object
  er.corebusinesslogic.ERCMailDelivery

public class ERCMailDelivery
extends java.lang.Object

Utility class used for sending mails via the ERCMailMessage database tables. Actual emails are then sent using the ERMailer application.

Field Summary

protected static ERCMailDelivery	_sharedInstance holds a reference to the shared instance
static org.apache.log4j.Logger	log logging supprt

Constructor Summary

ERCMailDelivery()

Method Summary

static java.lang.String	commaSeparatedListFromArray(com.webobjects.foundation.NSArray a) Utilitiy method used to break an array of email addresses down into a comma separated list.
ERCMailMessage	composeComponentEmail(java.lang.String from, com.webobjects.foundation.NSArray to, com.webobjects.foundation.NSArray cc, com.webobjects.foundation.NSArray bcc, java.lang.String title, java.lang.String componentName, com.webobjects.foundation.NSDictionary bindings, com.webobjects.eocontrol.EOEditingContext ec) Composes a mail message from a given component.
ERCMailMessage	composeComponentEmail(java.lang.String from, com.webobjects.foundation.NSArray to, com.webobjects.foundation.NSArray cc, com.webobjects.foundation.NSArray bcc, java.lang.String title, java.lang.String componentName, java.lang.String plainTextComponentName, com.webobjects.foundation.NSDictionary bindings, com.webobjects.eocontrol.EOEditingContext ec) Composes a mail message from a given component.
ERCMailMessage	composeComponentEmail(java.lang.String from, com.webobjects.foundation.NSArray to, com.webobjects.foundation.NSArray cc, com.webobjects.foundation.NSArray bcc, java.lang.String title, com.webobjects.appserver.WOComponent component, com.webobjects.eocontrol.EOEditingContext ec) Composes a mail message from a given component.
ERCMailMessage	composeComponentEmail(java.lang.String from, com.webobjects.foundation.NSArray to, com.webobjects.foundation.NSArray cc, com.webobjects.foundation.NSArray bcc, java.lang.String title, com.webobjects.appserver.WOComponent component, com.webobjects.appserver.WOComponent plainTextComponent, com.webobjects.eocontrol.EOEditingContext ec) Composes a mail message from previously instantiated components.
ERCMailMessage	composeEmail(java.lang.String from, com.webobjects.foundation.NSArray to, com.webobjects.foundation.NSArray cc, com.webobjects.foundation.NSArray bcc, java.lang.String title, java.lang.String message, com.webobjects.eocontrol.EOEditingContext ec) Composes a mail message.
ERCMailMessage	composeEmailWithAttachments(java.lang.String from, com.webobjects.foundation.NSArray to, com.webobjects.foundation.NSArray cc, com.webobjects.foundation.NSArray bcc, java.lang.String title, java.lang.String message, com.webobjects.foundation.NSArray filePaths, com.webobjects.eocontrol.EOEditingContext ec) Composes a mail message with attachments.
static ERCMailDelivery	sharedInstance() Gets the shared instance used to create ERCMailMessages.
static boolean	usesMail() Is Mail turned on

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.apache.log4j.Logger log

logging supprt

_sharedInstance

protected static ERCMailDelivery _sharedInstance

holds a reference to the shared instance

Constructor Detail

ERCMailDelivery

public ERCMailDelivery()

Method Detail

sharedInstance

public static ERCMailDelivery sharedInstance()

Gets the shared instance used to create ERCMailMessages.

Returns:

shared instance used to create mail messages.

commaSeparatedListFromArray

public static java.lang.String commaSeparatedListFromArray(com.webobjects.foundation.NSArray a)

Utilitiy method used to break an array of email addresses down into a comma separated list. Performs a bit of search and replace to clean up the email addresses a bit.

Parameters:

a - array of email addresses

Returns:

comma separated and cleaned up list of email addresses

usesMail

public static boolean usesMail()

Is Mail turned on

Returns:

if the Mail is turned on

composeEmail

public ERCMailMessage composeEmail(java.lang.String from,
                                   com.webobjects.foundation.NSArray to,
                                   com.webobjects.foundation.NSArray cc,
                                   com.webobjects.foundation.NSArray bcc,
                                   java.lang.String title,
                                   java.lang.String message,
                                   com.webobjects.eocontrol.EOEditingContext ec)

Composes a mail message.

Parameters:

from - email address

to - email addresses

cc - email addresses

bcc - email addresses

title - of the message

message - text of the message

ec - editing context to create the mail message in.

Returns:

created mail message for the given parameters

composeEmailWithAttachments

public ERCMailMessage composeEmailWithAttachments(java.lang.String from,
                                                  com.webobjects.foundation.NSArray to,
                                                  com.webobjects.foundation.NSArray cc,
                                                  com.webobjects.foundation.NSArray bcc,
                                                  java.lang.String title,
                                                  java.lang.String message,
                                                  com.webobjects.foundation.NSArray filePaths,
                                                  com.webobjects.eocontrol.EOEditingContext ec)

Composes a mail message with attachments.

Parameters:

from - email address

to - email addresses

cc - email addresses

bcc - email addresses

title - of the message

message - text of the message

filePaths - array of file paths to attach

ec - editing context to create the mail message in.

Returns:

created mail message for the given parameters

composeComponentEmail

public ERCMailMessage composeComponentEmail(java.lang.String from,
                                            com.webobjects.foundation.NSArray to,
                                            com.webobjects.foundation.NSArray cc,
                                            com.webobjects.foundation.NSArray bcc,
                                            java.lang.String title,
                                            com.webobjects.appserver.WOComponent component,
                                            com.webobjects.eocontrol.EOEditingContext ec)

Composes a mail message from a given component.

Parameters:

from - email address

to - email addresses

cc - email addresses

bcc - email addresses

title - of the message

component - to render to get the message

ec - editing context to create the mail message in.

Returns:

created mail message for the given parameters

composeComponentEmail

public ERCMailMessage composeComponentEmail(java.lang.String from,
                                            com.webobjects.foundation.NSArray to,
                                            com.webobjects.foundation.NSArray cc,
                                            com.webobjects.foundation.NSArray bcc,
                                            java.lang.String title,
                                            java.lang.String componentName,
                                            com.webobjects.foundation.NSDictionary bindings,
                                            com.webobjects.eocontrol.EOEditingContext ec)

Composes a mail message from a given component.

Parameters:

from - email address

to - email addresses

cc - email addresses

bcc - email addresses

title - of the message

componentName - name of the component to render

ec - editing context to create the mail message in.

Returns:

created mail message for the given parameters

composeComponentEmail

public ERCMailMessage composeComponentEmail(java.lang.String from,
                                            com.webobjects.foundation.NSArray to,
                                            com.webobjects.foundation.NSArray cc,
                                            com.webobjects.foundation.NSArray bcc,
                                            java.lang.String title,
                                            java.lang.String componentName,
                                            java.lang.String plainTextComponentName,
                                            com.webobjects.foundation.NSDictionary bindings,
                                            com.webobjects.eocontrol.EOEditingContext ec)

Composes a mail message from a given component.

Parameters:

from - email address

to - email addresses

cc - email addresses

bcc - email addresses

title - of the message

componentName - name of the component to render

plainTextComponentName - name of the component to render

bindings - bindings dictionary to use for the components that are instantiated

ec - editing context to create the mail message in.

Returns:

created mail message for the given parameters

composeComponentEmail

public ERCMailMessage composeComponentEmail(java.lang.String from,
                                            com.webobjects.foundation.NSArray to,
                                            com.webobjects.foundation.NSArray cc,
                                            com.webobjects.foundation.NSArray bcc,
                                            java.lang.String title,
                                            com.webobjects.appserver.WOComponent component,
                                            com.webobjects.appserver.WOComponent plainTextComponent,
                                            com.webobjects.eocontrol.EOEditingContext ec)

Composes a mail message from previously instantiated components.

Parameters:

from - email address

to - email addresses

cc - email addresses

bcc - email addresses

title - of the message

component - component to render

plainTextComponent - plain-text component to render

ec - editing context to create the mail message in.

Returns:

created mail message for the given parameters