Package adams.core.net

Interface SendEmail

All Superinterfaces:

CleanUpHandler, Destroyable, OptionHandler

All Known Subinterfaces:

InMemorySendEmail

All Known Implementing Classes:

AbstractSendEmail, ApacheSendEmail, JavaMailSendEmail, SimpleApacheSendEmail

public interface SendEmail
extends OptionHandler, CleanUpHandler

Interface for classes that can send emails.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
void	initializeSmtpSession(String server, int port, boolean useTLS, boolean useSSL, int timeout, boolean requiresAuth, String user, BasePassword pw, String protocols)	Initializes the SMTP session.
boolean	requiresSmtpSessionInitialization()	Returns whether the SMTP session needs to be initialized.
boolean	sendMail(Email email)	Sends an email.

Methods inherited from interface adams.core.CleanUpHandler

cleanUp

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Method Detail

requiresSmtpSessionInitialization

boolean requiresSmtpSessionInitialization()

Returns whether the SMTP session needs to be initialized.

Returns:

true if the SMTP session needs to be initialized

initializeSmtpSession

void initializeSmtpSession(String server,
                           int port,
                           boolean useTLS,
                           boolean useSSL,
                           int timeout,
                           boolean requiresAuth,
                           String user,
                           BasePassword pw,
                           String protocols)
                    throws Exception

Initializes the SMTP session.

Parameters:

server - the SMTP server

port - the SMTP port

useTLS - whether to use TLS

useSSL - whether to use SSL

timeout - the timeout

requiresAuth - whether authentication is required

user - the SMTP user

pw - the SMTP password

protocols - the protocols to use, empty for default

Throws:

Exception - if initialization fails

sendMail

boolean sendMail(Email email)
          throws Exception

Sends an email.

Parameters:

email - the email to send

Returns:

true if successfully sent

Throws:

Exception - in case of invalid internet addresses or messaging problem