Package de.uplanet.lucy.server.businesslogic.exchange.util

Interface IExchangeMessageUtil

All Known Implementing Classes:
ExchangeMessageUtil
@Scriptable public interface IExchangeMessageUtil
Defines utility methods for working with MS Exchange messages.

  • Method Details

    • createNewDraft

      IExchangeMessage createNewDraft(String p_strFrom, String p_strTo, String p_strSubject, String p_strBody) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Creates a new draft email message.
      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

      IExchangeMessage findById(String p_strId) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Loads a message with the given ID.
      Parameters:
      p_strId - The message ID.
      Returns:
      The IExchangeMessage instance.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

    • findByPermanentUrl

      IExchangeMessage findByPermanentUrl(String p_strPermUrl) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Loads a message with the given permanent URL.
      Parameters:
      p_strPermUrl - The permanent URL.
      Returns:
      The IExchangeMessage instance.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

    • saveMessageAsEML

      void saveMessageAsEML(String p_strMsgId, File p_fileDst) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Saves an MS Exchange message item in the EML format to the given file.
      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

      void saveMessageAsMSG(String p_strMsgId, File p_fileDst) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Saves an MS Exchange message item in the MSG format to the given file.
      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

      void sendMessage(String p_strItemId) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Sends a message identified by the given ID.
      Parameters:
      p_strItemId - The ID of the message.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If the operation failed.

    • setMessageRead

      void setMessageRead(String p_strItemId) throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
      Marks a message as read by setting the 'Read' flag to true.
      Parameters:
      p_strItemId - The ID of the message.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If the operation failed.

    • createFolder

      String createFolder(String p_strParentHref, String p_strFolderName) 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 folder name.
      Returns:
      The ID of the new folder.
      Throws:
      de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.