Package ch.tocco.nice2.messaging.mail.api

Interface Mail

All Superinterfaces:

BaseMail, Cloneable

All Known Implementing Classes:

AbstractOutgoingMail, DelegatingMail, IncaIncomeMail, IncaMail, MailImpl

public interface Mail
extends BaseMail, Cloneable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Mail.MailListener

Field Summary

Fields inherited from interface ch.tocco.nice2.messaging.mail.api.BaseMail

NO_SUBJECT

Method Summary

Modifier and Type	Method	Description
Mail	addBcc(Entity userEntity)	Add the address from a User entity to "bcc".
Mail	addBcc(EntityList userEntities)	Add addresses from User entities to "bcc".
Mail	addCc(Entity userEntity)	Add the address from a User entity to "cc".
Mail	addCc(EntityList userEntities)	Add addresses from User entities to "cc".
void	addMailListener(Mail.MailListener listener)
Mail	addSourceEntity(@Nullable Entity sourceEntity)
Mail	addTo(MailReceiver receiver)	Add a receiver to "to", evaluating the right value according to the MailReceiver^s configuration.
Mail	addTo(Entity userEntity)	Add the address from a User entity to "to".
Mail	addTo(EntityList userEntities)	Add addresses from User entities to "to".
Mail	clone()
boolean	containsAttachment(Attachment attachment)
Map<String,Object>	getAttributes()
String	getBody()
@Nullable Entity	getContactCategory()
org.joda.time.LocalDate	getExpiryDate()
String	getMimeMessageFrom()
Map<String,Iterable<String>>	getMimeMessageHeaders()
@Nullable Entity	getRecipientEntity()
@Nullable Entity	getRelatedEntity()
Entity	getSender()
@Nullable Entity	getSourceEntity()
UUID	getTaskUuid()
Optional<Object>	getTemplateAttribute(String name)	Get the value of a template attribute.
Map<String,Object>	getTemplateAttributes()	Get an unmodifiable map of all template attributes.
@Nullable Entity	getTemplateEntity()
boolean	isSingleCopyMail()
Mail	preventFromArchive(boolean preventFromArchive)
boolean	removeAttachment(Attachment attachment)
void	removeMailListener(Mail.MailListener listener)
void	send()	Send the message.
Mail	setContactCategory(@Nullable Entity contactCategory)
Mail	setExpiryDate(org.joda.time.LocalDate expiryDate)
Mail	setFrom(Entity from)
Mail	setRecipientEntity(@Nullable Entity recipientEntity)
Mail	setRelatedEntity(@Nullable Entity relatedEntity)
Mail	setSender(Entity sender)
Mail	setSingleCopyMail(boolean singleCopyMail)	only relevant for the GUI MailAction (defaults to false), won't link the resulting MailArchive entity to the recipient but the User(s) with the email address in BaseMail.getCc().
Mail	setSourceEntity(@Nullable Entity sourceEntity)
Mail	setTaskUuid(UUID taskUuid)	Set the UUID which is needed to group the mails sent from the same task
Mail	setTemplateAttribute(String name, Object value)	Set a template attribute.
Mail	setTemplateEntity(@Nullable Entity templateEntity)
Mail	setTemplateEntityData(String name, Entity entity)	Set an entity template attribute
Mail	setTemplateEntityListData(String name, EntityList entityList)	Set an entity list template attribute

Methods inherited from interface ch.tocco.nice2.messaging.mail.api.BaseMail

addAttachment, addBcc, addBcc, addBcc, addCc, addCc, addCc, addReplyTo, addReplyTo, addReplyTo, addTo, addTo, addTo, clearAttachments, clearBcc, clearCc, clearReplyTo, clearTo, createAttachment, createAttachment, createAttachment, getAttachments, getBcc, getCc, getFrom, getHtml, getReplyTo, getSubject, getText, getTo, hasNoRecipients, isBodyEmpty, setFrom, setHtml, setSubject, setText

Method Details

getSourceEntity

@Nullable
@Nullable Entity getSourceEntity()

setSourceEntity

Mail setSourceEntity(@Nullable
 @Nullable Entity sourceEntity)

addSourceEntity

Mail addSourceEntity(@Nullable
 @Nullable Entity sourceEntity)

getRelatedEntity

@Nullable
@Nullable Entity getRelatedEntity()

setRelatedEntity

Mail setRelatedEntity(@Nullable
 @Nullable Entity relatedEntity)

getRecipientEntity

@Nullable
@Nullable Entity getRecipientEntity()

setRecipientEntity

Mail setRecipientEntity(@Nullable
 @Nullable Entity recipientEntity)

addTo

Mail addTo(MailReceiver receiver)
    throws jakarta.mail.MessagingException

Add a receiver to "to", evaluating the right value according to the MailReceiver^s configuration.

Parameters:

receiver - the receiver

Throws:

jakarta.mail.MessagingException

addTo

Mail addTo(Entity userEntity)
    throws jakarta.mail.MessagingException

Add the address from a User entity to "to".

Parameters:

userEntity - Entity of type User

Throws:

jakarta.mail.MessagingException

addTo

Mail addTo(EntityList userEntities)
    throws jakarta.mail.MessagingException

Add addresses from User entities to "to".

Parameters:

userEntities - EntityList with entities of type User

Throws:

jakarta.mail.MessagingException

addCc

Mail addCc(Entity userEntity)
    throws jakarta.mail.MessagingException

Add the address from a User entity to "cc".

Parameters:

userEntity - Entity of type User

Throws:

jakarta.mail.MessagingException

addCc

Mail addCc(EntityList userEntities)
    throws jakarta.mail.MessagingException

Add addresses from User entities to "cc".

Parameters:

userEntities - EntityList with entities of type User

Throws:

jakarta.mail.MessagingException

addBcc

Mail addBcc(Entity userEntity)
     throws jakarta.mail.MessagingException

Add the address from a User entity to "bcc".

Parameters:

userEntity - Entity of type User

Throws:

jakarta.mail.MessagingException

addBcc

Mail addBcc(EntityList userEntities)
     throws jakarta.mail.MessagingException

Add addresses from User entities to "bcc".

Parameters:

userEntities - EntityList with entities of type User

Throws:

jakarta.mail.MessagingException

getContactCategory

@Nullable
@Nullable Entity getContactCategory()

setContactCategory

Mail setContactCategory(@Nullable
 @Nullable Entity contactCategory)

getTemplateEntity

@Nullable
@Nullable Entity getTemplateEntity()

setTemplateEntity

Mail setTemplateEntity(@Nullable
 @Nullable Entity templateEntity)

preventFromArchive

Mail preventFromArchive(boolean preventFromArchive)

setTemplateAttribute

Mail setTemplateAttribute(String name,
 Object value)

Set a template attribute. If an attribute with the same name already exists it will be overriden. To set entity data into a variable use setTemplateEntityData(String, ch.tocco.nice2.persist.entity.Entity) and setTemplateEntityListData(String, ch.tocco.nice2.persist.entity.EntityList).

Parameters:

name - The name for the attribute.

value - The value.

setTemplateEntityData

Mail setTemplateEntityData(String name,
 Entity entity)

Set an entity template attribute

Parameters:

name - the name for the attribute

entity - the entity

setTemplateEntityListData

Mail setTemplateEntityListData(String name,
 EntityList entityList)

Set an entity list template attribute

Parameters:

name - the name for the attribute

entityList - the entity list

getTemplateAttribute

Optional<Object> getTemplateAttribute(String name)

Get the value of a template attribute.

Parameters:

name - The name of the attribute to get.

Returns:

the value or Optional.empty() if it's not set.

getTemplateAttributes

Map<String,Object> getTemplateAttributes()

Get an unmodifiable map of all template attributes.

Returns:

an unmodifiable map of all attributes.

removeAttachment

boolean removeAttachment(Attachment attachment)

Specified by:

removeAttachment in interface BaseMail

containsAttachment

boolean containsAttachment(Attachment attachment)

Specified by:

containsAttachment in interface BaseMail

getAttributes

Map<String,Object> getAttributes()

send

void send()
   throws MailException

Send the message.

Throws:

MailException

clone

Mail clone()
    throws CloneNotSupportedException

Throws:

CloneNotSupportedException

setFrom

Mail setFrom(Entity from)
      throws jakarta.mail.MessagingException

Throws:

jakarta.mail.MessagingException

getSender

Entity getSender()

setSender

Mail setSender(Entity sender)

setSingleCopyMail

Mail setSingleCopyMail(boolean singleCopyMail)

only relevant for the GUI MailAction (defaults to false), won't link the resulting MailArchive entity to the recipient but the User(s) with the email address in BaseMail.getCc().

Parameters:

singleCopyMail - true / false

isSingleCopyMail

boolean isSingleCopyMail()

getExpiryDate

org.joda.time.LocalDate getExpiryDate()

setExpiryDate

Mail setExpiryDate(org.joda.time.LocalDate expiryDate)

getTaskUuid

UUID getTaskUuid()

setTaskUuid

Mail setTaskUuid(UUID taskUuid)

Set the UUID which is needed to group the mails sent from the same task

Parameters:

taskUuid - a random uuid given from the task which sends the mail

getBody

String getBody()
        throws MailException

Throws:

MailException

getMimeMessageHeaders

Map<String,Iterable<String>> getMimeMessageHeaders()
                                            throws MailException,
jakarta.mail.MessagingException

Throws:

MailException

jakarta.mail.MessagingException

getMimeMessageFrom

String getMimeMessageFrom()
                   throws jakarta.mail.MessagingException,
MailException

Throws:

jakarta.mail.MessagingException

MailException

addMailListener

void addMailListener(Mail.MailListener listener)

removeMailListener

void removeMailListener(Mail.MailListener listener)