org.sourceforge.vlibrary.user.workers

Interface MailSender

All Known Implementing Classes:

MailSenderImpl

public interface MailSender

Simple SMTP Mime message sender.

Version:

$Revision$ $Date$

Method Summary

Modifier and Type	Method and Description
String	getHost() Gets the smpt host name.
String	getPassword() Gets the SMTP user password.
int	getPort() Gets the smtp port.
javax.mail.Session	getSession() Gets an smtp session with the currently configured properties, creating a new session if the session has not been initialized.
String	getUser() Returns the smtp user name.
boolean	isAuthenticated() Gets authentication state of underlying mail session.
boolean	isTls() Whether or not TLS is used to connect to the SMTP server.
void	send(org.springframework.mail.SimpleMailMessage message) Sends a mail message using an smtp session with properties matching the current bean property values.
void	send(org.springframework.mail.SimpleMailMessage[] messages) Sends an array of mail message using an smtp session with properties matching the current bean property values.
void	setAuthenticated(boolean authenticated) Sets authentication state of underlying mail session.
void	setHost(String host) Sets the smtp host name.
void	setPassword(String password) Sets the password and forces reinitialization of the authenticated mail session if the session is authenticated.
void	setPort(int port) Sets the smpt port.
void	setSession(javax.mail.Session session) Sets the smtp session and modifies bean properties to match those of the given session.
void	setTls(boolean tls) Gets TLS state of underlying mail session.
void	setUser(String user) Sets the smpt user name and forces reinitialization of the authenticated mail session if the session is authenticated.

Method Detail

getPassword

String getPassword()

Gets the SMTP user password.

Returns:

the password

setPassword

void setPassword(String password)

Sets the password and forces reinitialization of the authenticated mail session if the session is authenticated.

Parameters:

password - new value for the password

getUser

String getUser()

Returns the smtp user name.

Returns:

the username

setUser

void setUser(String user)

Sets the smpt user name and forces reinitialization of the authenticated mail session if the session is authenticated.

Parameters:

user - new value for the user name

getSession

javax.mail.Session getSession()

Gets an smtp session with the currently configured properties, creating a new session if the session has not been initialized.

Returns:

smtp session

setSession

void setSession(javax.mail.Session session)

Sets the smtp session and modifies bean properties to match those of the given session.

Parameters:

session - the new session

getHost

String getHost()

Gets the smpt host name. Default value is localhost.

Returns:

smpt host

setHost

void setHost(String host)

Sets the smtp host name.

Parameters:

host - the new smtp host name

getPort

int getPort()

Gets the smtp port. Default value is 25.

Returns:

the smpt port

setPort

void setPort(int port)

Sets the smpt port.

Parameters:

port - the new smtp port

isAuthenticated

boolean isAuthenticated()

Gets authentication state of underlying mail session. Default value is false.

Returns:

true means mail session is authenticated

setAuthenticated

void setAuthenticated(boolean authenticated)

Sets authentication state of underlying mail session.

Parameters:

authenticated - new value for session authentication property

isTls

boolean isTls()

Whether or not TLS is used to connect to the SMTP server. Default value is false.

Returns:

true means TLS transport is used

setTls

void setTls(boolean tls)

Gets TLS state of underlying mail session.

Parameters:

tls - new value for TLS transport property

send

void send(org.springframework.mail.SimpleMailMessage message)
   throws org.springframework.mail.MailException

Sends a mail message using an smtp session with properties matching the current bean property values.

Parameters:

message - message to send

Throws:

org.springframework.mail.MailException - if a messsaging exception occurs sending the message

send

void send(org.springframework.mail.SimpleMailMessage[] messages)
   throws org.springframework.mail.MailException

Sends an array of mail message using an smtp session with properties matching the current bean property values.

Parameters:

messages - messages to send

Throws:

org.springframework.mail.MailException - if a messsaging exception occurs