Message

Method Summary
Message	createReply(String subject, String message) Creates a new message and associates it with the given message. Only non-system messages can be followed
	deleteAttachment() Deletes the attachment of this message.
	deleteTag(String tagName) Removes the specified tag from the message.
File	getAttachment() Returns the attachment of this message, if any.
String	getBody() ⚠Deprecated since 07-24-2013. Use getMessage() Returns the message body
SystemDataView	getChildMessages() Returns messages that are children (one-to-many) for this message.
Date	getCreateDate() Returns the date this message was created.
Data	getData() Returns a Data of all this message's properties, except body
Date	getDateRead() Returns the date this message was read or null if it has not been read.
String	getId() Returns the message id.
String	getMessage() Returns the message
String	getMessageType() Returns the message type
String	getPalId() Returns the pal id for this message.
SystemDataView	getParentMessages() Returns parent chain (one-to-one) of messages for this message.
String	getReceiverEmail() Returns the message receiver
String	getReceiverFirstName() Returns the message receiver's first name
String	getReceiverLastName() Returns the message receiver's last name
String	getSenderEmail() Returns the message sender
String	getSenderFirstName() Returns the message sender's first name
String	getSenderLastName() Returns the message sender's last name
String	getSubject() Returns the subject.
Tag	getTag(String tagName) Returns the specified tag value if it exists.
SystemDataView	getTags() Returns tags for this object.
String	getTransactionCategory() Returns the transaction category for this message, if it is associated with a transaction.
String	getTransactionDescription() Returns the transaction description for this message, if it is associated with a transaction.
String	getTransactionId() Returns the transaction id for this message, if it is associated with a transaction.
String	getTransactionName() Returns the transaction name for this message, if it is associated with a transaction.
	markRead() Marks the specified message as having been read by the recipient.
	setAttachment(File file) Sets the attachment of this message.
	setMessageType(String messageType) Sets the message type
	setTag(String tagName, String tagValue, Date tagDate, float tagFloat) Sets the specified tag for searching purposes.
	setTagDate(String tagName, Date tagDate) Sets the specified tag for searching purposes.
	setTagFloat(String tagName, float tagFloat) Sets the specified tag for searching purposes.
	setTagValue(String tagName, String tagValue) Sets the specified tag for searching purposes.
String	toString() Returns a description of this object.

Method Detail

Message createReply(String subject, String message)

Creates a new message and associates it with the given message. Only non-system messages can be followed

Parameters:

String subject Required parameter. Maximum allowed size of parameter: 200
String message Required parameter. Maximum allowed size of parameter: 3000

Returns: Message

Since: 01-05-2010

top

deleteAttachment()

Deletes the attachment of this message.

Since: 01-16-2013

top

deleteTag(String tagName)

Removes the specified tag from the message.

Parameters:

String tagName Required parameter. Maximum allowed size of parameter: 50

Since: 01-10-2013

top

File getAttachment()

Returns the attachment of this message, if any.

Returns: File

Since: 01-16-2013

top

String getBody()

Returns the message body

Returns: String

Since: 01-14-2010

This method has been deprecated since 07-24-2013. Use getMessage()

top

SystemDataView getChildMessages()

Returns messages that are children (one-to-many) for this message.

Returns: SystemDataView

DataList Name: ChildMessages
Tag Support: Yes

DataList Keys/Column Name	Column Type	Read Only
id	String
subject	String
private	Boolean
createDate	Date
readDate	Date
receiverEmail	String
messageType	String
message	String
replyTo	String
palId	String
transactionId	String
txName	String
txDescription	String
txCategory	String
senderId	String
senderEmail	String
senderFirstName	String
senderLastName	String
recipientId	String
recipientEmail	String
recipientFirstName	String
recipientLastName	String

Since: 01-05-2010

top

Date getCreateDate()

Returns the date this message was created.

Returns: Date

Since: 01-05-2010

top

Data getData()

Returns a Data of all this message's properties, except body

Returns: Data

Since: 01-11-2013

top

Date getDateRead()

Returns the date this message was read or null if it has not been read.

Returns: Date

Since: 01-05-2010

top

String getId()

Returns the message id.

Returns: String

Since: 01-05-2010

top

String getMessage()

Returns the message

Returns: String

Since: 01-16-2013

top

String getMessageType()

Returns the message type

Returns: String

Since: 01-16-2013

top

String getPalId()

Returns the pal id for this message.

Returns: String

Since: 01-14-2010

top

SystemDataView getParentMessages()

Returns parent chain (one-to-one) of messages for this message.

Returns: SystemDataView

DataList Name: ParentMessages
Tag Support: Yes

DataList Keys/Column Name	Column Type	Read Only
id	String
subject	String
private	Boolean
createDate	Date
readDate	Date
receiverEmail	String
messageType	String
message	String
replyTo	String
palId	String
transactionId	String
txName	String
txDescription	String
txCategory	String
senderId	String
senderEmail	String
senderFirstName	String
senderLastName	String
recipientId	String
recipientEmail	String
recipientFirstName	String
recipientLastName	String