de.uplanet.lucy.server.businesslogic.exchange.util
Interface IExchangeMailboxUtil

All Known Implementing Classes:
ExchangeMailboxUtil

@Scriptable
public interface IExchangeMailboxUtil

Defines utility methods for working with MS Exchange mailbox settings.

Version:
$Revision: 89488 $

Method Summary
 java.lang.String createFolder(java.lang.String p_strParentHref, java.lang.String p_strFolderName, java.lang.String p_strContentClass)
          Creates a new folder.
 boolean deleteFolder(java.lang.String p_strId, boolean p_bPurgeFolder)
          Deletes a folder identified by ID.
 java.lang.String getCalendarFolderHref(java.lang.String p_strUserMailbox)
          Returns the folder HREF value.
 java.lang.String getCalendarFolderName(java.lang.String p_strUserMailbox)
          Returns the language dependent folder name.
 java.lang.String getContactsFolderHref(java.lang.String p_strUserMailbox)
          Returns the folder HREF value.
 java.lang.String getContactsFolderName(java.lang.String p_strUserMailbox)
          Returns the language dependent folder name.
 java.lang.String getDeletedItemsFolderHref(java.lang.String p_strUserMailbox)
          Returns the folder HREF value.
 java.lang.String getDeletedItemsFolderName(java.lang.String p_strUserMailbox)
          Returns the language dependent folder name.
 java.lang.String getDraftsFolderHref(java.lang.String p_strUserMailbox)
          Returns the folder HREF value.
 java.lang.String getDraftsFolderName(java.lang.String p_strUserMailbox)
          Returns the language dependent folder name.
 IFolderInfo getFolderInfoByHref(java.lang.String p_strFolderHref)
          Returns an ExchangeFolderInfo instance with the folder properties.
 IFolderInfo getFolderInfoById(java.lang.String p_strFolderId)
          Returns an ExchangeFolderInfo instance with the folder properties.
 java.util.List<IFolderInfo> getFolders()
          Returns a list of IFolderInfo instances for all folders.
 ExchangeAccount getImpersonateUserAccount(java.lang.String p_strUserGuid)
          Returns Exchange account properties for the given impersonate user.
 ExchangeAccount getImpersonateUserAccount(java.lang.String p_strUserGuid, java.lang.String p_strPortalGuid)
          Returns Exchange account properties for the given impersonate user.
 java.lang.String getInboxFolderHref(java.lang.String p_strUserMailbox)
          Returns the folder HREF value.
 java.lang.String getInboxFolderName(java.lang.String p_strUserMailbox)
          Returns the language dependent folder name.
 java.lang.String getJournalFolderHref(java.lang.String p_strUserMailbox)
          Returns the folder HREF value.
 java.lang.String getJournalFolderName(java.lang.String p_strUserMailbox)
          Returns the language dependent folder name.
 java.lang.String getOutboxFolderHref(java.lang.String p_strUserMailbox)
          Returns the folder HREF value.
 java.lang.String getOutboxFolderName(java.lang.String p_strUserMailbox)
          Returns the language dependent folder name.
 java.lang.String getOutOfOfficeMessage()
          Returns the out of office message.
 java.lang.String getSentItemsFolderHref(java.lang.String p_strUserMailbox)
          Returns the folder HREF value.
 java.lang.String getSentItemsFolderName(java.lang.String p_strUserMailbox)
          Returns the language dependent folder name.
 java.util.List<java.lang.String> getSharedUsers()
          Returns a list of currently shared users mailbox names.
 java.lang.String getTasksFolderHref(java.lang.String p_strUserMailbox)
          Returns the folder HREF value.
 java.lang.String getTasksFolderName(java.lang.String p_strUserMailbox)
          Returns the language dependent folder name.
 ExchangeAccount getUserAccount(java.lang.String p_strUserGuid)
          Returns Exchange account properties for the given user.
 ExchangeAccount getUserAccount(java.lang.String p_strUserGuid, java.lang.String p_strPortalGuid)
          Returns Exchange account properties for the given user.
 boolean isOutOfOfficeEnabled()
          Returns the out of office status.
 void purgeDeletedItemsFolder()
          Deletes all items in the deleted items folder.
 void releaseSharedUsers()
          Release shared users table.
 void setOutOfOffice(boolean p_bOutOfOffice)
          Sets the out of office status.
 void setOutOfOfficeMessage(java.lang.String p_strMessage)
          Sets both the internal and the external out of office message.
 java.lang.String updateFolderName(java.lang.String p_strFolderId, java.lang.String p_strFolderName)
          Updates the name of a folder identified by the given folder ID.
 

Method Detail

getUserAccount

ExchangeAccount getUserAccount(java.lang.String p_strUserGuid)
                               throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns Exchange account properties for the given user.

