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()
void	activeSmtpConfig()
String	enableReceiveEmail(String shortCode, String password, String criteria, String appInstanceID, int sizeLimit) This method is used to add an offline notification for applications that will poll for MO messages.
boolean	getDebug()
String	getImapHost()
int	getImapPollingInterval()
String	getImapPort()
boolean	getImapSSLRequired()
String	getOfflineNotificationInfo(String correlator) Get the notification associated with the specified correlator.
String	getOnlineNotificationInfo(String correlator) Get the notification associated with the specified correlator.
String	getPop3Host()
int	getPop3PollingInterval()
String	getPop3Port()
boolean	getPop3SSLRequired()
String	getReceiveProtocol()
boolean	getSmtpAuth()
String	getSmtpHost()
int	getSmtpInitConnectionNumber()
int	getSmtpMaxConnectionNumber()
int	getSmtpNoopInterval()
String	getSmtpPassWord()
String	getSmtpPort()
int	getSmtpReconnectInterval()
int	getSmtpRetryInterval()
int	getSmtpRetryNumber()
int	getSmtpSizeLimit()
boolean	getSmtpSSLRequired()
boolean	getSmtpStartTLS()
String	getSmtpUserName()
String[]	listImapProcess()
String[]	listOfflineNotificationInfo()
String[]	listOnlineNotificationInfo()
String[]	listPop3Process()
String[]	listSmtpConnection()
void	removeOfflineNotificationInfo(String registrationIdentifier) Remove an offline notification that was added using the OAM enableReceiveEmail method
void	removeOnlineNotificationInfo(String correlator) Remove the specified online notification that was added using OAM interfaces or application interfaces (startMessageNotification).
void	setDebug(boolean value)
void	setImapHost(String value)
void	setImapPollingInterval(int value)
void	setImapPort(String value)
void	setImapSSLRequired(boolean value)
void	setPop3Host(String value)
void	setPop3PollingInterval(int value)
void	setPop3Port(String value)
void	setPop3SSLRequired(boolean value)
void	setReceiveProtocol(String value)
void	setSmtpAuth(boolean value)
void	setSmtpHost(String value)
void	setSmtpInitConnectionNumber(int value)
void	setSmtpMaxConnectionNumber(int value)
void	setSmtpNoopInterval(int value)
void	setSmtpPassWord(String value)
void	setSmtpPort(String value)
void	setSmtpReconnectInterval(int value)
void	setSmtpRetryInterval(int value)
void	setSmtpRetryNumber(int value)
void	setSmtpSizeLimit(int value)
void	setSmtpSSLRequired(boolean value)
void	setSmtpStartTLS(boolean value)
void	setSmtpUserName(String value)
String	startEmailNotification(String endpoint, String shortCode, String password, String criteria, String appInstanceID, int sizeLimit) Add 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()

activeSmtpConfig

public void activeSmtpConfig()

enableReceiveEmail

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

This method is 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.

Parameters:

shortCode - The destination address/service activation number of the email account, such as email:abc@oracle.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

Throws:

ManagementException

getImapHost

public String getImapHost()
                   throws ManagementException

Throws:

ManagementException

getImapPollingInterval

public int getImapPollingInterval()
                           throws ManagementException

Throws:

ManagementException

getImapPort

public String getImapPort()
                   throws ManagementException

Throws:

ManagementException

getImapSSLRequired

public boolean getImapSSLRequired()
                           throws ManagementException

Throws:

ManagementException

getOfflineNotificationInfo

public String getOfflineNotificationInfo(String correlator)
                                  throws ManagementException

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

Throws:

ManagementException

getOnlineNotificationInfo

public String getOnlineNotificationInfo(String correlator)
                                 throws ManagementException

Get 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.

Throws:

ManagementException

getPop3Host

public String getPop3Host()
                   throws ManagementException

Throws:

ManagementException

getPop3PollingInterval

public int getPop3PollingInterval()
                           throws ManagementException

Throws:

ManagementException

getPop3Port

public String getPop3Port()
                   throws ManagementException

Throws:

ManagementException

getPop3SSLRequired

public boolean getPop3SSLRequired()
                           throws ManagementException

Throws:

ManagementException

getReceiveProtocol

public String getReceiveProtocol()
                          throws ManagementException

Throws:

ManagementException

getSmtpAuth

public boolean getSmtpAuth()
                    throws ManagementException

Throws:

ManagementException

getSmtpHost

public String getSmtpHost()
                   throws ManagementException

Throws:

ManagementException

getSmtpInitConnectionNumber

public int getSmtpInitConnectionNumber()
                                throws ManagementException

Throws:

ManagementException

