Skip navigation links

oracle.ocsg.plugin.multimediamessaging.email.management
Interface EmailManagementMBean

public interface EmailManagementMBean

Field Summary

static boolean	debug
static String	imapHost
static int	imapPollingInterval
static String	imapPort
static boolean	imapSSLRequired
static String	pop3Host
static int	pop3PollingInterval
static String	pop3Port
static boolean	pop3SSLRequired
static String	receiveProtocol
static boolean	smtpAuth
static String	smtpHost
static int	smtpInitConnectionNumber
static int	smtpMaxConnectionNumber
static int	smtpNoopInterval
static String	smtpPassWord
static String	smtpPort
static int	smtpReconnectInterval
static int	smtpRetryInterval
static int	smtpRetryNumber
static int	smtpSizeLimit
static boolean	smtpSSLRequired
static boolean	smtpStartTLS
static String	smtpUserName

Method Summary

void	activeImapConfig() Makes the modifications to IMAP take effect.
void	activeSmtpConfig() Makes the modification to SMTP-related attributes take effect.
String	enableReceiveEmail(String shortCode, String password, String criteria, String appInstanceID, int sizeLimit) Used to add an offline notification for applications that will poll for MO messages.
boolean	getDebug() Returns true if debug information is printed for SMTP/IMAP/POP3, false otherwise.
String	getImapHost() Returns the IMAP server address.
int	getImapPollingInterval() Returns the number of seconds in the polling interval for IMAP server.
String	getImapPort() Returns the IMAP server port.
boolean	getImapSSLRequired() Returns true if the IMAP server requires SSL, false otherwise.
String	getOfflineNotificationInfo(String correlator) Gets the notification associated with the specified correlator.
String	getOnlineNotificationInfo(String correlator) Gets the notification associated with the specified correlator.
String	getPop3Host() Returns the POP3 server address.
int	getPop3PollingInterval() Returns the number of seconds in the polling interval for POP3 server.
String	getPop3Port() Returns the POP3 server port.
boolean	getPop3SSLRequired() Returns true if the POP3 server requires SSL, false otherwise.
String	getReceiveProtocol() Returns the protocol used to receive email.
boolean	getSmtpAuth() Returns whether the SMTP server requires authentication.
String	getSmtpHost() Returns the address for the SMTP server.
int	getSmtpInitConnectionNumber() Returns the SMTP initial connection number.
int	getSmtpMaxConnectionNumber() Returns the maximum number of SMTP connections.
int	getSmtpNoopInterval() Returns the number of seconds in the heartbeat interval.
String	getSmtpPassWord() Returns the password for the SMTP server.
String	getSmtpPort() Returns the port for the SMTP server.
int	getSmtpReconnectInterval() Returns the number of seconds between the reconnection attempts.
int	getSmtpRetryInterval() Returns the number of seconds between the retries for a request.
int	getSmtpRetryNumber() Returns the number of retries.
int	getSmtpSizeLimit() Returns SMTP size limit.
boolean	getSmtpSSLRequired() Returns whether the SMTP server requires SSL.
boolean	getSmtpStartTLS() Returns whether the SMTP server requires TLS.
String	getSmtpUserName() Returns the user name for the SMTP server.
String[]	listImapProcess()
String[]	listOfflineNotificationInfo()
String[]	listOnlineNotificationInfo()
String[]	listPop3Process()
String[]	listSmtpConnection()
void	removeOfflineNotificationInfo(String registrationIdentifier) Removes an offline notification that was added using the OAM enableReceiveEmail method.
void	removeOnlineNotificationInfo(String correlator) Removes the specified online notification that was added using OAM interfaces or application interfaces (startMessageNotification).
void	setDebug(boolean value) If true, debug information is printed for SMTP/IMAP/POP, if false no debug information.
void	setImapHost(String value) Sets the IMAP server address.
void	setImapPollingInterval(int value) Sets the number of seconds in the polling interval for IMAP server.
void	setImapPort(String value) Sets the IMAP server port.
void	setImapSSLRequired(boolean value) Set to true to require SSL for the IMAP server, false otherwise.
void	setPop3Host(String value) Sets the POP3 server address.
void	setPop3PollingInterval(int value) Sets the number of seconds in the polling interval for POP3 server.
void	setPop3Port(String value) Sets the POP3 server port.
void	setPop3SSLRequired(boolean value) Set to true to require SSL for the POP3 server, false otherwise.
void	setReceiveProtocol(String value) Sets the protocol used to receive email, either POP3 or IMAP.
void	setSmtpAuth(boolean value) Specifies if the SMTP server requires authentication.
void	setSmtpHost(String value) Specifies the address for the SMTP server.
void	setSmtpInitConnectionNumber(int value) Sets the SMTP initial connection number.
void	setSmtpMaxConnectionNumber(int value) Sets the maximum number of SMTP connections.
void	setSmtpNoopInterval(int value) Sets the number of seconds in the heartbeat interval.
void	setSmtpPassWord(String value) Specifies the password for the SMTP server.
void	setSmtpPort(String value) Specifies the port for the SMTP server.
void	setSmtpReconnectInterval(int value) Sets the number of seconds between the reconnection attempts.
void	setSmtpRetryInterval(int value) Sets the number of seconds between the retries for a request.
void	setSmtpRetryNumber(int value) Sets the number of retries.
void	setSmtpSizeLimit(int value) Sets SMTP size limit.
void	setSmtpSSLRequired(boolean value) Specifies if the SMTP server requires SSL.
void	setSmtpStartTLS(boolean value) Specifies if the SMTP server requires TLS.
void	setSmtpUserName(String value) Specifies the user name for the SMTP server.
String	startEmailNotification(String endpoint, String shortCode, String password, String criteria, String appInstanceID, int sizeLimit) Adds an online notification for applications that for some reason can not (or are not allowed) call the startMessageNotification method.

