Accounts Calls
Info! Do you have any questions on our EPowerEmail API? Write to us at
[email protected]
/account/viewUserDetail
view User Details
Example Call
<?php
try {
require_once 'PowerEPowerEmailMTA_PHP/PowerEPowerEmail.php';
$PowerEPowerEmail= new PowerEPowerEmail('owner_id', 'token', 'PowerEPowerEmailTES_APP_DOMAIN');
$result = $PowerEPowerEmail->settings->viewUserDetail();
print_r($result);
/*
Array
(
[status] => "success"
[smtp_list] => array(
[name] => "john yu"
[ePowerEmail] => "[email protected]"
[mobile] => 9999999999
[create_date] => 67457775764
[allowed_speed] => 300
[reputation] => "50%"
)
)
/*
} catch (PowerEPowerEmail_Error $e) {
// PowerEPowerEmailerrors are thrown as exceptions
echo 'A PowerEPowerEmailerror occurred: " . get_class($e) . " - " . $e->getMessage();
}
?>
Example Success Response
Array
(
[status] => "success"
[smtp_list] => array(
[name] => "john yu",
[ePowerEmail] => "[email protected]",
[mobile] => 9999999999,
[create_date] => 67457775764,
[allowed_speed] => 300
[reputation] => "50%",
)
)
Example Error Response
Array
(
[status] => "error",
[code] => -1,
[name] => "AuthenticationError",
[message] => Token MissMatch,
)
| Parameters |
| owner_id* string |
a valid PowerEPowerEmailUser Id |
| token* string |
a valid token |
| SendCleanTES_APP_DOMAIN* string |
a valid SendCleanTES APP DOMAIN |
* compulsory field
| Return Value: Success |
| struct |
the results of User Details
| status string |
always success |
| user_data[]struct |
information of user details
| name string |
user's name |
| ePowerEmail string |
user's ePowerEmail |
| mobile string |
user's mobile no. |
| allowed_speed integer |
user's allowed speed |
| reputation string |
user's reputation in % |
| create_date integer |
create date in seconds |
|
|
|
|
| Return Value: Error |
| struct |
the error results when attempt to get User Details
| statusstring |
error |
| messagestring |
human readable message |
| type string |
one of the error type as bellow table |
|
|
| Error types |
| ValidationError |
The parameters passed to the API call are invalid or not provided when required. |
| GeneralError |
An unexpected errors occurred processing the request. PowerEPowerEmailDevelopers will be notified. |
| AuthenticationError |
Provided owner_id and token was not matched. |
