users.reportOffensive

void users.reportOffensive ( int vhost, mixed uid, array parameters = array() )

Name	Type	Required	Default value	Description
vhost	int	Required	none	The vhost ID of the user you want to log as offensive.
uid	mixed	Required	none
parameters	array	Optional	array()	These are various fields that are completely optional. Sample values are: parameters[reportedby]=1927700 parameters[reason]=inappropriate parameters[templateid]=34529 parameters[to]=your.name@gmail.com For more information please refer to the "Parameters" table below.

Parameters

The optional parameters that can be passed as an array.

Name	Type	Description
reportedby	INT	This is the id of the user who is reporting the user as being offensive
reason	STRING	This is the reason why the user is flagging this user as offensive. Note: This value has a maximum length of 255 characters.
templateid	INT	Set templateid to send an email to a flagged user. The recipient's email address is set in the "to" parameter. Note: When "templateid" is set, you need to define tempate variables for the email, as displayed in the "Email Template Parameters" table below.
to	STRING	The e-mail address that the report is going to.

The variables that are available within the email template, for the email that is sent when the parameter templateid is set.

Name	Type	Description
user_id	INT	The id of the user reported as offensive
vhost	INT	The id of the project that contains the user reported as offensive
date	DATETIME	The date and time that the user was reported as offensive
uid	INT	The id of the user who reported the user as offensive
reason	STRING	The reason why the user was reported as offensive (if provided by the user)

Field	Description	Possible Values