Parameters:
p_strUserGuid - The GUID of the user.
Returns:
The Exchange account properties bean.
Throws:
ExchangeUtilException - If operation failed.

getUserAccount

ExchangeAccount getUserAccount(java.lang.String p_strUserGuid,
                               java.lang.String p_strPortalGuid)
                               throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns Exchange account properties for the given user.

Parameters:
p_strUserGuid - The GUID of the user.
p_strPortalGuid - The portal GUID.
Returns:
The Exchange account properties bean.
Throws:
ExchangeUtilException - If operation failed.

getImpersonateUserAccount

ExchangeAccount getImpersonateUserAccount(java.lang.String p_strUserGuid)
                                          throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns Exchange account properties for the given impersonate user.

Parameters:
p_strUserGuid - The GUID of the user.
Returns:
The Exchange account properties bean.
Throws:
ExchangeUtilException - If operation failed.

getImpersonateUserAccount

ExchangeAccount getImpersonateUserAccount(java.lang.String p_strUserGuid,
                                          java.lang.String p_strPortalGuid)
                                          throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns Exchange account properties for the given impersonate user.

Parameters:
p_strUserGuid - The GUID of the user.
p_strPortalGuid - The portal GUID.
Returns:
The Exchange account properties bean.
Throws:
ExchangeUtilException - If operation failed.

getSharedUsers

java.util.List<java.lang.String> getSharedUsers()
                                                throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns a list of currently shared users mailbox names.

Returns:
A list of currently shared users.
Throws:
ExchangeUtilException - If operation failed.

getCalendarFolderName

java.lang.String getCalendarFolderName(java.lang.String p_strUserMailbox)
                                       throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the language dependent folder name.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder name.
Throws:
ExchangeUtilException - If operation failed.

getCalendarFolderHref

java.lang.String getCalendarFolderHref(java.lang.String p_strUserMailbox)
                                       throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the folder HREF value.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder HREF value.
Throws:
ExchangeUtilException - If operation failed.

getContactsFolderName

java.lang.String getContactsFolderName(java.lang.String p_strUserMailbox)
                                       throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the language dependent folder name.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder name.
Throws:
ExchangeUtilException - If operation failed.

getContactsFolderHref

java.lang.String getContactsFolderHref(java.lang.String p_strUserMailbox)
                                       throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the folder HREF value.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder HREF value.
Throws:
ExchangeUtilException - If operation failed.

getDeletedItemsFolderName

java.lang.String getDeletedItemsFolderName(java.lang.String p_strUserMailbox)
                                           throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the language dependent folder name.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder name.
Throws:
ExchangeUtilException - If operation failed.

getDeletedItemsFolderHref

java.lang.String getDeletedItemsFolderHref(java.lang.String p_strUserMailbox)
                                           throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the folder HREF value.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder HREF value.
Throws:
ExchangeUtilException - If operation failed.

getDraftsFolderName

java.lang.String getDraftsFolderName(java.lang.String p_strUserMailbox)
                                     throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the language dependent folder name.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder name.
Throws:
ExchangeUtilException - If operation failed.

getDraftsFolderHref

java.lang.String getDraftsFolderHref(java.lang.String p_strUserMailbox)
                                     throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the folder HREF value.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder HREF value.
Throws:
ExchangeUtilException - If operation failed.

getInboxFolderName

java.lang.String getInboxFolderName(java.lang.String p_strUserMailbox)
                                    throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the language dependent folder name.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder name.
Throws:
ExchangeUtilException - If operation failed.

getInboxFolderHref

java.lang.String getInboxFolderHref(java.lang.String p_strUserMailbox)
                                    throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the folder HREF value.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder HREF value.
Throws:
ExchangeUtilException - If operation failed.

getJournalFolderName

java.lang.String getJournalFolderName(java.lang.String p_strUserMailbox)
                                      throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the language dependent folder name.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder name.
Throws:
ExchangeUtilException - If operation failed.

getJournalFolderHref

java.lang.String getJournalFolderHref(java.lang.String p_strUserMailbox)
                                      throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the folder HREF value.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder HREF value.
Throws:
ExchangeUtilException - If operation failed.

getOutboxFolderName

java.lang.String getOutboxFolderName(java.lang.String p_strUserMailbox)
                                     throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the language dependent folder name.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder name.
Throws:
ExchangeUtilException - If operation failed.

getOutboxFolderHref

java.lang.String getOutboxFolderHref(java.lang.String p_strUserMailbox)
                                     throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the folder HREF value.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder HREF value.
Throws:
ExchangeUtilException - If operation failed.

getSentItemsFolderName

java.lang.String getSentItemsFolderName(java.lang.String p_strUserMailbox)
                                        throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the language dependent folder name.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder name.
