oracle.mail
Class OESUser

java.lang.Object
  |
  +--oracle.mail.OESUser

public class OESUser

extends java.lang.Object

The OES User stores preferences and data for an Email user. Additionally, it enable operations to be performed on an Email user. Instead of using the class constructor, please get OES Users from the OESUserFactory. Sample code to get and OESUser: <quote>OCSUserFactory ocsUserFactory = OCSUserFactory.getInstance();
OCSUser ocsUser = userFactory.getOCSUserFromDN...
OESUserFactory oesUserFactory = OESUserFactory.getInstance();
OESUser oesUser = oesUserFactory.getOESUser...</quote>

Method Summary

ESDSDirServerAccess	getDirectoryAccess() This method returns an authenticated handle to the email LDAP tree.
ESDSContext	getDirectoryContext() This method returns an authenticated email LDAP context.
oracle.mail.user.EmailUserPrefs	getEmailUserPrefs() Get Email User Preferences
javax.mail.Store	getIMAPStore(java.lang.String IMAPHostname, int IMAPPort, java.lang.String user, java.lang.String password) This method returns an authenticated Oracle Email store.
javax.mail.Session	getSession() Return the current mail session
javax.mail.Store	getStore() This method returns an authenticated Oracle Email store.
java.lang.String	getUserDomain() This method returns the domain for the user
java.lang.String	getUserName() This method returns the username
boolean	isAuthenticated() Method to check if the OES user is authenticated.
boolean	isFolderExist(java.lang.String folder) Check if a folder exists for this user.
void	release() release resources for OESUser

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isAuthenticated

public boolean isAuthenticated()

Method to check if the OES user is authenticated.

Returns:

boolean

getDirectoryAccess

public ESDSDirServerAccess getDirectoryAccess()

This method returns an authenticated handle to the email LDAP tree.

Parameters:

None -

Returns:

ESDSDirServerAccess - provides acess to directory services

getDirectoryContext

public ESDSContext getDirectoryContext()

This method returns an authenticated email LDAP context.

Parameters:

None -

Returns:

ESDSContext - provides acess to directory context

getUserDomain

public java.lang.String getUserDomain()

This method returns the domain for the user

Parameters:

None -

Returns:

String domain - the email domain for the user

getUserName

public java.lang.String getUserName()

This method returns the username

Parameters:

None -

Returns:

String - the email user

getStore

public javax.mail.Store getStore()
                          throws java.lang.Exception

This method returns an authenticated Oracle Email store.

Parameters:

None -

Returns:

authenticated Oracle Email Store

getSession

public javax.mail.Session getSession()

Return the current mail session

Returns:

the current mail session

getIMAPStore

public javax.mail.Store getIMAPStore(java.lang.String IMAPHostname,
                                     int IMAPPort,
                                     java.lang.String user,
                                     java.lang.String password)
                              throws java.lang.Exception

This method returns an authenticated Oracle Email store.

Parameters:

IMAPHostname - - IMAP server, IMAPPort - IMAP port, user - user's email address, password - password

Returns:

authenticated Oracle Email Store

getEmailUserPrefs

public oracle.mail.user.EmailUserPrefs getEmailUserPrefs()
                                                  throws java.lang.Exception

Get Email User Preferences

Throws:

java.lang.Exception - if error occurs in ESDS when looking up Email user preferences for initialization.

isFolderExist

public boolean isFolderExist(java.lang.String folder)
                      throws java.lang.Exception

Check if a folder exists for this user.

Throws:

java.lang.Exception - if error occurs.

release

public void release()

release resources for OESUser