MailSenderImpl (Virtual Library 2.0.5-RC1 API)

java.lang.Object
- org.sourceforge.vlibrary.user.workers.MailSenderImpl

All Implemented Interfaces:

MailSender
```
public class MailSenderImpl
extends Object
implements MailSender
```
Javamail-based MailSender implementation. The mail session is lazy initialized and reinitialized when properties are changed.

Version:

$Revision$ $Date$

Constructor Summary

Constructors
Constructor and Description

MailSenderImpl()

Constructors
Constructor and Description
`MailSenderImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MailSenderImpl
```
public MailSenderImpl()
```
- Method Detail
  - isTls
```
public boolean isTls()
```
    Description copied from interface: MailSender
    
    Whether or not TLS is used to connect to the SMTP server. Default value is false.
    
    Specified by:
    
    isTls in interface MailSender
    
    Returns:
    
    true means TLS transport is used
  - setTls
```
public void setTls(boolean tls)
```
    Description copied from interface: MailSender
    
    Gets TLS state of underlying mail session.
    
    Specified by:
    
    setTls in interface MailSender
    
    Parameters:
    
    tls - new value for TLS transport property
  - isAuthenticated
```
public boolean isAuthenticated()
```
    Description copied from interface: MailSender
    
    Gets authentication state of underlying mail session. Default value is false.
    
    Specified by:
    
    isAuthenticated in interface MailSender
    
    Returns:
    
    true means mail session is authenticated
  - setAuthenticated
```
public void setAuthenticated(boolean authenticated)
```
    Description copied from interface: MailSender
    
    Sets authentication state of underlying mail session.
    
    Specified by:
    
    setAuthenticated in interface MailSender
    
    Parameters:
    
    authenticated - new value for session authentication property
  - getPassword
```
public String getPassword()
```
    Description copied from interface: MailSender
    
    Gets the SMTP user password.
    
    Specified by:
    
    getPassword in interface MailSender
    
    Returns:
    
    the password
  - setPassword
```
public void setPassword(String password)
```
    Description copied from interface: MailSender
    
    Sets the password and forces reinitialization of the authenticated mail session if the session is authenticated.
    
    Specified by:
    
    setPassword in interface MailSender
    
    Parameters:
    
    password - new value for the password
  - getUser
```
public String getUser()
```
    Description copied from interface: MailSender
    
    Returns the smtp user name.
    
    Specified by:
    
    getUser in interface MailSender
    
    Returns:
    
    the username
  - setUser
```
public void setUser(String user)
```
    Description copied from interface: MailSender
    
    Sets the smpt user name and forces reinitialization of the authenticated mail session if the session is authenticated.
    
    Specified by:
    
    setUser in interface MailSender
    
    Parameters:
    
    user - new value for the user name
  - getSession
```
public javax.mail.Session getSession()
```
    Description copied from interface: MailSender
    
    Gets an smtp session with the currently configured properties, creating a new session if the session has not been initialized.
    
    Specified by:
    
    getSession in interface MailSender
    
    Returns:
    
    smtp session
  - setSession
```
public void setSession(javax.mail.Session session)
```
    Description copied from interface: MailSender
    
    Sets the smtp session and modifies bean properties to match those of the given session.
    
    Specified by:
    
    setSession in interface MailSender
    
    Parameters:
    
    session - the new session
  - getHost
```
public String getHost()
```
    Description copied from interface: MailSender
    
    Gets the smpt host name. Default value is localhost.
    
    Specified by:
    
    getHost in interface MailSender
    
    Returns:
    
    smpt host
  - setHost
```
public void setHost(String host)
```
    Description copied from interface: MailSender
    
    Sets the smtp host name.
    
    Specified by:
    
    setHost in interface MailSender
    
    Parameters:
    
    host - the new smtp host name
  - getPort
```
public int getPort()
```
    Description copied from interface: MailSender
    
    Gets the smtp port. Default value is 25.
    
    Specified by:
    
    getPort in interface MailSender
    
    Returns:
    
    the smpt port
  - setPort
```
public void setPort(int port)
```
    Description copied from interface: MailSender
    
    Sets the smpt port.
    
    Specified by:
    
    setPort in interface MailSender
    
    Parameters:
    
    port - the new smtp port
  - send
```
public void send(org.springframework.mail.SimpleMailMessage message)
          throws org.springframework.mail.MailException
```
    Description copied from interface: MailSender
    
    Sends a mail message using an smtp session with properties matching the current bean property values.
    
    Specified by:
    
    send in interface MailSender
    
    Parameters:
    
    message - message to send
    
    Throws:
    
    org.springframework.mail.MailException - if a messsaging exception occurs sending the message
  - send
```
public void send(org.springframework.mail.SimpleMailMessage[] messages)
          throws org.springframework.mail.MailException
```
    Description copied from interface: MailSender
    
    Sends an array of mail message using an smtp session with properties matching the current bean property values.
    
    Specified by:
    
    send in interface MailSender
    
    Parameters:
    
    messages - messages to send
    
    Throws:
    
    org.springframework.mail.MailException - if a messsaging exception occurs

Class MailSenderImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MailSenderImpl

Method Detail

isTls

setTls

isAuthenticated

setAuthenticated

getPassword

setPassword

getUser

setUser

getSession

setSession

getHost

setHost

getPort

setPort

send

send