Class ExchangeMessageUtil

java.lang.Object
de.uplanet.lucy.server.businesslogic.exchange.util.impl.ExchangeMessageUtil
All Implemented Interfaces:
IExchangeMessageUtil

@Scriptable public final class ExchangeMessageUtil extends Object implements IExchangeMessageUtil
Utility class for Exchange messages.
  • Method Details

    • getInstance

      public static IExchangeMessageUtil getInstance()
      Returns an instance initialized with a Exchange connection for the currently logged in user.
      Returns:
      the instance
    • getInstance

      public static IExchangeMessageUtil getInstance(Connection p_conn)
      Returns an instance initialized with the given Exchange connection.
      Parameters:
      p_conn - the MS Exchange connection
      Returns:
      the instance
    • createNewDraft

      public IExchangeMessage createNewDraft(String p_strFrom, String p_strTo, String p_strSubject, String p_strBody) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Description copied from interface: IExchangeMessageUtil
      Creates a new draft email message.
      Specified by:
      createNewDraft in interface IExchangeMessageUtil
      Parameters:
      p_strFrom - The sender email address.
      p_strTo - The receiver email address.
      p_strSubject - The message subject.
      p_strBody - The message body.
      Returns:
      The IExchangeMessage instance.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If message could not be created.
    • findById

      public IExchangeMessage findById(String p_strId) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Description copied from interface: IExchangeMessageUtil
      Loads a message with the given ID.
      Specified by:
      findById in interface IExchangeMessageUtil
      Parameters:
      p_strId - The message ID.
      Returns:
      The IExchangeMessage instance.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
    • findByPermanentUrl

      public IExchangeMessage findByPermanentUrl(String p_strPermUrl) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Description copied from interface: IExchangeMessageUtil
      Loads a message with the given permanent URL.
      Specified by:
      findByPermanentUrl in interface IExchangeMessageUtil
      Parameters:
      p_strPermUrl - The permanent URL.
      Returns:
      The IExchangeMessage instance.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
    • saveMessageAsEML

      public void saveMessageAsEML(String p_strMsgId, File p_fileDst) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Description copied from interface: IExchangeMessageUtil
      Saves an MS Exchange message item in the EML format to the given file.
      Specified by:
      saveMessageAsEML in interface IExchangeMessageUtil
      Parameters:
      p_strMsgId - The ID identifying the message.
      p_fileDst - The destination file.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If the operation failed.
    • saveMessageAsMSG

      public void saveMessageAsMSG(String p_strMsgId, File p_fileDst) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Description copied from interface: IExchangeMessageUtil
      Saves an MS Exchange message item in the MSG format to the given file.
      Specified by:
      saveMessageAsMSG in interface IExchangeMessageUtil
      Parameters:
      p_strMsgId - the ID identifying the message
      p_fileDst - The destination file.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If the operation failed.
    • sendMessage

      public void sendMessage(String p_strItemId) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Description copied from interface: IExchangeMessageUtil
      Sends a message identified by the given ID.
      Specified by:
      sendMessage in interface IExchangeMessageUtil
      Parameters:
      p_strItemId - The ID of the message.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If the operation failed.
    • setMessageRead

      public void setMessageRead(String p_strItemId) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Description copied from interface: IExchangeMessageUtil
      Marks a message as read by setting the 'Read' flag to true.
      Specified by:
      setMessageRead in interface IExchangeMessageUtil
      Parameters:
      p_strItemId - The ID of the message.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If the operation failed.
    • createFolder

      public String createFolder(String p_strParentHref, String p_strFolderName) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Description copied from interface: IExchangeMessageUtil
      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/
      Specified by:
      createFolder in interface IExchangeMessageUtil
      Parameters:
      p_strParentHref - The HREF of the parent folder (required).
      p_strFolderName - The folder name.
      Returns:
      The ID of the new folder.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.