de.deepamehta.plugins.mail.service
Interface MailService

Show UML class diagram

All Superinterfaces:

PluginService

All Known Implementing Classes:

MailPlugin

public interface MailService
extends PluginService

Method Summary

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

Method Detail

getSearchParentTypes

Collection<Topic> getSearchParentTypes()

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

Returns:

parent search types.

associateRecipient

Association associateRecipient(long mailId,
                               long addressId,
                               RecipientType type,
                               ClientState clientState)

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.

clientState - Optional cookie or null.

Returns:

Recipient association with email address and recipient type.

associateSender

Association associateSender(long topicId,
                            long addressId,
                            ClientState clientState)

Update or create a mail sender association.

Parameters:

topicId - ID of a mail or configuration topic.

addressId - Email address of sender.

clientState - Optional cookie or null.

Returns:

Sender association with email address.

associateValidatedRecipients

void associateValidatedRecipients(long mailId,
                                  List<Topic> recipients,
                                  ClientState clientState)

Associate all valid email addresses of each recipient.

Parameters:

mailId -

recipients -

clientState -

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