Simias::POBox::Message Class Reference

A Message object is a specialized node used to hold ... More...

Inheritance diagram for Simias::POBox::Message:

[legend]

Collaboration diagram for Simias::POBox::Message:

[legend]

List of all members.

Public Member Functions
	Message (string messageName, string baseType, string messageID)
	Constructor for creating a new Message object with a specific ID.
	Message (string messageName, string baseType, string messageType, string fromIdentity)
	Constructor for creating a new Message object.
	Message (string messageName, string baseType, string messageType, string fromIdentity, string fromAddress)
	Constructor for creating a new Message object.
	Message (string messageName, string baseType, string messageType, string fromIdentity, string fromAddress, string toAddress)
	Constructor for creating a new Message object.
	Message (string messageName, string baseType, string messageType, string fromIdentity, string fromAddress, string toAddress, string toIdentity)
	Constructor for creating a new Message object.
	Message (string ID, Message message)
	Clone the message with a new ID.
	Message (Node node)
	Constructor for creating an existing Message object from a Node object.
	Message (Collection collection, ShallowNode shallowNode)
	Constructor for creating a existing Message object.
Public Attributes
const string	MessageIDProperty = "MsgID"
	The name of the property storing the message id.
const string	MessageTypeProperty = "MsgType"
	The name of the property storing the message type.
const string	MessageStateProperty = "MsgState"
	The name of the property storing the message state.
const string	ToNameProperty = "ToName"
	The name of the property storing the "To:" friendly name.
const string	ToIdentityProperty = "ToID"
	The name of the property storing the "To:" identity.
const string	ToAddressProperty = "ToAddr"
	The name of the property storing the "To:" address.
const string	FromNameProperty = "FromName"
	The name of the property storing the "From:" friendly name.
const string	FromIdentityProperty = "FromID"
	The name of the property storing the "From:" identity.
const string	FromAddressProperty = "FromAddr"
	The name of the property storing the "From:" address.
const string	BodyProperty = "Body"
	The name of the property storing the message body.
const string	SubjectProperty = "Subject"
	The name of the property storing the message subject.
const string	DomainIDProperty = "DomainID"
	The name of the property storing the domain id.
const string	DomainNameProperty = "DomainName"
	The name of the property storing the domain name.
Static Public Attributes
static readonly string	InboundMessage = "Inbound"
	The type for an inbound message.
static readonly string	OutboundMessage = "Outbound"
	The type for an outbound message.
Properties
string	MessageID [get, set]
	Gets/sets the id of the message.
string	MessageType [get, set]
	Gets/sets the type of the message.
MessageState	State [get, set]
	Gets/sets the state of the Message object.
string	Subject [get, set]
	Gets/sets the subject of the message.
string	Body [get, set]
	Gets/sets the body of the message.
string	ToName [get, set]
	Gets/sets the recipient's friendly name.
string	ToAddress [get, set]
	Gets/sets the recipient's address.
string	ToIdentity [get, set]
	Gets/sets the recipient's identity.
string	FromName [get, set]
	Gets/sets the sender's friendly name.
string	FromAddress [get, set]
	Gets/sets the sender's address.
string	FromIdentity [get, set]
	Gets/sets the sender's identity.
string	DomainID [get, set]
	Gets/sets the identity domain id.
string	DomainName [get, set]
	Gets/sets the identity domain name.

---

Detailed Description

A Message object is a specialized node used to hold ...

---

Constructor & Destructor Documentation

Simias::POBox::Message::Message	(	string	messageName,
		string	baseType,
		string	messageID
	)			[inline]

Constructor for creating a new Message object with a specific ID.

Parameters:

	messageName	The friendly name of the Message object.
	baseType	Base type of node.
	messageID	The ID of the Message object.

Simias::POBox::Message::Message	(	string	messageName,
		string	baseType,
		string	messageType,
		string	fromIdentity
	)			[inline]

Constructor for creating a new Message object.

Parameters:

	messageName	The friendly name of the message.
	baseType	Base type of node.
	messageType	The type of the message.
	fromIdentity	The identity of the sender.

Simias::POBox::Message::Message	(	string	messageName,
		string	baseType,
		string	messageType,
		string	fromIdentity,
		string	fromAddress
	)			[inline]

Constructor for creating a new Message object.

Parameters:

	messageName	The friendly name of the message.
	baseType	Base type of node.
	messageType	The type of the message.
	fromIdentity	The sender's identity.
	fromAddress	The sender's address.

