org.sape.carbon.services.email
Interface MailConfiguration

All Superinterfaces:

ComponentConfiguration, Configuration

public interface MailConfiguration

extends ComponentConfiguration

The configuration interface for the email component.

Copyright 2002 Sapient

Since:

carbon 1.0

Version:

$Revision: 1.3

Author:

$Author: dvoet $ $Date: 2003/06/27 20:50:23 $

Field Summary

static boolean	HoldConnection Default value for Hold Connection property, if configuration does not specify Hold Connection, the dafault value would be returned.
static boolean	JavaMailDebugMode JavaMailDebugMode sets the debug setting in the mail session.
static int	RetryAttempts Default value for Retry Attempts, if configuration does not specify Retry Attempts, the dafault value would be returned.
static long	SleepTimeInMilliSecs Default value for Sleep time, if configuration does not specify Sleep time, the dafault value would be returned.

Fields inherited from interface org.sape.carbon.core.component.ComponentConfiguration

ComponentTemplateName

Method Summary

boolean	getHoldConnection() A boolean property indicating whether or not the email service will create and keep open a connection to the SMTP host for its lifetime.
boolean	getJavaMailDebugMode() JavaMailDebugMode sets the debug setting in the mail session.
int	getRetryAttempts() This indicates the number of retry attempts to be made with SMTP server to send an email.
long	getSleepTimeInMilliSecs() This indicates the time in milliseconds the thread would sleep before attempting to re-connect with smtp server.
String	getSmtpHost() Returns the SMTP host name or ip address.
void	setHoldConnection(boolean holdConnection) Setter for Hold Connection property.
void	setJavaMailDebugMode(boolean debugMode) JavaMailDebugMode sets the debug setting in the mail session.
void	setRetryAttempts() Setter for Retry attempts.
void	setSleepTimeInMilliSecs() Setter for Sleep time in millisecs.
void	setSmtpHost(String smtpHost) Setter for SMTP host name or ip address.

Methods inherited from interface org.sape.carbon.core.component.ComponentConfiguration

getComponentDescription, getComponentTemplateName, getFunctionalImplementationClass, getFunctionalInterface, setComponentDescription, setComponentTemplateName, setFunctionalImplementationClass, setFunctionalInterface

Methods inherited from interface org.sape.carbon.core.config.Configuration

clone, getConfigurationInterface, getConfigurationName, getDataStructure, getRootElement, isConfigurationWritable, setConfigurationName, setConfigurationReadOnly

Field Detail

HoldConnection

public static final boolean HoldConnection

Default value for Hold Connection property, if configuration does not specify Hold Connection, the dafault value would be returned.

See Also:

Constant Field Values

RetryAttempts

public static final int RetryAttempts

Default value for Retry Attempts, if configuration does not specify Retry Attempts, the dafault value would be returned.

See Also:

Constant Field Values

SleepTimeInMilliSecs

public static final long SleepTimeInMilliSecs

Default value for Sleep time, if configuration does not specify Sleep time, the dafault value would be returned.

See Also:

Constant Field Values

JavaMailDebugMode

public static final boolean JavaMailDebugMode

JavaMailDebugMode sets the debug setting in the mail session.

Since:

carbon 1.2

See Also:

Constant Field Values

Method Detail

getSmtpHost

public String getSmtpHost()

Returns the SMTP host name or ip address.

Returns:

String The SMTP host name or ip address.

getHoldConnection

public boolean getHoldConnection()

A boolean property indicating whether or not the email service will create and keep open a connection to the SMTP host for its lifetime. If set to true, the connection will not be closed until the email service is shutdown. If set to false a new connection will be opened for each email sent.

Returns:

boolean

getRetryAttempts

public int getRetryAttempts()

This indicates the number of retry attempts to be made with SMTP server to send an email.

Returns:

int

getSleepTimeInMilliSecs

public long getSleepTimeInMilliSecs()

This indicates the time in milliseconds the thread would sleep before attempting to re-connect with smtp server. If retry attempts is 0 you don't need to specify this property.

Returns:

long

setSmtpHost

public void setSmtpHost(String smtpHost)

Setter for SMTP host name or ip address.

Parameters:

smtpHost - the hostname or ip address

setHoldConnection

public void setHoldConnection(boolean holdConnection)

Setter for Hold Connection property.

Parameters:

holdConnection - indicates the connection should be held

setRetryAttempts

public void setRetryAttempts()

Setter for Retry attempts.

setSleepTimeInMilliSecs

public void setSleepTimeInMilliSecs()

Setter for Sleep time in millisecs.

getJavaMailDebugMode

public boolean getJavaMailDebugMode()

JavaMailDebugMode sets the debug setting in the mail session.

Returns:

setting for debug mode

Since:

carbon 1.2

setJavaMailDebugMode

public void setJavaMailDebugMode(boolean debugMode)

JavaMailDebugMode sets the debug setting in the mail session.

Parameters:

debugMode - setting for debug mode

Since:

carbon 1.2