Documentation Index

• ConfigsAndVariables
• Functions
• Events
• ExampleSession

Basic Functions

• MezzengerKlient->init($mail,$pass,$status=false,$iamabot=false)

This function will initialize the class with the login info.

The first parameter must be a valid Passport account. The second parameter must be the correct password for the account. The third parameter is optional, and establish the initial status. The fourth parameter is optional, and establish to ignore user abort.

• MezzengerKlient->login()

This function will initiate the login process.

• MezzengerKlient->load_login()

This function will stop its execution, until the user have been succesfully logged in.

• MezzengerKlient->main()

This function will loop the program until an event is called, or the connection closses.

• MezzengerKlient->quit()

This function will close all connections.

More functions

Now that you understand how the events work, I will show you how to make actions in the server.

• MezzengerKlient->setFormat($save=false,$fontname="Times New Roman",$effects="",$color=0,$cs=0,$pf=12,$rl=0,$sb=false)

This function will change or return a Message Format.

To make the function to return the format string for:

Courier Font Bold and Italics White color

We should call:

setFormat(false,"Courier New","BI","FFFFFF")

The first argument is:

true - if you want to make the function to set the format as default false - if you want the function only to return the font value.

The second argument is the Font Name. The third argument is the effects. (B for Bold, I for Italics) The fourth argument is the color. (in hex blue-green-red format) The fifth argument is the character set. (for foreign sets) The sixt argument is the alternative font option. The seventh argument is the allignment side. (set to 1 if right)

More information about the arguments can be found here:

http://www.hypothetic.org/docs/msn/client/plaintext.php#formatting

• MezzengerKlient->setGTC($new)

This function will set the GTC config value.

GTC options are:

N - For making the official clients to automatically add to previous list,

the contact.

A - For making the official clients to ask if you want to allow of block

former contacts.

• MezzengerKlient->setBLP($new)

This function will set the BLP config value.

BLP is the default list in which the new contacts should be added.

The only 2 possible options are:

AL - Allow List BL - Block List

• MezzengerKlient->setNick($new_nick,$who)

This function will change your nickname or one of your friends nickname.

If you dont specify any contacts nickname, then your nickname will be changed.

• MezzengerKlient->addGroup($name)

This function will add the group with the name "$name", and return its $id.

• MezzengerKlient->delGroup($id)

This function will delete the group with the id "$id".

• MezzengerKlient->renGroup($id,$new_name)

This function will rename the group with the id "$id", to the name "$name".

• MezzengerKlient->addContact($mail,$list)

This function will add "$mail" to the specified list.

The list can be:

AL - Allow List BL - Block List FL - Forward List (contacts) <<-- default

• MezzengerKlient->delContact($mail,$list)

This function will delete "$mail" from the specified list.

The lists are the same as in MezzengerKlient->addContact

• MezzengerKlient->newChat()

This function will ask for a new chat session, you should add a onChatLoad event, for

inviting someone to the chat, or the server will close the connection.

• MezzengerKlient->InviteToChat($id,$mail)

This function will invite "$mail" to the chat session $id.

• MezzengerKlient->sendMessage($id,$message,$notification=false)

This function will send a "$message" that must include the headers, to the chat session

$id, and optionally will process a notification.

The notification values are:

U - No notification (default). N - Notification if failed. A - Allways receive notification.

• MezzengerKlient->sendTyping($id)

This function will send a message of "X user is typing a message", to the $id chat session.

• MezzengerKlient->sendText($id,$message,$format=false,$notification=false)

This function will send $message as a chat text to $id with the specified $format and the

$notification option.

$format and $notification are optional.

• MezzengerKlient->MessageToNew($who,$message)

This function will create a new chat session and invite $who, and once $who joins, it will

say "$message" as a chat text.

This function will return the $id.

• MezzengerKlient->ProcessMessage($message)

This function will process the $message and return an array with:

0 -> Headers ["Header"]=>Value 1 -> Content

• MezzengerKlient->exitChat($id)

This function will leave the chat session $id.