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.

Version:
$Revision: 89488 $

Method Summary
 IExchangeMessage createNewDraft(java.lang.String p_strFrom, java.lang.String p_strTo, java.lang.String p_strSubject, java.lang.String p_strBody)
          Creates a new draft email message.
 IExchangeMessage findById(java.lang.String p_strId)
          Loads a message with the given ID.
 IExchangeMessage findByPermanentUrl(java.lang.String p_strPermUrl)
          Loads a message with the given permanent URL.
 void saveMessageAsEML(java.lang.String p_strMsgId, java.io.File p_fileDst)
          Saves an MS Exchange message item in the EML format to the given file.
 void saveMessageAsMSG(java.lang.String p_strMsgId, java.io.File p_fileDst)
          Saves an MS Exchange message item in the MSG format to the given file.
 void sendMessage(java.lang.String p_strItemId)
          Sends a message identified by the given ID.
 void setMessageRead(java.lang.String p_strItemId)
          Marks a message as read by setting the 'Read' flag to true.
 

Method Detail

createNewDraft

IExchangeMessage createNewDraft(java.lang.String p_strFrom,
                                java.lang.String p_strTo,
                                java.lang.String p_strSubject,
                                java.lang.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:
ExchangeUtilException - If message could not be created.

findById

IExchangeMessage findById(java.lang.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:
ExchangeUtilException

findByPermanentUrl

IExchangeMessage findByPermanentUrl(java.lang.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:
ExchangeUtilException

saveMessageAsEML

void saveMessageAsEML(java.lang.String p_strMsgId,
                      java.io.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:
ExchangeUtilException - If the operation failed.

saveMessageAsMSG

void saveMessageAsMSG(java.lang.String p_strMsgId,
                      java.io.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:
ExchangeUtilException - If the operation failed.

sendMessage

void sendMessage(java.lang.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:
ExchangeUtilException - If the operation failed.

setMessageRead

void setMessageRead(java.lang.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:
ExchangeUtilException - If the operation failed.


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