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

  • Method Details

    • getUserAccount

      ExchangeAccount getUserAccount(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getUserAccount

      ExchangeAccount getUserAccount(String p_strUserGuid, 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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getImpersonateUserAccount

      ExchangeAccount getImpersonateUserAccount(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getImpersonateUserAccount

      ExchangeAccount getImpersonateUserAccount(String p_strUserGuid, 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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • resetUserAccount

      void resetUserAccount(String p_strUserGuid) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Resets (deletes) the MediaGateway/Exchange user account for the given user guid in order to enforce the user to authenticate with Exchange again (helpful if Windows password has changed).
      Parameters:
      p_strUserGuid - The user GUID.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

    • getSharedUsers

      List<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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getCalendarFolderName

      String getCalendarFolderName(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getCalendarFolderHref

      String getCalendarFolderHref(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getContactsFolderName

      String getContactsFolderName(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getContactsFolderHref

      String getContactsFolderHref(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getDeletedItemsFolderName

      String getDeletedItemsFolderName(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getDeletedItemsFolderHref

      String getDeletedItemsFolderHref(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getDraftsFolderName

      String getDraftsFolderName(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getDraftsFolderHref

      String getDraftsFolderHref(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getInboxFolderName

      String getInboxFolderName(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getInboxFolderHref

      String getInboxFolderHref(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getJournalFolderName

      String getJournalFolderName(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getJournalFolderHref

      String getJournalFolderHref(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getOutboxFolderName

      String getOutboxFolderName(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getOutboxFolderHref

      String getOutboxFolderHref(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getSentItemsFolderName

      String getSentItemsFolderName(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getSentItemsFolderHref

      String getSentItemsFolderHref(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getTasksFolderName

      String getTasksFolderName(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getTasksFolderHref

      String getTasksFolderHref(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getRootFolderID

      String getRootFolderID(String p_strUserMailbox) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Returns the ID (formerly ParentName) of the Exchange 2010 store root folder.
      Parameters:
      p_strUserMailbox - The name of the user mailbox or null for the current user.
      Returns:
      The ID (formerly ParentName) of the Exchange 2010 store root folder.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

    • 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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getOutOfOfficeMessage

      String getOutOfOfficeMessage() throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Returns the out of office message.
      Returns:
      The out of office message.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • setOutOfOfficeMessage

      void setOutOfOfficeMessage(String p_strMessage) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Sets both the internal and the external out of office message. This method is only applicable for MS Exchange Server 2003-2007.
      Parameters:
      p_strMessage - The out of office message.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • setOutOfOfficeMessage

      void setOutOfOfficeMessage(String p_strMessage, Date p_dateStart, Date p_dateEnd) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Sets both the internal and the external out of office message. This method is only applicable for MS Exchange Server 2010.
      Parameters:
      p_strMessage - The out of office message.
      p_dateStart - Defines the start of the Out Of Office period.
      p_dateEnd - Defines the end of the Out Of Office period.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

    • getFolders

      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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getFolderInfoById

      IFolderInfo getFolderInfoById(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getFolderInfoByHref

      IFolderInfo getFolderInfoByHref(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • getCanonicalPath

      String getCanonicalPath(String p_strFolderId) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Returns the canonical path of the folder with the given folder ID.
      Parameters:
      p_strFolderId - The folder ID.
      Returns:
      The canonical path of the folder with the given folder ID.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • updateFolderName

      String updateFolderName(String p_strFolderId, 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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • createFolder

      String createFolder(String p_strParentHref, String p_strFolderName, 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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • deleteFolder

      boolean deleteFolder(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:
      de.uplanet.lucy.server.businesslogic.exchange.util.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:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • releaseSharedUsers

      void releaseSharedUsers() throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Release shared users table.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

    • refreshSharedUsers

      void refreshSharedUsers() throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Refresh shared users table (only applicable for MS Exchange Server 2010).
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.