|
Oracle Mail Java API Reference 10g Release 1 (10.1.2) B25457-01 |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.mail.Service | +--javax.mail.Store | +--oracle.mail.sdk.esmail.OracleStore
This class implements an OracleStore.
When a user connects to the Oracle mail store, the user will be authenticated. From the store, the user can get a folder by name, get the default folder (user's namespace) or the list of shared folders. We are assuming that the shared namespace is anything that does not match /user.
The following properties need to be set before calling the connect method: oracle.mail.ldap.admin_dn cn=umadmin,cn=emailservercontainer,cn=products,cn=oraclecontext oracle.mail.ldap.admin_password {password} OR oracle.mail.ldap.admin_dn cn=orcladmin oracle.mail.ldap.admin_password {password}
OR In the IAS environment, If the oracle.mail.ldap.oracle_home property is set, then the connect method may be used by setting the hostname to null and port to -1.
Constructor Summary | |
OracleStore(javax.mail.Session session, javax.mail.URLName aURL) Constructor Parameters: session - Session object for this Store. |
Method Summary | |
void |
close() Use this method to get folder by name |
void |
closed(javax.mail.event.ConnectionEvent e) |
void |
connect(oracle.mail.OESContext aOESContext) Use this method to connect to a store. |
void |
connect(oracle.mail.OESLoginContext aOESLoginContext) Deprecated. - Using OESLoginContext in connect method no longer supported. Parameters: aOESLoginContext - expect an authenticated context |
void |
connect(oracle.mail.OESUser aOESUser) Use this method to connect to a store. |
void |
connect(java.lang.String ldapHost, int ldapPort, java.lang.String User, java.lang.String password) Use this method to connect to a store Parameters: ldapHost - LDAP Host Name ldapPort - LDAP Port user - User@Domain password - Password |
void |
connect(java.lang.String ldapHost, java.lang.String user, java.lang.String password) Use this method to connect to a store |
void |
disconnected(javax.mail.event.ConnectionEvent e) |
void |
fake_connect(java.lang.String aUser, OracleUserConnectInfo aFolderConnectInfo) |
javax.mail.Folder |
getDefaultFolder() |
javax.mail.Folder |
getFolder(java.lang.String name) Use this method to get folder by name |
javax.mail.Folder |
getFolder(javax.mail.URLName uRLName) Use this method to get folder by name |
OracleUserConnectInfo |
getFolderConnectInfo(java.lang.String nameSpace) |
long |
getLastUIDL() This method returns the Unique Identifier validity value of the last created mailbox of the user. |
long |
getLongUsage() Get usage for the user. |
javax.mail.Folder[] |
getPublicNamespaces() OracleStore.getPublicNamespaces() |
long |
getQuota() Get quota for the user. |
javax.mail.Folder[] |
getSharedNamespaces() |
javax.mail.Folder[] |
getSharedNamespaces(boolean listPublicAndShared) Deprecated. Use setSharedAndPublic(boolean) method to set the flag and call getSharedNamespaces() |
int |
getUsage() Deprecated. OJMA deprecate method "public int getUsage()" |
boolean |
isConnected() Use this method to get folder by name |
boolean |
isSharedAndPublic() This method returns the current state of flag which is used to determine if both shared and public namespaces or only the shared namespaces are to be returned. |
OracleEsProfile[] |
listProfile() List the existing wireless profiles for this user. |
void |
opened(javax.mail.event.ConnectionEvent e) |
javax.mail.Message[] |
search(javax.mail.search.SearchTerm term) Get the search results for all the users folders. |
javax.mail.Message[] |
search(java.lang.String searchString) Get the search results for all the users folders. |
void |
setCurrentProfile(java.lang.String aProfileStr) Set the current profile. |
void |
setSharedAndPublic(boolean flag) If the flag is set to true, subsequent calls to getSharedNamespaces() will return both shared and public namespaces. |
Methods inherited from class javax.mail.Store |
addFolderListener, addStoreListener, getPersonalNamespaces, getUserNamespaces, removeFolderListener, removeStoreListener |
Methods inherited from class javax.mail.Service |
addConnectionListener, connect, getURLName, removeConnectionListener, toString |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public OracleStore(javax.mail.Session session, javax.mail.URLName aURL)
Constructor
Parameters:
session - Session object for this Store. url - URL Name object to be used for this store.
Method Detail |
public javax.mail.Folder getDefaultFolder() throws javax.mail.MessagingException
public javax.mail.Folder getFolder(java.lang.String name) throws javax.mail.MessagingException
Use this method to get folder by name
NOTE: The INBOX is case-sensitive, all caps. In addition, creation or deletion of any folder with the name inbox is not allowed.public javax.mail.Folder getFolder(javax.mail.URLName uRLName) throws javax.mail.MessagingException
Use this method to get folder by name
public javax.mail.Folder[] getSharedNamespaces(boolean listPublicAndShared)
Retrieve a list of shared namespaces
listPublicAndShared
- - By default, set to false. Only shared folders are listed. To list both shared and public, set to truepublic javax.mail.Folder[] getSharedNamespaces()
public void setSharedAndPublic(boolean flag)
public boolean isSharedAndPublic()
public boolean isConnected()
Use this method to get folder by name
public void close()
Use this method to get folder by name
public OracleUserConnectInfo getFolderConnectInfo(java.lang.String nameSpace)
public javax.mail.Folder[] getPublicNamespaces()
public void connect(java.lang.String ldapHost, java.lang.String user, java.lang.String password) throws javax.mail.MessagingException
Use this method to connect to a store
public void connect(java.lang.String ldapHost, int ldapPort, java.lang.String User, java.lang.String password) throws javax.mail.MessagingException
Use this method to connect to a store
Parameters:
ldapHost - LDAP Host Name ldapPort - LDAP Port user - User@Domain password - Password
public void connect(oracle.mail.OESContext aOESContext)
Use this method to connect to a store. This is a method specific to OracleStore. An authenticated user's login context should be passed in.
public void connect(oracle.mail.OESLoginContext aOESLoginContext)
Use this method to connect to a store. This is a method specific to OracleStore. An authenticated user's login context should be passed in.
public void connect(oracle.mail.OESUser aOESUser)
Use this method to connect to a store. This is a method specific to OracleStore. An authenticated user should be passed in.
public void closed(javax.mail.event.ConnectionEvent e)
public void disconnected(javax.mail.event.ConnectionEvent e)
public void opened(javax.mail.event.ConnectionEvent e)
public OracleEsProfile[] listProfile() throws java.lang.Exception
List the existing wireless profiles for this user.
public long getQuota() throws javax.mail.MessagingException
Get quota for the user. Throws exception if user has not been authenticated
Parameters: None.
public int getUsage() throws javax.mail.MessagingException
Get usage for the user. Throws exception if user has not been authenticated
Parameters: None.
public long getLongUsage() throws javax.mail.MessagingException
Get usage for the user. Throws exception if user has not been authenticated
Parameters: None.
public void setCurrentProfile(java.lang.String aProfileStr) throws javax.mail.MessagingException
public javax.mail.Message[] search(java.lang.String searchString) throws javax.mail.MessagingException
Get the search results for all the users folders. This api returs a array of message objects. Folder operations on folders obtained from the message objects will give inconsistent results and will not be supported. Throws exception if user has not been authenticated
Parameters: searchString - IMAP style search string
public javax.mail.Message[] search(javax.mail.search.SearchTerm term) throws javax.mail.MessagingException
Get the search results for all the users folders. This api returs a array of message objects. Folder operations on folders obtained from the message objects will give inconsistent results and will not be supported. Throws exception if user has not been authenticated
Parameters: term - javax.mail.search.SearchTerm
public void fake_connect(java.lang.String aUser, OracleUserConnectInfo aFolderConnectInfo) throws javax.mail.MessagingException
public long getLastUIDL()
This method returns the Unique Identifier validity value of the last created mailbox of the user.
|
Oracle Mail Java API Reference 10g Release 1 (10.1.2) B25457-01 |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |