de.deepamehta.plugins.mail.service

Interface MailService

All Known Implementing Classes:

MailPlugin

public interface MailService

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGGREGATION
static String	AGGREGATION_DEFINITION
static String	ATTACHMENTS
static String	BODY
static String	CHILD
static String	CHILD_TYPE
static String	COMPOSITION
static String	COMPOSITION_DEFINITION
static String	DATE
static String	EMAIL_ADDRESS
static String	FILE
static String	FROM
static String	MAIL
static String	MESSAGE_ID
static String	PARENT
static String	PARENT_TYPE
static String	RECIPIENT
static String	RECIPIENT_TYPE
static String	SENDER
static String	SIGNATURE
static String	SUBJECT
static String	TOPIC_TYPE
static String	USER_ACCOUNT

Method Summary

Modifier and Type	Method and Description
de.deepamehta.core.Association	associateRecipient(long mailId, long addressId, RecipientType type) Update or create a mail recipient association.
de.deepamehta.core.Association	associateSender(long topicId, long addressId) Update or create a mail sender association.
void	associateValidatedRecipients(long mailId, List<de.deepamehta.core.Topic> recipients) Associate all valid email addresses of each recipient.
Collection<de.deepamehta.core.RelatedTopic>	getSearchParentTypes() Returns parent of each search type.
StatusReport	send(Mail mail) Sends a HTML mail.

Field Detail

AGGREGATION

static final String AGGREGATION

See Also:

Constant Field Values

AGGREGATION_DEFINITION

static final String AGGREGATION_DEFINITION

See Also:

Constant Field Values

COMPOSITION

static final String COMPOSITION

See Also:

Constant Field Values

COMPOSITION_DEFINITION

static final String COMPOSITION_DEFINITION

See Also:

Constant Field Values

CHILD

static final String CHILD

See Also:

Constant Field Values

CHILD_TYPE

static final String CHILD_TYPE

See Also:

Constant Field Values

TOPIC_TYPE

static final String TOPIC_TYPE

See Also:

Constant Field Values

PARENT

static final String PARENT

See Also:

Constant Field Values

PARENT_TYPE

static final String PARENT_TYPE

See Also:

Constant Field Values

USER_ACCOUNT

static final String USER_ACCOUNT

See Also:

Constant Field Values

FILE

static final String FILE

See Also:

Constant Field Values

ATTACHMENTS

static final String ATTACHMENTS

See Also:

Constant Field Values

BODY

static final String BODY

See Also:

Constant Field Values

EMAIL_ADDRESS

static final String EMAIL_ADDRESS

See Also:

Constant Field Values

DATE

static final String DATE

See Also:

Constant Field Values

FROM

static final String FROM

See Also:

Constant Field Values

MAIL

static final String MAIL

See Also:

Constant Field Values

MESSAGE_ID

static final String MESSAGE_ID

See Also:

Constant Field Values

RECIPIENT

static final String RECIPIENT

See Also:

Constant Field Values

RECIPIENT_TYPE

static final String RECIPIENT_TYPE

See Also:

Constant Field Values

SENDER

static final String SENDER

See Also:

Constant Field Values

SIGNATURE

static final String SIGNATURE

See Also:

Constant Field Values

SUBJECT

static final String SUBJECT

See Also:

Constant Field Values

Method Detail

getSearchParentTypes

Collection<de.deepamehta.core.RelatedTopic> getSearchParentTypes()

Returns parent of each search type. Parent types must include at least one email address.

Returns:

parent search types.

associateRecipient

de.deepamehta.core.Association associateRecipient(long mailId,
                                                  long addressId,
                                                  RecipientType type)

Update or create a mail recipient association.

Parameters:

mailId - ID of a mail topic.

addressId - Email address of recipient.

type - Recipient type URI or null to choose the configured default.

Returns:

Recipient association with email address and recipient type.

associateSender

de.deepamehta.core.Association associateSender(long topicId,
                                               long addressId)

Update or create a mail sender association.

Parameters:

topicId - ID of a mail or configuration topic.

addressId - Email address of sender.

Returns:

Sender association with email address.

associateValidatedRecipients

void associateValidatedRecipients(long mailId,
                                  List<de.deepamehta.core.Topic> recipients)

Associate all valid email addresses of each recipient.

Parameters:

mailId -

recipients -

send

StatusReport send(Mail mail)
           throws UnsupportedEncodingException,
                  org.apache.commons.mail.EmailException,
                  IOException

Sends a HTML mail.

Parameters:

mail - Mail topic.

Returns:

Sent mail topic.

Throws:

UnsupportedEncodingException

org.apache.commons.mail.EmailException

IOException