getSmtpMaxConnectionNumber

public int getSmtpMaxConnectionNumber()
                               throws ManagementException

Throws:

ManagementException

getSmtpNoopInterval

public int getSmtpNoopInterval()
                        throws ManagementException

Throws:

ManagementException

getSmtpPassWord

public String getSmtpPassWord()
                       throws ManagementException

Throws:

ManagementException

getSmtpPort

public String getSmtpPort()
                   throws ManagementException

Throws:

ManagementException

getSmtpReconnectInterval

public int getSmtpReconnectInterval()
                             throws ManagementException

Throws:

ManagementException

getSmtpRetryInterval

public int getSmtpRetryInterval()
                         throws ManagementException

Throws:

ManagementException

getSmtpRetryNumber

public int getSmtpRetryNumber()
                       throws ManagementException

Throws:

ManagementException

getSmtpSizeLimit

public int getSmtpSizeLimit()
                     throws ManagementException

Throws:

ManagementException

getSmtpSSLRequired

public boolean getSmtpSSLRequired()
                           throws ManagementException

Throws:

ManagementException

getSmtpStartTLS

public boolean getSmtpStartTLS()
                        throws ManagementException

Throws:

ManagementException

getSmtpUserName

public String getSmtpUserName()
                       throws ManagementException

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

Remove an offline notification that was added using the OAM enableReceiveEmail method

Parameters:

registrationIdentifier - registration identifier

Throws:

ManagementException

removeOnlineNotificationInfo

public void removeOnlineNotificationInfo(String correlator)
                                  throws ManagementException

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

Parameters:

correlator -

Throws:

ManagementException

setDebug

public void setDebug(boolean value)
              throws ManagementException

Throws:

ManagementException

setImapHost

public void setImapHost(String value)
                 throws ManagementException

Throws:

ManagementException

setImapPollingInterval

public void setImapPollingInterval(int value)
                            throws ManagementException

Throws:

ManagementException

setImapPort

public void setImapPort(String value)
                 throws ManagementException

Throws:

ManagementException

setImapSSLRequired

public void setImapSSLRequired(boolean value)
                        throws ManagementException

Throws:

ManagementException

setPop3Host

public void setPop3Host(String value)
                 throws ManagementException

Throws:

ManagementException

setPop3PollingInterval

public void setPop3PollingInterval(int value)
                            throws ManagementException

Throws:

ManagementException

setPop3Port

public void setPop3Port(String value)
                 throws ManagementException

Throws:

ManagementException

setPop3SSLRequired

public void setPop3SSLRequired(boolean value)
                        throws ManagementException

Throws:

ManagementException

setReceiveProtocol

public void setReceiveProtocol(String value)
                        throws ManagementException

Throws:

ManagementException

setSmtpAuth

public void setSmtpAuth(boolean value)
                 throws ManagementException

Throws:

ManagementException

setSmtpHost

public void setSmtpHost(String value)
                 throws ManagementException

Throws:

ManagementException

setSmtpInitConnectionNumber

public void setSmtpInitConnectionNumber(int value)
                                 throws ManagementException

Throws:

ManagementException

setSmtpMaxConnectionNumber

public void setSmtpMaxConnectionNumber(int value)
                                throws ManagementException

Throws:

ManagementException

setSmtpNoopInterval

public void setSmtpNoopInterval(int value)
                         throws ManagementException

Throws:

ManagementException

setSmtpPassWord

public void setSmtpPassWord(String value)
                     throws ManagementException

Throws:

ManagementException

setSmtpPort

public void setSmtpPort(String value)
                 throws ManagementException

Throws:

ManagementException

setSmtpReconnectInterval

public void setSmtpReconnectInterval(int value)
                              throws ManagementException

Throws:

ManagementException

setSmtpRetryInterval

public void setSmtpRetryInterval(int value)
                          throws ManagementException

Throws:

ManagementException

setSmtpRetryNumber

public void setSmtpRetryNumber(int value)
                        throws ManagementException

Throws:

ManagementException

setSmtpSizeLimit

public void setSmtpSizeLimit(int value)
                      throws ManagementException

Throws:

ManagementException

setSmtpSSLRequired

public void setSmtpSSLRequired(boolean value)
                        throws ManagementException

Throws:

ManagementException

setSmtpStartTLS

public void setSmtpStartTLS(boolean value)
                     throws ManagementException

Throws:

ManagementException

setSmtpUserName

public void setSmtpUserName(String value)
                     throws ManagementException

Throws:

ManagementException

startEmailNotification

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

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

Parameters:

endpoint - The notification endpoint

shortCode - The destination address/service activation number of the email account, such as email:abc@oracle.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