Field Detail

debug

public static final boolean debug

See Also:

Constant Field Values

imapHost

public static final String imapHost

See Also:

Constant Field Values

imapPollingInterval

public static final int imapPollingInterval

See Also:

Constant Field Values

imapPort

public static final String imapPort

See Also:

Constant Field Values

imapSSLRequired

public static final boolean imapSSLRequired

See Also:

Constant Field Values

pop3Host

public static final String pop3Host

See Also:

Constant Field Values

pop3PollingInterval

public static final int pop3PollingInterval

See Also:

Constant Field Values

pop3Port

public static final String pop3Port

See Also:

Constant Field Values

pop3SSLRequired

public static final boolean pop3SSLRequired

See Also:

Constant Field Values

receiveProtocol

public static final String receiveProtocol

See Also:

Constant Field Values

smtpAuth

public static final boolean smtpAuth

See Also:

Constant Field Values

smtpHost

public static final String smtpHost

See Also:

Constant Field Values

smtpInitConnectionNumber

public static final int smtpInitConnectionNumber

See Also:

Constant Field Values

smtpMaxConnectionNumber

public static final int smtpMaxConnectionNumber

See Also:

Constant Field Values

smtpNoopInterval

public static final int smtpNoopInterval

See Also:

Constant Field Values

smtpPassWord

public static final String smtpPassWord

See Also:

Constant Field Values

smtpPort

public static final String smtpPort

See Also:

Constant Field Values

smtpReconnectInterval

public static final int smtpReconnectInterval

See Also:

Constant Field Values

smtpRetryInterval

public static final int smtpRetryInterval

See Also:

Constant Field Values

smtpRetryNumber

public static final int smtpRetryNumber

See Also:

Constant Field Values

smtpSizeLimit

public static final int smtpSizeLimit

See Also:

Constant Field Values

smtpSSLRequired

public static final boolean smtpSSLRequired

See Also:

Constant Field Values

smtpStartTLS

public static final boolean smtpStartTLS

See Also:

Constant Field Values

smtpUserName

public static final String smtpUserName

See Also:

Constant Field Values

Method Detail

activeImapConfig

public void activeImapConfig()

Makes the modifications to IMAP take effect.

Scope: Local

activeSmtpConfig

public void activeSmtpConfig()

Makes the modification to SMTP-related attributes take effect. This method should be invoked after the following attributes are modified:

• smtpUserName
• smtpPassword
• smtpHost
• smtpPort
• smtpAuth
• smtpSslRequired
• smtpStartTls

Scope: Local

enableReceiveEmail

public String enableReceiveEmail(String shortCode,
                                 String password,
                                 String criteria,
                                 String appInstanceID,
                                 int sizeLimit)
                          throws ManagementException

Used to add an offline notification for applications that will poll for MO messages. MO messages matching this notification will not result in a callback to an application; the application has to use the correlator returned by this method and poll for new messages.

Scope: Cluster

Parameters:

shortCode - The destination address/service activation number of the email account, such as email:abc@example.com.

password - The credential of the email account.

criteria - The text to match against to determine the application to receive the notification.

appInstanceID - The applicationInstanceID to associate with this notification.

Returns:

Returns the correlator uniquely identifying the new notification (known as 'registrationIdentifier' in Parlay X)

