ERCMailDelivery Class Reference

Collaboration diagram for ERCMailDelivery:

[legend]

List of all members.

Public Member Functions
ERCMailMessage	composeComponentEmail (String from, NSArray to, NSArray cc, NSArray bcc, String title, WOComponent component, WOComponent plainTextComponent, EOEditingContext ec)
ERCMailMessage	composeComponentEmail (String from, NSArray to, NSArray cc, NSArray bcc, String title, String componentName, String plainTextComponentName, NSDictionary bindings, EOEditingContext ec)
ERCMailMessage	composeComponentEmail (String from, NSArray to, NSArray cc, NSArray bcc, String title, String componentName, NSDictionary bindings, EOEditingContext ec)
ERCMailMessage	composeComponentEmail (String from, NSArray to, NSArray cc, NSArray bcc, String title, WOComponent component, EOEditingContext ec)
ERCMailMessage	composeEmail (String from, NSArray to, NSArray cc, NSArray bcc, String title, String message, EOEditingContext ec)
ERCMailMessage	composeEmailWithAttachments (String from, NSArray to, NSArray cc, NSArray bcc, String title, String message, NSArray filePaths, EOEditingContext ec)
Static Public Member Functions
static String	commaSeparatedListFromArray (NSArray a)
static ERCMailDelivery	sharedInstance ()
static boolean	usesMail ()
Static Public Attributes
static final Logger	log = Logger.getLogger(ERCMailDelivery.class)
Static Protected Attributes
static ERCMailDelivery	_sharedInstance

---

Detailed Description

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

---

Member Function Documentation

static String commaSeparatedListFromArray

(

NSArray

a

)

[static]

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

ERCMailMessage composeComponentEmail	(	String	from,
		NSArray	to,
		NSArray	cc,
		NSArray	bcc,
		String	title,
		WOComponent	component,
		WOComponent	plainTextComponent,
		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

ERCMailMessage composeComponentEmail	(	String	from,
		NSArray	to,
		NSArray	cc,
		NSArray	bcc,
		String	title,
		String	componentName,
		String	plainTextComponentName,
		NSDictionary	bindings,
		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

ERCMailMessage composeComponentEmail	(	String	from,
		NSArray	to,
		NSArray	cc,
		NSArray	bcc,
		String	title,
		String	componentName,
		NSDictionary	bindings,
		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

ERCMailMessage composeComponentEmail	(	String	from,
		NSArray	to,
		NSArray	cc,
		NSArray	bcc,
		String	title,
		WOComponent	component,
		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

ERCMailMessage composeEmail	(	String	from,
		NSArray	to,
		NSArray	cc,
		NSArray	bcc,
		String	title,
		String	message,
		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

ERCMailMessage composeEmailWithAttachments	(	String	from,
		NSArray	to,
		NSArray	cc,
		NSArray	bcc,
		String	title,
		String	message,
		NSArray	filePaths,
		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

static ERCMailDelivery sharedInstance

(

)

[static]

Gets the shared instance used to create ERCMailMessages.

Returns:

shared instance used to create mail messages.

static boolean usesMail

(

)

[static]

Is Mail turned on

Returns:

if the Mail is turned on

---

Member Data Documentation

ERCMailDelivery _sharedInstance [static, protected]

holds a reference to the shared instance

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

logging supprt

---

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

• /opt/source/Wonder/Frameworks/BusinessLogic/ERCoreBusinessLogic/Sources/er/corebusinesslogic/ERCMailDelivery.java