org.mobicents.csapi.jr.slee.gms
Interface IpMessageConnection

All Superinterfaces:

IpServiceConnection

public interface IpMessageConnection
extends IpServiceConnection

This class represents the < Parlay IpMessageConnection > interface

Method Summary

java.lang.String	getContent(java.lang.String messageID) This method retrieves the message content.
int	getInfoAmount(java.lang.String messageID) This method returns the number of message information properties of the specified message.
TpMessageInfoProperty[]	getInfoProperties(java.lang.String messageID, int firstProperty, int numberOfProperties) This method returns the properties of a message.
void	remove(java.lang.String messageID) This method removes a message from the open mailbox folder.
void	setInfoProperties(java.lang.String messageID, int firstProperty, TpMessageInfoProperty[] messageInfoProperties) This method sets the properties of a message.

Methods inherited from interface org.mobicents.csapi.jr.slee.IpServiceConnection

closeConnection

Method Detail

getInfoAmount

int getInfoAmount(java.lang.String messageID)
                  throws TpCommonExceptions,
                         P_GMS_INVALID_MESSAGE_ID,
                         javax.slee.resource.ResourceException

This method returns the number of message information properties of the specified message.

Parameters:

messageID - Specifies the identity of the message. If the message ID given is not present, the error code P_GMS_INVALID_MESSAGE_ID is returned.

Returns:

numberOfProperties The number of properties associated with the message. The application can then use the information contained to decide whether to get the message or the message information properties from a mailbox folder. The number of properties is zero or positive.

Throws:

TpCommonExceptions

P_GMS_INVALID_MESSAGE_ID

javax.slee.resource.ResourceException

getInfoProperties

TpMessageInfoProperty[] getInfoProperties(java.lang.String messageID,
                                          int firstProperty,
                                          int numberOfProperties)
                                          throws TpCommonExceptions,
                                                 P_GMS_NUMBER_NOT_POSITIVE,
                                                 P_GMS_INVALID_MESSAGE_ID,
                                                 javax.slee.resource.ResourceException

This method returns the properties of a message.

Parameters:

messageID - Specifies the identity of the message. If the message ID given is not present, the error code P_GMS_INVALID_MESSAGE_ID is returned.

firstProperty - This is the first property of interest. This number represents the starting point where the first property of the list to be retrieved from the message is located. Properties are numbered from zero.

numberOfProperties - The number of properties to return. If the value of this parameter is zero, then all properties will be returned. Otherwise, the value must be a positive number. If the number is not positive, the error code P_GMS_NUMBER_NOT_POSITIVE is returned.

Returns:

messageInfoProperties The message information properties (names and values) present in the message. Message properties include message format, read/unread, sent/unsent, message size, relevant dates and times, subject and addresses.

Throws:

TpCommonExceptions

P_GMS_NUMBER_NOT_POSITIVE

P_GMS_INVALID_MESSAGE_ID

javax.slee.resource.ResourceException

setInfoProperties

void setInfoProperties(java.lang.String messageID,
                       int firstProperty,
                       TpMessageInfoProperty[] messageInfoProperties)
                       throws TpCommonExceptions,
                              P_GMS_INVALID_MESSAGE_ID,
                              P_GMS_PROPERTY_NOT_SET,
                              javax.slee.resource.ResourceException

This method sets the properties of a message.

Parameters:

messageID - Specifies the identity of the message. If the message ID given is not present, the error code P_GMS_INVALID_MESSAGE_ID is returned.

firstProperty - This is the first property of interest. This number represents the starting point where the first property of the list to be retrieved from the message is located. Properties are numbered from zero.

messageInfoProperties - This specifies the message information properties (names and values) to be set in the message. Message properties that may be changed include read/unread status, subject and importance. If the properties cannot be changed, then the error code P_GMS_PROPERTY_NOT_SET is returned.

Throws:

TpCommonExceptions

P_GMS_INVALID_MESSAGE_ID

P_GMS_PROPERTY_NOT_SET

javax.slee.resource.ResourceException

remove

void remove(java.lang.String messageID)
            throws TpCommonExceptions,
                   P_GMS_INSUFFICIENT_PRIVILEGE,
                   P_GMS_MESSAGE_NOT_REMOVED,
                   P_GMS_INVALID_MESSAGE_ID,
                   javax.slee.resource.ResourceException

This method removes a message from the open mailbox folder. If the application does not have sufficient privilege to remove the message, the error code P_GMS_INSUFFICIENT_PRIVILEGE is returned.

Parameters:

messageID - Specifies the identity of the message. If the message ID given is not present, the error code P_GMS_INVALID_MESSAGE_ID is returned. The message ID can be obtained by calling the getFolderInfo and getFolderInfoProperties or embedded in an event notification from the messaging service, with information on the mailbox and notifications contained in that operation. If the message cannot be removed, the error code P_GMS_MESSAGE_NOT_REMOVED is returned.

Throws:

TpCommonExceptions

P_GMS_INSUFFICIENT_PRIVILEGE

P_GMS_MESSAGE_NOT_REMOVED

P_GMS_INVALID_MESSAGE_ID

javax.slee.resource.ResourceException

getContent

java.lang.String getContent(java.lang.String messageID)
                            throws TpCommonExceptions,
                                   P_GMS_INVALID_MESSAGE_ID,
                                   javax.slee.resource.ResourceException

This method retrieves the message content.

Parameters:

messageID - Specifies the identity of the message. If the message ID given is not present, the error code P_GMS_INVALID_MESSAGE_ID is returned.

Returns:

content

Throws:

TpCommonExceptions

P_GMS_INVALID_MESSAGE_ID

javax.slee.resource.ResourceException