Throws:

ManagementException

getDebug

public boolean getDebug()
                 throws ManagementException

Returns true if debug information is printed for SMTP/IMAP/POP3, false otherwise.

Scope: Cluster

Returns:

true if debug information is printed for SMTP/IMAP/POP3, false otherwise

Throws:

ManagementException

getImapHost

public String getImapHost()
                   throws ManagementException

Returns the IMAP server address.

Scope: Cluster

Returns:

the IMAP server address

Throws:

ManagementException

getImapPollingInterval

public int getImapPollingInterval()
                           throws ManagementException

Returns the number of seconds in the polling interval for IMAP server.

Scope: Cluster

Returns:

the number of seconds in the polling interval for IMAP server

Throws:

ManagementException

getImapPort

public String getImapPort()
                   throws ManagementException

Returns the IMAP server port.

Scope: Cluster

Returns:

the IMAP server port

Throws:

ManagementException

getImapSSLRequired

public boolean getImapSSLRequired()
                           throws ManagementException

Returns true if the IMAP server requires SSL, false otherwise.

Scope: Cluster

Returns:

true if the IMAP server requires SSL, false otherwise

Throws:

ManagementException

getOfflineNotificationInfo

public String getOfflineNotificationInfo(String correlator)
                                  throws ManagementException

Gets the notification associated with the specified correlator. An offline notification is a notification that has been added using the OAM enableReceiveEmail method.

Scope: Cluster

Throws:

ManagementException

getOnlineNotificationInfo

public String getOnlineNotificationInfo(String correlator)
                                 throws ManagementException

Gets the notification associated with the specified correlator. An online notification is a notification that has been added using startEmailNotification, through OAM interfaces or through an application interface.

Scope: Cluster

Throws:

ManagementException

getPop3Host

public String getPop3Host()
                   throws ManagementException

Returns the POP3 server address.

Scope: Cluster

Returns:

the POP3 server address

Throws:

ManagementException

getPop3PollingInterval

public int getPop3PollingInterval()
                           throws ManagementException

Returns the number of seconds in the polling interval for POP3 server.

Scope: Cluster

Returns:

the number of seconds in the polling interval for POP3 server

Throws:

ManagementException

getPop3Port

public String getPop3Port()
                   throws ManagementException

Returns the POP3 server port.

Scope: Cluster

Returns:

the POP3 server port

Throws:

ManagementException

getPop3SSLRequired

public boolean getPop3SSLRequired()
                           throws ManagementException

Returns true if the POP3 server requires SSL, false otherwise.

Scope: Cluster

Returns:

true if the POP3 server requires SSL, false otherwise

Throws:

ManagementException

getReceiveProtocol

public String getReceiveProtocol()
                          throws ManagementException

Returns the protocol used to receive email.

Scope: Cluster

Returns:

the protocol used to receive email

Throws:

ManagementException

getSmtpAuth

public boolean getSmtpAuth()
                    throws ManagementException

Returns whether the SMTP server requires authentication.

Scope: Cluster

Returns:

true if authentication required, false otherwise

Throws:

ManagementException

getSmtpHost

public String getSmtpHost()
                   throws ManagementException

Returns the address for the SMTP server.

Scope: Cluster

Returns:

SMTP server address

Throws:

ManagementException

getSmtpInitConnectionNumber

public int getSmtpInitConnectionNumber()
                                throws ManagementException

Returns the SMTP initial connection number.

Scope: Cluster

Returns:

the SMTP initial connection number

Throws:

ManagementException

getSmtpMaxConnectionNumber

public int getSmtpMaxConnectionNumber()
                               throws ManagementException

Returns the maximum number of SMTP connections.

Scope: Cluster

Returns:

maximum number of SMTP connections

Throws:

ManagementException

getSmtpNoopInterval

public int getSmtpNoopInterval()
                        throws ManagementException

Returns the number of seconds in the heartbeat interval.

Scope: Cluster

Returns:

the number of seconds in the heartbeat interval

Throws:

ManagementException

getSmtpPassWord

public String getSmtpPassWord()
                       throws ManagementException

Returns the password for the SMTP server.

Scope: Cluster

Returns:

the password

Throws:

ManagementException

getSmtpPort

public String getSmtpPort()
                   throws ManagementException

Returns the port for the SMTP server.

Scope: Cluster

Returns:

SMTP server address

Throws:

ManagementException

getSmtpReconnectInterval

public int getSmtpReconnectInterval()
                             throws ManagementException

Returns the number of seconds between the reconnection attempts.

