|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EmailServerSettings
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 |
---|
java.lang.String getSmtpServer()
Gets the configured SMTP server name.
void setSmtpServer(java.lang.String smtpServer)
Sets the SMTP server name.
Call EmailSettingService.saveNotificationSettings(settings)
to persist to the database.
smtpServer
- A name or IP address.int getSmtpServerPort()
Gets the configured SMTP server port number.
void setSmtpServerPort(int smtpServerPort)
Sets the SMTP server port number.
Call EmailSettingService.saveNotificationSettings(settings)
to persist to the database.
smtpServerPort
- The port to use to communicate with the SMTP server.java.lang.String getServerEmailAddress()
Gets the Workflow Server email address.
void setServerEmailAddress(java.lang.String serverEmailAddress)
Sets the Workflow Server email address.
Call EmailSettingService.saveNotificationSettings(settings)
to persist to the database.
serverEmailAddress
- An email address.java.lang.String getSmtpLogin()
Returns the SMTP login name.
This has to be empty for SMTP servers that do not require authentication.
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.
smtpLogin
- The login name.java.lang.String getSmtpPassword()
Gets the SMTP login password.
This has to be empty for SMTP servers that do not require authentication.
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.
smtpPassword
- The new SMTP password.java.lang.String getPop3Server()
Gets the POP3 server name or IP address.
void setPop3Server(java.lang.String pop3Server)
Sets the POP3 server name or IP address.
Call EmailSettingService.saveNotificationSettings(settings)
to persist to the database.
pop3Server
- A new server name or IP address.java.lang.String getPop3Login()
Returns the POP3 login name.
void setPop3Login(java.lang.String pop3Login)
Sets the POP3 login name.
Call EmailSettingService.saveNotificationSettings(settings)
to persist to the database.
pop3Login
- The new user login name.java.lang.String getPop3Password()
Gets the POP3 password.
void setPop3Password(java.lang.String pop3Password)
Sets the POP3 login password.
Call EmailSettingService.saveNotificationSettings(settings)
to persist to the database.
pop3Password
- A password.boolean isReadPop3MailboxEnabled()
Gets the POP3 inbox reader enable flag.
void setReadPop3MailboxEnabled(boolean readPop3Mailbox)
Sets the POP3 inbox reader enabled flag.
Call EmailSettingService.saveNotificationSettings(settings)
to persist to the database.
readPop3Mailbox
- True to enable POP3 reading; false to disable POP3 reading.boolean isSendingEmailEnabled()
Gets the flag determining if SMTP email sending is enabled or not.
void setSendingEmailEnabled(boolean sendTaskEmail)
Sets the flag to enable or disable sending of SMTP email.
Call EmailSettingService.saveNotificationSettings(settings)
to persist to the database.
sendTaskEmail
- True to enable sending of SMTP email; false to disable sending of SMTP email.long getPop3ReadInterval()
Gets the frequency for checking the POP3 inbox for new messages.
void setPop3ReadInterval(long pop3ReadInterval)
Sets the frequency for checking the POP3 inbox for new messages.
Call EmailSettingService.saveNotificationSettings(settings)
to persist to the database.
pop3ReadInterval
- The interval frequency in milliseconds.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |