users.md

Users

Instantiate the required library class

$http = new \Romby\Box\Http\Adapters\GuzzleHttpAdapter(new \GuzzleHttp\Client())
$users = new \Romby\Box\Services\Users($http);

Get the Current User’s Information

/* @param string $token the OAuth Token.
 * @return array the user.
 */
$users->me($token);

As-User

/* Not Implemented */

Get All Users in an Enterprise

/* @param string $token the OAuth Token.
 * @return array the users.
 */
$users->all($token);

Create an Enterprise User

/* @param string $token      the OAuth Token.
 * @param string $login      the email address this user uses to login
 * @param string $name       the name of this user.
 * @param array  $properties the properties of the user.
 * @return array the new user.
 */
$users->create($token, $login, $name, $properties = []);

Get a User’s Information

/* @param string $token the OAuth Token.
 * @param int    $id    the ID of the user.
 * @return array the user's information.
 */
$users->get($token, $id);

Update a User’s Information

/* @param string $token      the OAuth Token.
 * @param int    $id         the ID of the user.
 * @param array  $properties the properties to update.
 * @return array the updated user.
 */
$users->update($token, $id, $properties);

Delete an Enterprise User

/* @param string $token the OAuth Token.
 * @param int    $id    the ID of the user.
 * @return void
 */
$users->delete($token, $id);

Invite Existing User to Join Enterprise

/* Not Implemented */

Move Folder into Another User’s Folder

/* Not Implemented */

Changing a User’s Primary Login

/* Not Implemented */

Get All Email Aliases for a User

/* @param string $token the OAuth Token.
 * @param int    $id    the ID of the user.
 * @return array the email aliases.
 */
$users->getAllEmailAliases($token, $id);

Add an Email Alias for a User

/* @param string $token the OAuth Token.
 * @param int    $id    the ID of the user.
 * @param string $alias the email alias.
 * @return array the response.
 */
$users->createEmailAlias($token, $id, $alias);

Remove an Email Alias from a User

/* Not Implemented */