Scope: Cluster

Returns:

the number of seconds between the reconnection attempts

Throws:

ManagementException

getSmtpRetryInterval

public int getSmtpRetryInterval()
                         throws ManagementException

Returns the number of seconds between the retries for a request.

Scope: Cluster

Returns:

number of seconds between retries

Throws:

ManagementException

getSmtpRetryNumber

public int getSmtpRetryNumber()
                       throws ManagementException

Returns the number of retries.

Scope: Cluster

Returns:

number of retries

Throws:

ManagementException

getSmtpSizeLimit

public int getSmtpSizeLimit()
                     throws ManagementException

Returns SMTP size limit.

Scope: Cluster

Returns:

SMTP size limit

Throws:

ManagementException

getSmtpSSLRequired

public boolean getSmtpSSLRequired()
                           throws ManagementException

Returns whether the SMTP server requires SSL.

Scope: Cluster

Returns:

true if SSL required, false otherwise

Throws:

ManagementException

getSmtpStartTLS

public boolean getSmtpStartTLS()
                        throws ManagementException

Returns whether the SMTP server requires TLS.

Scope: Cluster

Returns:

true if SSL required, false otherwise

Throws:

ManagementException

getSmtpUserName

public String getSmtpUserName()
                       throws ManagementException

Returns the user name for the SMTP server.

Scope: Cluster

Returns:

the user name

Throws:

ManagementException

listImapProcess

public String[] listImapProcess()

listOfflineNotificationInfo

public String[] listOfflineNotificationInfo()
                                     throws ManagementException

Throws:

ManagementException

listOnlineNotificationInfo

public String[] listOnlineNotificationInfo()
                                    throws ManagementException

Throws:

ManagementException

listPop3Process

public String[] listPop3Process()

listSmtpConnection

public String[] listSmtpConnection()

removeOfflineNotificationInfo

public void removeOfflineNotificationInfo(String registrationIdentifier)
                                   throws ManagementException

Removes an offline notification that was added using the OAM enableReceiveEmail method.

Scope: Cluster

Parameters:

registrationIdentifier - registration identifier.

Throws:

ManagementException

removeOnlineNotificationInfo

public void removeOnlineNotificationInfo(String correlator)
                                  throws ManagementException

Removes the specified online notification that was added using OAM interfaces or application interfaces (startMessageNotification).

Scope: Cluster

Parameters:

correlator - uniquely identifying the notification to be removed.

Throws:

ManagementException

setDebug

public void setDebug(boolean value)
              throws ManagementException

If true, debug information is printed for SMTP/IMAP/POP, if false no debug information.

Scope: Cluster

Parameters:

value - true to print debug information, false to not print debug information

Throws:

ManagementException

setImapHost

public void setImapHost(String value)
                 throws ManagementException

Sets the IMAP server address.

Scope: Cluster

Parameters:

value - the IMAP server address

Throws:

ManagementException

setImapPollingInterval

public void setImapPollingInterval(int value)
                            throws ManagementException

Sets the number of seconds in the polling interval for IMAP server. Default is 120.

Scope: Cluster

Parameters:

value - the number of seconds in the polling interval for IMAP server

Throws:

ManagementException

setImapPort

public void setImapPort(String value)
                 throws ManagementException

Sets the IMAP server port.

Scope: Cluster

Parameters:

value - the IMAP server port

Throws:

ManagementException

setImapSSLRequired

public void setImapSSLRequired(boolean value)
                        throws ManagementException

Set to true to require SSL for the IMAP server, false otherwise.

Scope: Cluster

Parameters:

value - true to require SSL for the IMAP server, false otherwise

Throws:

ManagementException

setPop3Host

public void setPop3Host(String value)
                 throws ManagementException

Sets the POP3 server address.

Scope: Cluster

Parameters:

value - the POP3 server address

Throws:

ManagementException

setPop3PollingInterval

public void setPop3PollingInterval(int value)
                            throws ManagementException

Sets the number of seconds in the polling interval for POP3 server. Default is 120.

Scope: Cluster

Parameters:

value - the number of seconds in the polling interval for POP3 server

Throws:

ManagementException

setPop3Port

public void setPop3Port(String value)
                 throws ManagementException

Sets the POP3 server port.

Scope: Cluster

Parameters:

value - the POP3 server port

Throws:

ManagementException

setPop3SSLRequired

public void setPop3SSLRequired(boolean value)
                        throws ManagementException

Set to true to require SSL for the POP3 server, false otherwise.

Scope: Cluster

Parameters:

value - true to require SSL for the POP3 server, false otherwise

