Package com.logicaldoc.core.communication

Class EMailSender

java.lang.Object

com.logicaldoc.core.communication.EMailSender

public class EMailSender
extends Object

SMTP E-Mail sender service

Author:

Michael Scholz, Matteo Caruso - LogicalDOC

Field Summary

Fields

Modifier and Type	Field	Description
Long	folderId
int	foldering
static int	FOLDERING_DAY
static int	FOLDERING_MONTH
static int	FOLDERING_NONE
static int	FOLDERING_YEAR
static int	SECURITY_NONE
static int	SECURITY_SSL
static int	SECURITY_STARTTLS
static int	SECURITY_TLS

Constructor Summary

Constructors

Constructor	Description
EMailSender()
EMailSender(long tenant)
EMailSender(String tenant)

Method Summary

Modifier and Type	Method	Description
int	getConnectionSecurity()
Long	getFolderId()
int	getFoldering()
String	getHost()
String	getPassword()
int	getPort()
String	getSender()
String	getUsername()
boolean	isAuthEncrypted()
void	send(EMail email)	This method sends an email using the smtp-protocol.
void	send(EMail email, String templateName, Map<String,Object> dictionary)	Sends an email by using a given template
void	sendAsync(EMail email)	Same as send(EMail) but executes in another thread
void	sendAsync(EMail email, String templateName, Map<String,Object> dictionary)	Same as send(EMail, String, Map) but executes in another thread
void	setAuthEncrypted(boolean authEncrypted)
void	setConnectionSecurity(int connectionSecurity)
void	setFolderId(Long folderId)
void	setFoldering(int foldering)
void	setHost(String host)
void	setPassword(String password)
void	setPort(int port)
void	setSender(String sender)
void	setUsername(String username)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SECURITY_NONE

public static final int SECURITY_NONE

See Also:

Constant Field Values

SECURITY_STARTTLS

public static final int SECURITY_STARTTLS

See Also:

Constant Field Values

SECURITY_TLS

public static final int SECURITY_TLS

See Also:

Constant Field Values

SECURITY_SSL

public static final int SECURITY_SSL

See Also:

Constant Field Values

FOLDERING_NONE

public static int FOLDERING_NONE

FOLDERING_YEAR

public static int FOLDERING_YEAR

FOLDERING_MONTH

public static int FOLDERING_MONTH

FOLDERING_DAY

public static int FOLDERING_DAY

foldering

public int foldering

folderId

public Long folderId

Constructor Detail

EMailSender

public EMailSender(long tenant)

EMailSender

public EMailSender(String tenant)

EMailSender

public EMailSender()

Method Detail

getSender

public String getSender()

setSender

public void setSender(String sender)

getHost

public String getHost()

setHost

public void setHost(String host)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getPort

public int getPort()

setPort

public void setPort(int port)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

sendAsync

public void sendAsync(EMail email,
                      String templateName,
                      Map<String,Object> dictionary)

Same as send(EMail, String, Map) but executes in another thread

Parameters:

email - the email to send

templateName - the template to use to render the body of the message using the automation engine

dictionary - map of variable to pass to the automation

send

public void send(EMail email,
                 String templateName,
                 Map<String,Object> dictionary)
          throws Exception

Sends an email by using a given template

Parameters:

email - The email to send

templateName - Name of the template to be applied

dictionary - The dictionary to be used in the template

Throws:

Exception - raised if the message cannot be sent

sendAsync

public void sendAsync(EMail email)

Same as send(EMail) but executes in another thread

Parameters:

email - the email to send

send

public void send(EMail email)
          throws Exception

This method sends an email using the smtp-protocol. The email can be a simple mail or a multipart mail containing up to 5 attachments.

Parameters:

email - E-Mail which should be sent.

Throws:

Exception - raised if the email cannot be sent

isAuthEncrypted

public boolean isAuthEncrypted()

setAuthEncrypted

public void setAuthEncrypted(boolean authEncrypted)

getConnectionSecurity

public int getConnectionSecurity()

setConnectionSecurity

public void setConnectionSecurity(int connectionSecurity)

getFoldering

public int getFoldering()

setFoldering

public void setFoldering(int foldering)

getFolderId

public Long getFolderId()

setFolderId

public void setFolderId(Long folderId)