Package com.aquima.interactions.foundation.connectivity.impl

Class SimpleSmtpMailConnection

java.lang.Object

com.aquima.interactions.foundation.connectivity.impl.SimpleSmtpMailConnection

All Implemented Interfaces:

IConnection, IMailConnection

public class SimpleSmtpMailConnection
extends Object
implements IMailConnection

This mail connection implementation uses the Simple Mail Transfer Protocol (SMTP) to send email messages.

Since:

6.4

Author:

Jon van Leuven

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleSmtpMailConnection(String name, String smtpHost, int smtpPort, String smtpUser, String smtpPassword, boolean useTls, String fromAddress, String[] toAddresses, String[] ccAddresses, String[] bccAddresses)	This constructor creates a mail connection for a SMTP host, port, username and password, while also specifying the usage of TLS.

Method Summary

Modifier and Type	Method	Description
protected jakarta.mail.internet.MimeMessage	createEmailMessage(IMailMessage message, jakarta.mail.Session session)
String[]	getBccAddresses()
String[]	getCcAddresses()
String	getFromAddress()
String	getName()	This method returns the name of the connection object.
String[]	getToAddresses()
ConnectionType	getType()	This method returns the type of the connection object.
protected jakarta.mail.internet.MimeMessage	onBeforeSend(IMailMessage message, jakarta.mail.internet.MimeMessage mimeMessage)
void	sendMessage(IMailMessage message)	This method sends the email message via this connection.

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleSmtpMailConnection

protected SimpleSmtpMailConnection(String name,
 String smtpHost,
 int smtpPort,
 String smtpUser,
 String smtpPassword,
 boolean useTls,
 String fromAddress,
 String[] toAddresses,
 String[] ccAddresses,
 String[] bccAddresses)

This constructor creates a mail connection for a SMTP host, port, username and password, while also specifying the usage of TLS. If no username and password is specified, no authentication will be performed.

Parameters:

name - The unique name for this connection, may not be empty or null.

smtpHost - The host name, may not be empty or null.

smtpPort - must be an integer value between 1 and 65535

smtpUser - The user name for the SMTP host, may be null or empty.

smtpPassword - The password name for the SMTP host, may be null or empty.

useTls - Indication if TLS is to be used.

fromAddress - the address to send the mail from

toAddresses - the recipients

ccAddresses - the cc addresses

bccAddresses - the bcc addresses

Method Details

getName

public String getName()

Description copied from interface: IConnection

This method returns the name of the connection object. The name is used to uniquely identify the connection object.

Specified by:

getName in interface IConnection

Returns:

the name of the connection object.

getType

public ConnectionType getType()

Description copied from interface: IConnection

This method returns the type of the connection object.

Specified by:

getType in interface IConnection

Returns:

the type of the connection object.

sendMessage

public void sendMessage(IMailMessage message)
                 throws MailSizeExceededException

Description copied from interface: IMailConnection

This method sends the email message via this connection.

Specified by:

sendMessage in interface IMailConnection

Parameters:

message - The email message, may not be null

Throws:

MailSizeExceededException - Should be thrown when the message size exceeds the mail server storage allocation.

getFromAddress

public String getFromAddress()

Specified by:

getFromAddress in interface IMailConnection

getToAddresses

public String[] getToAddresses()

Specified by:

getToAddresses in interface IMailConnection

getCcAddresses

public String[] getCcAddresses()

Specified by:

getCcAddresses in interface IMailConnection

getBccAddresses

public String[] getBccAddresses()

Specified by:

getBccAddresses in interface IMailConnection

createEmailMessage

protected jakarta.mail.internet.MimeMessage createEmailMessage(IMailMessage message,
 jakarta.mail.Session session)
                                                        throws Exception

Throws:

Exception

onBeforeSend

protected jakarta.mail.internet.MimeMessage onBeforeSend(IMailMessage message,
 jakarta.mail.internet.MimeMessage mimeMessage)
                                                  throws Exception

Throws:

Exception