com.adobe.idp.taskmanager.dsc.client.emailsettings
Interface EmailServerSettings

All Superinterfaces:

java.io.Serializable

public interface EmailServerSettings
extends java.io.Serializable

Represents email settings for sending and receiving email message to users and administrators.

Applications can programatically specify an email account for the LiveCycle server. Administrators can set these parameters by using the LiveCycle Administration Console.

The LiveCycle server uses the email account to exchange email messages with LiveCycle users and administrators. These email messages notify and remind users of tasks that they must complete, notify the server of tasks that have reached a deadline, and notify the administrator of any process errors that occur.

Method Summary

java.lang.String	getPop3Login() Returns the POP3 login name.
java.lang.String	getPop3Password() Gets the POP3 password.
long	getPop3ReadInterval() Gets the frequency for checking the POP3 inbox for new messages.
java.lang.String	getPop3Server() Gets the POP3 server name or IP address.
java.lang.String	getServerEmailAddress() Gets the Workflow Server email address.
java.lang.String	getSmtpLogin() Returns the SMTP login name.
java.lang.String	getSmtpPassword() Gets the SMTP login password.
java.lang.String	getSmtpServer() Gets the configured SMTP server name.
int	getSmtpServerPort() Gets the configured SMTP server port number.
boolean	isReadPop3MailboxEnabled() Gets the POP3 inbox reader enable flag.
boolean	isSendingEmailEnabled() Gets the flag determining if SMTP email sending is enabled or not.
void	setPop3Login(java.lang.String pop3Login) Sets the POP3 login name.
void	setPop3Password(java.lang.String pop3Password) Sets the POP3 login password.
void	setPop3ReadInterval(long pop3ReadInterval) Sets the frequency for checking the POP3 inbox for new messages.
void	setPop3Server(java.lang.String pop3Server) Sets the POP3 server name or IP address.
void	setReadPop3MailboxEnabled(boolean readPop3Mailbox) Sets the POP3 inbox reader enabled flag.
void	setSendingEmailEnabled(boolean sendTaskEmail) Sets the flag to enable or disable sending of SMTP email.
void	setServerEmailAddress(java.lang.String serverEmailAddress) Sets the Workflow Server email address.
void	setSmtpLogin(java.lang.String smtpLogin) Sets the login name used to authenticate against the SMTP server.
void	setSmtpPassword(java.lang.String smtpPassword) Sets the password used to authenticate against the SMTP server.
void	setSmtpServer(java.lang.String smtpServer) Sets the SMTP server name.
void	setSmtpServerPort(int smtpServerPort) Sets the SMTP server port number.

Method Detail

getSmtpServer

java.lang.String getSmtpServer()

Gets the configured SMTP server name.

setSmtpServer

void setSmtpServer(java.lang.String smtpServer)

Sets the SMTP server name.

Call EmailSettingService.saveNotificationSettings(settings) to persist to the database.

Parameters:

smtpServer - A name or IP address.

getSmtpServerPort

int getSmtpServerPort()

Gets the configured SMTP server port number.

setSmtpServerPort

void setSmtpServerPort(int smtpServerPort)

Sets the SMTP server port number.

Call EmailSettingService.saveNotificationSettings(settings) to persist to the database.

Parameters:

smtpServerPort - The port to use to communicate with the SMTP server.

getServerEmailAddress

java.lang.String getServerEmailAddress()

Gets the Workflow Server email address.

Returns:

A String.

setServerEmailAddress

void setServerEmailAddress(java.lang.String serverEmailAddress)

Sets the Workflow Server email address.

Call EmailSettingService.saveNotificationSettings(settings) to persist to the database.

Parameters:

serverEmailAddress - An email address.

getSmtpLogin

java.lang.String getSmtpLogin()

Returns the SMTP login name.

This has to be empty for SMTP servers that do not require authentication.

Returns:

The SMTP login name or an empty string.

setSmtpLogin

void setSmtpLogin(java.lang.String smtpLogin)

Sets the login name used to authenticate against the SMTP server.

This has to be empty for SMTP servers that do not require authentication.

Call EmailSettingService.saveNotificationSettings(settings) to persist to the database.

Parameters:

smtpLogin - The login name.

getSmtpPassword

java.lang.String getSmtpPassword()

Gets the SMTP login password.

This has to be empty for SMTP servers that do not require authentication.

Returns:

A string containing a password or an empty string.

setSmtpPassword

void setSmtpPassword(java.lang.String smtpPassword)

Sets the password used to authenticate against the SMTP server.

This has to be empty for SMTP servers that do not require authentication.

Call EmailSettingService.saveNotificationSettings(settings) to persist to the database.

Parameters:

smtpPassword - The new SMTP password.

getPop3Server

java.lang.String getPop3Server()

Gets the POP3 server name or IP address.

Returns:

The server name or address.

setPop3Server

void setPop3Server(java.lang.String pop3Server)

Sets the POP3 server name or IP address.

Call EmailSettingService.saveNotificationSettings(settings) to persist to the database.

Parameters:

pop3Server - A new server name or IP address.

getPop3Login

java.lang.String getPop3Login()

Returns the POP3 login name.

Returns:

A user login name.

setPop3Login

void setPop3Login(java.lang.String pop3Login)

Sets the POP3 login name.

Call EmailSettingService.saveNotificationSettings(settings) to persist to the database.

Parameters:

pop3Login - The new user login name.

getPop3Password

java.lang.String getPop3Password()

Gets the POP3 password.

Returns:

The POP3 password.

setPop3Password

void setPop3Password(java.lang.String pop3Password)

Sets the POP3 login password.

Call EmailSettingService.saveNotificationSettings(settings) to persist to the database.

Parameters:

pop3Password - A password.

isReadPop3MailboxEnabled

boolean isReadPop3MailboxEnabled()

Gets the POP3 inbox reader enable flag.

Returns:

True if POP3 inbox reading is enabled, false if no inbox is read.

setReadPop3MailboxEnabled

void setReadPop3MailboxEnabled(boolean readPop3Mailbox)

Sets the POP3 inbox reader enabled flag.

Call EmailSettingService.saveNotificationSettings(settings) to persist to the database.

Parameters:

readPop3Mailbox - True to enable POP3 reading; false to disable POP3 reading.

isSendingEmailEnabled

boolean isSendingEmailEnabled()

Gets the flag determining if SMTP email sending is enabled or not.

Returns:

True if SMTP email is sent; false if SMTP email is not sent.

setSendingEmailEnabled

void setSendingEmailEnabled(boolean sendTaskEmail)

Sets the flag to enable or disable sending of SMTP email.

Call EmailSettingService.saveNotificationSettings(settings) to persist to the database.

Parameters:

sendTaskEmail - True to enable sending of SMTP email; false to disable sending of SMTP email.

getPop3ReadInterval

long getPop3ReadInterval()

Gets the frequency for checking the POP3 inbox for new messages.

Returns:

The read interval in milliseconds.

setPop3ReadInterval

void setPop3ReadInterval(long pop3ReadInterval)

Sets the frequency for checking the POP3 inbox for new messages.

Call EmailSettingService.saveNotificationSettings(settings) to persist to the database.

Parameters:

pop3ReadInterval - The interval frequency in milliseconds.