Throws:
ExchangeUtilException - If operation failed.

getSentItemsFolderHref

java.lang.String getSentItemsFolderHref(java.lang.String p_strUserMailbox)
                                        throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the folder HREF value.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder HREF value.
Throws:
ExchangeUtilException - If operation failed.

getTasksFolderName

java.lang.String getTasksFolderName(java.lang.String p_strUserMailbox)
                                    throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the language dependent folder name.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder name.
Throws:
ExchangeUtilException - If operation failed.

getTasksFolderHref

java.lang.String getTasksFolderHref(java.lang.String p_strUserMailbox)
                                    throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the folder HREF value.

Parameters:
p_strUserMailbox - The name of the user mailbox or null for the current user.
Returns:
The folder HREF value.
Throws:
ExchangeUtilException - If operation failed.

isOutOfOfficeEnabled

boolean isOutOfOfficeEnabled()
                             throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the out of office status.

Returns:
True if out of office is enabled.
Throws:
ExchangeUtilException - If operation failed.

getOutOfOfficeMessage

java.lang.String getOutOfOfficeMessage()
                                       throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns the out of office message.

Returns:
The out of office message.
Throws:
ExchangeUtilException - If operation failed.

setOutOfOffice

void setOutOfOffice(boolean p_bOutOfOffice)
                    throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Sets the out of office status.

Parameters:
p_bOutOfOffice - True to enable out of office message.
Throws:
ExchangeUtilException - If operation failed.

setOutOfOfficeMessage

void setOutOfOfficeMessage(java.lang.String p_strMessage)
                           throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Sets both the internal and the external out of office message.

Parameters:
p_strMessage - The out of office message.
Throws:
ExchangeUtilException - If operation failed.

getFolders

java.util.List<IFolderInfo> getFolders()
                                       throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns a list of IFolderInfo instances for all folders.

Returns:
A list of IFolderInfo instances for all folders.
Throws:
ExchangeUtilException - If operation failed.

getFolderInfoById

IFolderInfo getFolderInfoById(java.lang.String p_strFolderId)
                              throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns an ExchangeFolderInfo instance with the folder properties.

Parameters:
p_strFolderId - The ID to identify the folder.
Returns:
A IFolderInfo instance with the folder properties or null if no folder exists for the given ID.
Throws:
ExchangeUtilException - If operation failed.

getFolderInfoByHref

IFolderInfo getFolderInfoByHref(java.lang.String p_strFolderHref)
                                throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Returns an ExchangeFolderInfo instance with the folder properties.

Parameters:
p_strFolderHref - The HREF of the folder.
Returns:
A IFolderInfo instance with the folder properties or null if no folder exists for the given HREF.
Throws:
ExchangeUtilException - If operation failed.

updateFolderName

java.lang.String updateFolderName(java.lang.String p_strFolderId,
                                  java.lang.String p_strFolderName)
                                  throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Updates the name of a folder identified by the given folder ID.

Parameters:
p_strFolderId - The folder ID.
p_strFolderName - The new folder name.
Returns:
The new HREF of the folder.
Throws:
ExchangeUtilException - If operation failed.

createFolder

java.lang.String createFolder(java.lang.String p_strParentHref,
                              java.lang.String p_strFolderName,
                              java.lang.String p_strContentClass)
                              throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Creates a new folder. The display name can be an arbitrary string. The HREF and parent HREF parameters must include the canonical path to the folder. Consider the following structure:

+ Folder1
++ Folder2
+++ MyNewFolder

To create 'MyNewFolder' beneath 'Folder2' the following values are required:

Folder name: MyNewFolder
Parent HREF: /Folder1/Folder2/

Parameters:
p_strParentHref - The HREF of the parent folder (required).
p_strFolderName - The name of the folder (required).
p_strContentClass - The content class of the folder (default is urn:content-classes:mailfolder).
Returns:
The ID of the new folder.
Throws:
ExchangeUtilException - If operation failed.

deleteFolder

boolean deleteFolder(java.lang.String p_strId,
                     boolean p_bPurgeFolder)
                     throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Deletes a folder identified by ID.

Parameters:
p_strId - The ID of the folder.
p_bPurgeFolder - If true, the folder will be removed from deleted items folder as well.
Returns:
True if folder was deleted.
Throws:
ExchangeUtilException - If operation failed.

purgeDeletedItemsFolder

void purgeDeletedItemsFolder()
                             throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Deletes all items in the deleted items folder.

Throws:
ExchangeUtilException - If operation failed.

releaseSharedUsers

void releaseSharedUsers()
                        throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
Release shared users table.

Throws:
ExchangeUtilException - If operation failed.


Last updated: 2011-08-11 10-04
Copyright © 2000-2011 United Planet. All Rights Reserved.