Users

User accounts: creation, settings, limits, quota and deletion.

📄️ List users

Lists users with paging. The results can be filtered by username or address, forward target, tags and metadata.

📄️ Create a user

Creates a new user account and its default mailboxes. If an address is given, it is registered as the main address of the user.

📄️ Resolve a username to a user ID

Returns the ID of the user with the given username.

📄️ Get user details

Returns the settings, limits with current usage, and 2FA status of a user.

📄️ Update a user

Updates the settings and limits of a user. Only the fields present in the request are changed.

📄️ Delete a user

Deletes user and address entries from DB and schedules a background task to delete messages. You can call this method several times even if the user has already been deleted, in case there are still some pending messages.

📄️ Log out a user

Closes all IMAP sessions of the user. The optional reason is shown to the connected IMAP clients.

📄️ Recalculate quota for a user

Recalculates quota usage for a User. Normally not needed, only use it if quota numbers are way off. This method is not transactional, so if the user is currently receiving new messages then the resulting value is not exact.

📄️ Recalculate quota for all users

Recalculates quota usage for all Users. Normally not needed, only use it if quota numbers are way off. This method is not transactional, so if the user is currently receiving new messages then the resulting value is not exact.

📄️ Reset the password of a user

Generates a new temporary password for a User. Additionally it removes all two-factor authentication settings

📄️ Get recovery info for a deleted user

Returns what can be recovered for a user that is scheduled for deletion: the deletion time, storage usage and the addresses that are still free to restore.

📄️ Cancel a user deletion

Use this endpoint to cancel a timed deletion task scheduled by DELETE /user/{id}. If user data is not yet deleted then the account is fully recovered, except any email addresses that might have been already recycled

📄️ Open the change stream

This api call returns an EventSource response. Listen on this stream to get notifications about changes in messages and mailboxes. Returned events are JSON encoded strings