Procedural File: dh-api.php

bool dhapi_dhapi_panelConnect( )

This actually connects to the panel. Three steps:

1. connect to the start page and gets the cookies,
2. send credentials to authenticate and get the panel,
3. reget the panel, in case of loss (...?)

Tags:

void dhapi_dhapi_panelDisconnect( )

This function disconnects from the panel (deletes the cookie associated with the connection).

mixed dhapi_getSecurityKey( string $dhapi_page)

This function takes the HTML of the page and returns the security hash contained in the hidden form field "security key".

Tags:

Parameters

string

$dhapi_page

The HTML of the page returned by cURL.

bool dhapi_panelEmailCheck( string $email)

This function checks if an email address already exists. It takes the address as parameter and checks for USER in DOMAIN.

Tags:

Parameters

string

$email

This is the email address to check.

bool dhapi_panelEmailCreate( string $email, string $redirect, mixed $redirect_only, mixed $name, string $pass, mixed $limMB, bool $warning, int $rem_qty, int $rem_age, bool $rem_new, mixed $rem_fol, bool $rem_mai)

This function creates a new email account. Steps:

1. Get the "Create New Email Address" page to extract the security_key.
2. Post the variables to the "?" page.
3. Extract from the result page "error" or "success"

Tags:

Parameters

string	$email	(input "text") The email address, like user@example.com. The hashing is done inside the function.
string	$redirect	(input "textarea") The email address(es) to redirect the new one to, or empty (""). One or many line-separated addresses (NOTE: is this \\n, \\r, mix?).
mixed	$redirect_only	(input "hidden") Boolean "false" creates a normal inbox (also with forward capabilities) ; boolean "true" creates a forward-only email-address (no actual inbox is created) ; string "null" creates a "garbage email address. Warning : Last two value dump gecos and other values...
mixed	$name	(input "text") The "name" (ex: John Doe), facultative.
string	$pass	(input "text") The password for this account. It is used twice, so have it confirmed/checked before. Min 6 chars. TODO: Max?
mixed	$limMB	(input "text") Limit value of disk usage (in MB or empty), or "false".
bool	$warning	(input "checkbox") The "email me if my usage is within 10% of my limit (or 100MB, whichever is smaller)".
int	$rem_qty	(input "text") Remove read messages when inbox reaches this message quantity (max 2000). Set to false for 0. NOTE: MIN:0, MAX:2000.
int	$rem_age	(input "text") Remove read messages older than this numbers of days (max 9999). Set to false for 0. NOTE: MIN:0, MAX:9999.
bool	$rem_new	(input "checkbox") Remove even unread messages.
mixed	$rem_fol	(input "text") Save removed messages in this folder. Leave empty or set to false to really deleted them. NOTE: This will be formatted with imap_utf7_encode() so warn the user if input does not match formatted.
bool	$rem_mai	(input "checkbox") Email me when messages are removed.

bool dhapi_panelEmailDelete( string $email)

This functions deletes PERMANENTLY an email account and all its messages First connects to the "Manage email" page and get the security code; Then requests the delete-email URI.

Tags:

Parameters

string

$email

The email address to delete.

bool dhapi_panelEmailEdit( string $email, string $redirect, mixed $redirect_only, mixed $name, string $pass, mixed $limMB, bool $warning, int $rem_qty, int $rem_age, bool $rem_new, mixed $rem_fol, bool $rem_mai)

This function edits an existing email account. Steps:

1. Get the "edit" page to extract the security_key.
2. Post the variables into the "?" page.
3. Extract from the result page...

Tags:

Parameters

string	$email	(input "text") The email address (user@domain) to edit.
string	$redirect	(input "text") The email address(es) to redirect this one, or empty (""). One or many line-separated addresses (NOTE: is this \\n, \\r, mix?).
mixed	$redirect_only	(input "hidden") Boolean "false" creates a normal inbox (also with forward capabilities) ; boolean "true" creates a forward-only email-address (no actual inbox is created) ; string "null" creates a "garbage email address. Warning : Last two value dump gecos and other values...
mixed	$name	(input "text") The "name" (ex: John Doe), facultative.
string	$pass	(input "text") The password for the account. It is used twice, so have it confirmed/checked before. Min 6 chars. TODO: Max?
mixed	$limMB	(input "text") Limit value of disk usage (in MB or empty), or "false".
bool	$warning	(input "checkbox") The "email me if my usage is within 10% of my limit (or 100MB, whichever is smaller)".
int	$rem_qty	(input "text") Remove read messages when inbox reaches this message quantity (max 2000). Set to false for 0. NOTE: MIN:0, MAX:2000.
int	$rem_age	(input "text") Remove read messages older than this numbers of days (max 9999). Set to false for 0. NOTE: MIN:0, MAX:9999.
bool	$rem_new	(input "checkbox") Remove even unread messages.
mixed	$rem_fol	(input "text") Save removed messages in this folder. Leave empty or set to false to really deleted them. NOTE: This will be formatted with imap_utf7_encode() so warn the user if input does not match formatted.
bool	$rem_mai	(input "checkbox") Email me when messages are removed.

void dhapi_showCurlErrors( $dhapi_curlhan, mixed $chan)

This function output eventuals cURL errors.

Parameters

mixed	$chan	This is the result of curl_init().
	$dhapi_curlhan