Simias::POBox::Message::Message	(	string	messageName,
		string	baseType,
		string	messageType,
		string	fromIdentity,
		string	fromAddress,
		string	toAddress
	)			[inline]

Constructor for creating a new Message object.

Parameters:

	messageName	The friendly name of the message.
	baseType	Base type of node.
	messageType	The type of the message.
	fromIdentity	The sender's identity.
	fromAddress	The sender's address.
	toAddress	The recipient's address.

Simias::POBox::Message::Message	(	string	messageName,
		string	baseType,
		string	messageType,
		string	fromIdentity,
		string	fromAddress,
		string	toAddress,
		string	toIdentity
	)			[inline]

Constructor for creating a new Message object.

Parameters:

	messageName	The friendly name of the message.
	baseType	Base type of node.
	messageType	The type of the message.
	fromIdentity	The sender's identity.
	fromAddress	The sender's address.
	toAddress	The recipient's address.
	toIdentity	The recipient's identity.

Simias::POBox::Message::Message	(	string	ID,
		Message	message
	)			[inline]

Clone the message with a new ID.

Parameters:

	ID	The new node ID.
	message	The message to clone.

Simias::POBox::Message::Message

(

Node

node

)

[inline]

Constructor for creating an existing Message object from a Node object.

Parameters:

node

The Node object to create the Message object from.

Simias::POBox::Message::Message	(	Collection	collection,
		ShallowNode	shallowNode
	)			[inline]

Constructor for creating a existing Message object.

Parameters:

	collection	Collection that the ShallowNode belongs to.
	shallowNode	ShallowNode object to create the Message object from.

---

Member Data Documentation

readonly string Simias::POBox::Message::InboundMessage = "Inbound" [static]

The type for an inbound message.

readonly string Simias::POBox::Message::OutboundMessage = "Outbound" [static]

The type for an outbound message.

const string Simias::POBox::Message::MessageIDProperty = "MsgID"

The name of the property storing the message id.

const string Simias::POBox::Message::MessageTypeProperty = "MsgType"

The name of the property storing the message type.

const string Simias::POBox::Message::MessageStateProperty = "MsgState"

The name of the property storing the message state.

const string Simias::POBox::Message::ToNameProperty = "ToName"

The name of the property storing the "To:" friendly name.

const string Simias::POBox::Message::ToIdentityProperty = "ToID"

The name of the property storing the "To:" identity.

const string Simias::POBox::Message::ToAddressProperty = "ToAddr"

The name of the property storing the "To:" address.

const string Simias::POBox::Message::FromNameProperty = "FromName"

The name of the property storing the "From:" friendly name.

const string Simias::POBox::Message::FromIdentityProperty = "FromID"

The name of the property storing the "From:" identity.

const string Simias::POBox::Message::FromAddressProperty = "FromAddr"

The name of the property storing the "From:" address.

const string Simias::POBox::Message::BodyProperty = "Body"

The name of the property storing the message body.

const string Simias::POBox::Message::SubjectProperty = "Subject"

The name of the property storing the message subject.

const string Simias::POBox::Message::DomainIDProperty = "DomainID"

The name of the property storing the domain id.

const string Simias::POBox::Message::DomainNameProperty = "DomainName"

The name of the property storing the domain name.

---

Property Documentation

string Simias::POBox::Message::MessageID [get, set]

Gets/sets the id of the message.

string Simias::POBox::Message::MessageType [get, set]

Gets/sets the type of the message.

MessageState Simias::POBox::Message::State [get, set]

Gets/sets the state of the Message object.

string Simias::POBox::Message::Subject [get, set]

Gets/sets the subject of the message.

string Simias::POBox::Message::Body [get, set]

Gets/sets the body of the message.

string Simias::POBox::Message::ToName [get, set]

Gets/sets the recipient's friendly name.

string Simias::POBox::Message::ToAddress [get, set]

Gets/sets the recipient's address.

string Simias::POBox::Message::ToIdentity [get, set]

Gets/sets the recipient's identity.

string Simias::POBox::Message::FromName [get, set]

Gets/sets the sender's friendly name.

string Simias::POBox::Message::FromAddress [get, set]

Gets/sets the sender's address.

string Simias::POBox::Message::FromIdentity [get, set]

Gets/sets the sender's identity.

string Simias::POBox::Message::DomainID [get, set]

Gets/sets the identity domain id.

string Simias::POBox::Message::DomainName [get, set]

Gets/sets the identity domain name.

---

The documentation for this class was generated from the following file:

• src/core/POBox/Message.cs