MessageIn Event

This event is fired upon receipt of a message.

Syntax

xmpp.on('MessageIn', [callback])

Callback

The 'callback' is called when the 'MessageIn' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.messageId
e.from
e.domain
e.resource
e.messageType
e.subject
e.messageThread
e.messageText
e.messageHTML
e.other

Remarks

When a message is received, the XMPP class will parse the sender's Jabber ID into the From, Domain, and Resource fields. These parameters can be used to track the exact instance of a user's account that originated the message.

MessageId can be used with Jabber extension protocols. The MessageText parameter is the plaintext portion of the message body. MessageHTML will contain any HTML from the message.

Type the type of message received. See MessageType for a list of possible values. For message of type "headline", Subject will reflect the subject of the message. For messages of type "chat", Thread will report the conversation thread for which the current message is a follow-up.

Other will contains any extra data associated with the message but not defined by the XMPP-IM protocol.