PHPBoost Framework A.P.I.

PrivateMsg

Package: PHPBoost\Member Copyright: © 2005-2019 PHPBoost License: GNU/GPL-3.0 Author: Regis VIARRE crowkait@phpboost.com Version: PHPBoost 5.2 - last update: 2016 10 24 Since: PHPBoost 1.6 - 2007 04 02 Contributor: Julien BRISWALTER j1.seth@phpboost.com Contributor: Arnaud GENET elenwii@phpboost.com Located at: phpboost/member/PrivateMsg.class.php

This class provides methods to manage private message.

Methods summary
`public static`	# `__static( )`
`public static integer`	# `count_conversations( integer $userid )` Counts the user's number of conversation. Counts the user's number of conversation. Parameters `$userid` The user id. Returns integer number of user conversation.
`public static`	# `start_conversation( integer $pm_to, string $pm_objet, string $pm_contents, integer $pm_from, boolean $system_pm = false )` Starts a conversation with another member. Starts a conversation with another member. Parameters `$pm_to` The member's user id destination. `$pm_objet` The object of the conversation. `$pm_contents` The content of the conversation. `$pm_from` The member's user id author. `$system_pm` If true, the conversation has been started by the system, and not by the private message interface.
`public static`	# `send( integer $pm_to, integer $pm_idconvers, string $pm_contents, integer $pm_from, integer $pm_status, boolean $check_pm_before_send = true )` Answers to a conversation Answers to a conversation Parameters `$pm_to` The member's user id destination. `$pm_idconvers` `$pm_contents` The content of the answer. `$pm_from` The member's user id author. `$pm_status` `$check_pm_before_send`
`public static`	# `delete_conversation( integer $pm_userid, integer $pm_idconvers, integer $pm_expd, boolean $pm_del, boolean $pm_update )` Deletes a conversation. Deletes a conversation. Parameters `$pm_userid` `$pm_idconvers` `$pm_expd` `$pm_del` `$pm_update`
`public static integer`	# `delete( integer $pm_to, integer $pm_idmsg, integer $pm_idconvers )` Deletes a private message, until the recipient has not read it. Deletes a private message, until the recipient has not read it. Parameters `$pm_to` `$pm_idmsg` `$pm_idconvers` Returns integer The previous message id.

Constants summary
`boolean`	`NOCHECK_PM_BOX`	# `false`
`boolean`	`CHECK_PM_BOX`	# `true`
`boolean`	`SYSTEM_PM`	# `true`
`boolean`	`DEL_PM_CONVERS`	# `true`
`boolean`	`UPDATE_MBR_PM`	# `false`

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Returns