Throws:

ManagementException

setReceiveProtocol

public void setReceiveProtocol(String value)
                        throws ManagementException

Sets the protocol used to receive email, either POP3 or IMAP. Default is IMAP.

Scope: Cluster

Parameters:

value - the protocol used to receive email, either POP3 or IMAP

Throws:

ManagementException

setSmtpAuth

public void setSmtpAuth(boolean value)
                 throws ManagementException

Specifies if the SMTP server requires authentication. Set to true to use authentication, otherwise false.

Scope: Cluster

Parameters:

value - true for authentication, false otherwise

Throws:

ManagementException

setSmtpHost

public void setSmtpHost(String value)
                 throws ManagementException

Specifies the address for the SMTP server.

Scope: Cluster

Parameters:

value - SMTP host address

Throws:

ManagementException

setSmtpInitConnectionNumber

public void setSmtpInitConnectionNumber(int value)
                                 throws ManagementException

Sets the SMTP initial connection number. Default is 1.

Scope: Cluster

Parameters:

value - the SMTP initial connection number

Throws:

ManagementException

setSmtpMaxConnectionNumber

public void setSmtpMaxConnectionNumber(int value)
                                throws ManagementException

Sets the maximum number of SMTP connections. Default is 16.

Scope: Cluster

Parameters:

value - maximum number of SMTP connections

Throws:

ManagementException

setSmtpNoopInterval

public void setSmtpNoopInterval(int value)
                         throws ManagementException

Sets the number of seconds in the heartbeat interval. Default is 300.

Scope: Cluster

Parameters:

value - the number of seconds in the heartbeat interval

Throws:

ManagementException

setSmtpPassWord

public void setSmtpPassWord(String value)
                     throws ManagementException

Specifies the password for the SMTP server.

Scope: Cluster

Parameters:

value - password

Throws:

ManagementException

setSmtpPort

public void setSmtpPort(String value)
                 throws ManagementException

Specifies the port for the SMTP server.

Scope: Cluster

Parameters:

value - SMTP host port

Throws:

ManagementException

setSmtpReconnectInterval

public void setSmtpReconnectInterval(int value)
                              throws ManagementException

Sets the number of seconds between the reconnection attempts. Default is 60.

Scope: Cluster

Parameters:

value - the number of seconds between the reconnection attempts

Throws:

ManagementException

setSmtpRetryInterval

public void setSmtpRetryInterval(int value)
                          throws ManagementException

Sets the number of seconds between the retries for a request. Default is 300.

Scope: Cluster

Parameters:

value - number of seconds between retries

Throws:

ManagementException

setSmtpRetryNumber

public void setSmtpRetryNumber(int value)
                        throws ManagementException

Sets the number of retries. Default is 3.

Scope: Cluster

Parameters:

value - number of retries

Throws:

ManagementException

setSmtpSizeLimit

public void setSmtpSizeLimit(int value)
                      throws ManagementException

Sets SMTP size limit. Default is 0.

Scope: Cluster

Parameters:

value - SMTP size limit

Throws:

ManagementException

setSmtpSSLRequired

public void setSmtpSSLRequired(boolean value)
                        throws ManagementException

Specifies if the SMTP server requires SSL. Set to true to use SSL, otherwise false.

Scope: Cluster

Parameters:

value - true for SSL, false otherwise

Throws:

ManagementException

setSmtpStartTLS

public void setSmtpStartTLS(boolean value)
                     throws ManagementException

Specifies if the SMTP server requires TLS. Set to true to use TLS, otherwise false.

Scope: Cluster

Parameters:

value - true for SSL, false otherwise

Throws:

ManagementException

setSmtpUserName

public void setSmtpUserName(String value)
                     throws ManagementException

Specifies the user name for the SMTP server.

Scope: Cluster

Parameters:

value - user name

Throws:

ManagementException

startEmailNotification

public String startEmailNotification(String endpoint,
                                     String shortCode,
                                     String password,
                                     String criteria,
                                     String appInstanceID,
                                     int sizeLimit)
                              throws ManagementException

Adds an online notification for applications that for some reason can not (or are not allowed) call the startMessageNotification method.

Scope: Cluster

Parameters:

endpoint - The notification endpoint.

shortCode - The destination address/service activation number of the email account, such as email:abc@example.com.

password - The credential of the email account.

criteria - The text to match against to determine the application to receive the notification.

appInstanceID - The applicationInstanceID to associate with this notification.

Returns:

Returns the correlator uniquely identifying the new notification.

Throws:

ManagementException

Skip navigation links