$client->account
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
The account of the person behind the key or the app: the email notifications they get and the workspaces muted on their phone, their profile photo and username, the apps they connected and the invitations waiting for them. An API key acts for the workspace owner, and an app for the person who connected it.
account->getNotifications
Read your notification settings
getNotifications(?string $apiKey = null): arrayReturns which kinds of email OpenEmail sends the person, as Account, Notifications shows them, and the workspaces whose notifications are muted on their phone. An API key answers for the workspace owner, and an app for the person who connected it.
Parameters
apiKeystringOverrides the client's API key for this call only.
Returns
An array with email, a list with one array for each kind of email (category, label, description, required and enabled), and mutedWorkspaces, a list of workspace ids.
Example
$settings = $client->account->getNotifications(); foreach ($settings['email'] as $setting) { echo $setting['category'], ': ', $setting['enabled'] ? 'on' : 'off', $setting['required'] ? ', always on' : '', PHP_EOL;} echo count($settings['mutedWorkspaces']), ' workspaces muted on the phone', PHP_EOL;Notes
accountandbillingemail are always on, andrequiredsays so.
Also available in
account->setEmailNotification
Turn a kind of email on or off
setEmailNotification(string $category, array $body, ?string $apiKey = null): array'enabled' => false stops OpenEmail sending the person that kind of email, and true starts it again. activity and product can be turned off. account and billing cannot, and asking to is a 422 invalid_parameter on category.
Parameters
categorystringRequiredaccount,billing,activityorproduct, also inOpenEmail\Constants\EmailNotificationCategories.enabledboolRequiredTrue to receive that email, false to stop it.
apiKeystringOverrides the client's API key for this call only.
Returns
The same array as account->getNotifications, as it is after the change.
Example
use OpenEmail\Constants\EmailNotificationCategories; $settings = $client->account->setEmailNotification(EmailNotificationCategories::PRODUCT, ['enabled' => false]); foreach ($settings['email'] as $setting) { echo $setting['label'], ': ', $setting['enabled'] ? 'on' : 'off', PHP_EOL;}Notes
Retried automatically on network failure, since the same setting sent twice changes nothing.
Also available in
account->setPushMuted
Mute a workspace on your phone
setPushMuted(string $workspaceId, array $body, ?string $apiKey = null): array'muted' => true stops the phone app notifying the person about the mail of one workspace, on every phone they signed in on, and false lets it notify them again.
Parameters
workspaceIdstringRequiredA workspace id from
workspaces->list.mutedboolRequiredTrue to mute it, false to let it notify again.
apiKeystringOverrides the client's API key for this call only.
Returns
The same array as account->getNotifications, with the new mutedWorkspaces.
Example
$settings = $client->account->setPushMuted('10417196-e324-4283-af98-66ec62167c47', ['muted' => true]); echo 'Muted on the phone: ', implode(', ', $settings['mutedWorkspaces']), PHP_EOL;Notes
A workspace the person cannot open is a 404
resource_not_found.Retried automatically on network failure, since the same setting sent twice changes nothing.
Also available in
account->setPhoto
Set your profile photo
setPhoto(mixed $data, ?string $contentType = null, ?string $apiKey = null): arraySends the image bytes as the request body, replacing the person's profile photo, as Account, Profile does. PNG, JPEG, WebP and GIF are accepted, up to 5 MB. The server fits the image into a 512 pixel square, stores it as WebP and keeps the first frame of an animation.
data is a string of bytes, a stream resource, an SplFileInfo or a PSR-7 stream or uploaded file. The type is read from contentType:, or when that is left out from the media type a PSR-7 uploaded file declares, or from the extension of the file an SplFileInfo or a stream points at. Without any of these the bytes go as application/octet-stream and the server refuses them with 422 invalid_image.
Parameters
datastring|resource|SplFileInfo|StreamInterfaceRequiredThe image: a string of bytes, a stream resource, an
SplFileInfoor a PSR-7 stream or uploaded file.contentTypestringimage/png,image/jpeg,image/webporimage/gif. Required for a string of bytes, and for a file or stream whose name does not end in.png,.jpg,.jpeg,.webpor.gif.apiKeystringOverrides the client's API key for this call only.
Returns
An array with the new url.
Example
$photo = $client->account->setPhoto(file_get_contents('photo.jpg'), contentType: 'image/jpeg'); echo 'New photo at ', $photo['url'], PHP_EOL; $photo = $client->account->setPhoto(new \SplFileInfo('avatar.png')); echo 'Replaced by ', $photo['url'], PHP_EOL;Notes
A busy image service answers 503
image_busy, which the SDK retries like any other 503.Every upload gets a new URL, so a cached old photo never shows under the new one.
Also available in
- API
PUT /account/photo- TypeScript
account.setPhoto()- Python
account.set_photo()- Ruby
account.set_photo- CLI
openemail account set-photo
account->removePhoto
Remove your profile photo
removePhoto(?string $apiKey = null): arrayRemoves the profile photo and deletes the stored image, so the app shows the person's initials again. Removing it when there is none changes nothing.
Parameters
apiKeystringOverrides the client's API key for this call only.
Returns
An array with url null.
Example
$photo = $client->account->removePhoto(); echo $photo['url'] ?? 'No photo, the app shows initials', PHP_EOL;Notes
Safe to replay, so the SDK retries it after a network failure.
Also available in
account->getUsername
Read your username
getUsername(?string $apiKey = null): arrayReturns the person's username, whether they chose it or it was made for them from their name, and the free address it gives them when this deployment offers one. A username the person chose never changes.
Parameters
apiKeystringOverrides the client's API key for this call only.
Returns
An array with username, chosen and address.
Example
$username = $client->account->getUsername(); echo $username['username'], $username['chosen'] ? ', chosen' : ', made from the name', PHP_EOL; if ($username['address'] !== null) { echo 'Free address: ', $username['address'], PHP_EOL;}Notes
The first read makes a username for an account that has none.
Also available in
account->checkUsername
Check a username
checkUsername(string $username, ?string $apiKey = null): arraySays whether the person could choose a username, without choosing it, and why not when they could not. The username is lowercased and its spaces become dots before it is checked, as the app does, and username in the answer is the form that was checked.
Parameters
usernamestringRequiredUp to 60 characters before it is tidied.
apiKeystringOverrides the client's API key for this call only.
Returns
An array with username, status, available and a message that says why.
Example
use OpenEmail\Constants\UsernameStatuses; $check = $client->account->checkUsername('Ada Lovelace'); if ($check['available']) { echo $check['username'], ' is free', PHP_EOL;} elseif ($check['status'] === UsernameStatuses::CURRENT) { echo 'That is already your username', PHP_EOL;} else { echo $check['message'], PHP_EOL;}Notes
statusiscurrentfor the username the person already has, andavailableis false for it.
Also available in
account->setUsername
Choose your username
setUsername(string $username, ?string $apiKey = null): arraySets the person's username for good, and with it their free address. Once chosen it never changes: a second choice is refused with 409 username_locked. A username another account has is a 409 username_taken, and one that is too short, too long, reserved or not lowercase letters, numbers and single dots is a 422 invalid_parameter on username. Check one first with account->checkUsername.
Parameters
usernamestringRequired3 to 30 lowercase letters, numbers and single dots once it is tidied.
apiKeystringOverrides the client's API key for this call only.
Returns
An array with username, chosen set to true and address.
Example
use OpenEmail\Exception\ConflictException; try { $username = $client->account->setUsername('ada.lovelace'); echo 'You are ', $username['username'], ', with the address ', $username['address'] ?? 'none', PHP_EOL;} catch (ConflictException $error) { echo $error->errorCode === 'username_locked' ? 'Your username is already chosen' : 'That username is taken', PHP_EOL;}Notes
Not retried automatically: a retry after a lost response would be refused with
username_locked, because the first call already chose it.
Also available in
account->listConnectedApps
List your connected apps
listConnectedApps(?string $apiKey = null): arrayReturns every app the person connected with OAuth, as Account, Connected apps lists them: the workspace and the permissions each may reach, until when, how many tokens it holds, and until when it may make changes that ask for a verification code without one. current marks the app making the call.
What an app may reach is changed in the app, never through an app.
Parameters
apiKeystringOverrides the client's API key for this call only.
Returns
A list of arrays, each with clientId, name, kind, status, current, grant, tokenCount and elevatedUntil.
Example
foreach ($client->account->listConnectedApps() as $app) { echo $app['name'], $app['current'] ? ' (this app)' : '', ': ', $app['status'], ', ', $app['tokenCount'], ' tokens', PHP_EOL; echo ' reaches ', $app['grant']['workspaceName'] ?? 'nothing', ' until ', $app['accessUntil'] ?? 'it is removed', PHP_EOL;}Notes
A sign-in of the command line tool shows with
kindset tocli, and its device incliDevice.
Also available in
account->revokeConnectedApp
Remove a connected app
revokeConnectedApp(string $clientId, ?string $apiKey = null): arrayDeletes every token the app holds and the access the person gave it, so its next call is refused and it has to ask again, as removing it in Account, Connected apps does. Removing the app making the call disconnects it.
Parameters
clientIdstringRequiredThe app's
clientIdfromaccount->listConnectedApps.apiKeystringOverrides the client's API key for this call only.
Returns
An array with clientId, revoked set to true and tokensRevoked.
Example
foreach ($client->account->listConnectedApps() as $app) { if ($app['tokenCount'] === 0 && !$app['current']) { $revoked = $client->account->revokeConnectedApp($app['clientId']); echo 'Removed ', $app['name'], ', ', $revoked['tokensRevoked'], ' tokens revoked', PHP_EOL; }}Notes
An app the person never connected is a 404
resource_not_found.Not retried automatically. A retry after a lost response is a 404, since the app is already gone.
Also available in
account->listInvitations
List your invitations
listInvitations(?string $apiKey = null): arrayReturns the invitations to join a workspace that are waiting for the address the person signs in with, oldest first. Expired, accepted and withdrawn ones are left out. The invitations a workspace sent are members->listInvitations instead.
Parameters
apiKeystringOverrides the client's API key for this call only.
Returns
A list of arrays, each with id, workspaceId, workspaceName, roleName, inviterName, addresses, expiresAt and createdAt.
Example
foreach ($client->account->listInvitations() as $invitation) { echo $invitation['inviterName'], ' invited you to ', $invitation['workspaceName'], ' as ', $invitation['roleName'], PHP_EOL; echo ' ', $invitation['addresses'], ' addresses, answer by ', $invitation['expiresAt'], PHP_EOL;}Notes
addressescounts the addresses and the whole domains the invitation gives together.
Also available in
account->acceptInvitation
Accept an invitation
acceptInvitation(string $invitationId, ?bool $activate = null, ?string $apiKey = null): arrayJoins the workspace with the role and the addresses the invitation gives, as accepting it in the app or from its link does. activate: also makes it the workspace the app opens for the person.
A workspace that asks everyone in it to sign in with two-factor authentication is refused with 403 two_factor_required until the person turns it on. An invitation that expired, was withdrawn or went to another address is a 422, and one that is not waiting any more a 404 invitation_not_found.
Parameters
invitationIdstringRequiredAn invitation id from
account->listInvitations.activateboolTrue to make it the workspace the app opens. Defaults to false.
apiKeystringOverrides the client's API key for this call only.
Returns
An array with workspaceId, workspaceName, addressesGranted, domainsGranted and activated.
Example
use OpenEmail\Exception\PermissionException; try { $joined = $client->account->acceptInvitation('winv_6bb640f5b99e47deb758f1f5', activate: true); echo 'Joined ', $joined['workspaceName'], ' with ', $joined['addressesGranted'], ' addresses and ', $joined['domainsGranted'], ' domains', PHP_EOL;} catch (PermissionException $error) { echo $error->errorCode === 'two_factor_required' ? 'Turn on two-factor sign-in first' : $error->getMessage(), PHP_EOL;}Notes
Retried automatically on network failure, since accepting an invitation the person already accepted succeeds again and changes nothing.
Also available in
account->declineInvitation
Decline an invitation
declineInvitation(string $invitationId, ?string $apiKey = null): arrayTurns the invitation down, so its link stops working, and tells whoever sent it. It cannot be taken back: they have to invite the person again. An invitation the person already accepted is refused with 409 invitation_accepted.
Parameters
invitationIdstringRequiredAn invitation id from
account->listInvitations.apiKeystringOverrides the client's API key for this call only.
Returns
An array with the invitation id and declined set to true.
Example
$declined = $client->account->declineInvitation('winv_6bb640f5b99e47deb758f1f5'); if ($declined['declined']) { echo 'Declined, and the sender has been told', PHP_EOL;}Notes
Retried automatically on network failure, since declining twice changes nothing.