Package com.basis.api.admin

Interface BBjAdminEmailMessage

All Superinterfaces:

BBjAdminPropertyReader, BBjAdminPropertyWriter, Remote

public interface BBjAdminEmailMessage
extends BBjAdminPropertyWriter

A single email message to send through a BBjAdminEmailService. The BBjAdminEmailMessage contains information such as the recipients, reply-to, from, the message contents, and any file attachments.

Find a complete code sample at: BBjAdminEmailService.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BCC
static final String	CC
static final String	FROM
static final String	HTML
static final String	REPLY_TO
static final String	SUBJECT
static final String	TEXT
static final String	TO

Method Summary

Modifier and Type	Method	Description
void	addAttachment(BBjAdminEmailAttachment p_attachment)	Add an email attachment to the message.
BBjAdminList<BBjAdminEmailAttachment>	getAttachments()	Get current list of email attachments.

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyReader

checkValueEqual, contains, contains, getBoolean, getDouble, getInt, getList, getLong, getProperties, getString, getType, getTypes, getValue

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyWriter

addType, canAddNewProperties, canClear, clear, clearProperties, clearProperty, getReadOnly, hasChanged, isReadOnly, setBoolean, setDouble, setInt, setList, setLong, setProperties, setString, setValue

Field Details

HTML

static final String HTML

See Also:

• Constant Field Values

TEXT

static final String TEXT

See Also:

• Constant Field Values

SUBJECT

static final String SUBJECT

See Also:

• Constant Field Values

TO

static final String TO

See Also:

• Constant Field Values

CC

static final String CC

See Also:

• Constant Field Values

BCC

static final String BCC

See Also:

• Constant Field Values

FROM

static final String FROM

See Also:

• Constant Field Values

REPLY_TO

static final String REPLY_TO

See Also:

• Constant Field Values

Method Details

addAttachment

void addAttachment(BBjAdminEmailAttachment p_attachment)
            throws BBjAdminException

Add an email attachment to the message. Any number of attachments may be added.

Parameters:

p_attachment - Attachment to be sent with the email message.

Throws:

BBjAdminException

getAttachments

BBjAdminList<BBjAdminEmailAttachment> getAttachments()
                                              throws BBjAdminException

Get current list of email attachments. Attachments should be added using addAttachment().

Returns:

List of attachments.

Throws:

BBjAdminException