Download OpenAPI specification:Download
Documentation of the Open-Xchange Cloud-Plugins Rest APIs.
get custom name of user
contextid required | number context id |
userid required | number user id |
Success
Authorization error
User does not exist or custom id not found in user
change user data
contextid required | number context id |
userid required | number user id |
custom | string |
Settings successfully updated
Generic error, e.g. wrong parameters
Authorization error
User does not exist
change user data
contextid required | number context id |
userid required | number user id |
Settings successfully updated
Authorization error
User does not exist
get msisdn of user
contextid required | number context id |
userid required | number user id |
Success
Authorization error
User does not exist or msisdn not set for user
change user data
contextid required | number context id |
userid required | number user id |
msisdn | string |
Settings successfully updated
Generic error, e.g. wrong parameters
Authorization error
User does not exist
change user data
contextid required | number context id |
userid required | number user id |
Settings successfully updated
Authorization error
User does not exist
get uidname of user
search required | string string to search for |
field | string Enum:"UIDNAME" "MSISDN" "CUSTOM" "ANY" field to search into |
Success
Generic error, e.g. wrong parameters
Authorization error
User not found
get uidname of user
contextid required | number context id |
userid required | number user id |
Success
Authorization error
User does not exist
change user data
contextid required | number context id |
userid required | number user id |
uidname | string |
Settings successfully updated
Generic error, e.g. wrong parameters
Authorization error
User does not exist
User does already exist
change user data
contextid required | number context id |
userid required | number user id |
msisdn | string |
custom | Array of string |
Settings successfully updated
At least one setting has been created
Generic error, e.g. wrong parameters
Authorization error
User does not exist
get whole config of the user
contextid required | number context id |
userid required | number user id |
Success
Authorization error
User does not exist
get whole config of the user
contextid required | number context id |
userid required | number user id |
searchpattern required | string Search Pattern to filter the list of returned configurations |
Success
Authorization error
User does not exist
get the forwarding Alias
contextId required | string context id or context name |
alias required | string alias mail address |
Success
Authorization error
Forwarding alias does not exist or context not found
create the forwarding Alias
contextId required | string context id or context name |
alias required | string alias mail address |
recipient | string |
Success
if already exists (without making any changes to the recipients)
Authorization error
Context not found
update the forwarding Alias
contextId required | string context id or context name |
alias required | string alias mail address |
recipient | string |
Success
if already exists (without making any changes to the recipients)
if there is a value present for the forwarding recipient
Authorization error
Forwarding alias does not exist or context not found
delete the forwarding Alias
contextId required | string context id or context name |
alias required | string alias mail address |
Success
Authorization error
Forwarding alias does not exist or context not found
check if the alias exists
contextId required | string context id or context name |
alias required | string alias mail address |
Alias exists
Authorization error
Forwarding alias does not exist or context not found
get the forwarding Aliases in a Context
contextId required | string context id or context name |
Success
Authorization error
Context not found
delete all forwarding Aliases in a context
contextId required | string context id or context name |
Success
Authorization error
Context not found
check if a recipient for an alias exists
contextId required | string context id or context name |
alias required | string alias mail address |
recipient required | string recipient mail address |
Alias exists
Authorization error
Forwarding alias does not exist or context not found
delete the recipient of an alias
contextId required | string context id or context name |
alias required | string alias mail address |
recipient required | string recipient mail address |
Success
Authorization error
Forwarding alias does not exist or context not found
get all data in one request
uid required | string user identifier |
Success
Authorization error
General Error
get the number of new messages since last login
uid required | string user identifier |
Success
Authorization error
General Error
get the current user quota
uid required | string user identifier |
Success
Authorization error
General Error
get 5 recent mails from user
uid required | string user identifier |
Success
Authorization error
General Error
get the number of unread mails in all folders
uid required | string user identifier |
Success
Authorization error
General Error
get the unread message count from INBOX for user
uid required | string user identifier |
Success
Authorization error
General Error
Check whether given domain exists in context
contextid required | number Id of context |
domain required | string Name of explicit domain |
Domain exists
Generic error, e.g. wrong parameters
Authorization error
Domain does not exist
Create given domain in context
contextid required | number Id of context |
domain required | string Name of explicit domain |
Success
Generic error, e.g. wrong parameters
Authorization error
Domain could not be added
Remove given domain from context
contextid required | number Id of context |
domain required | string Name of explicit domain |
Success
Generic error, e.g. wrong parameters
Authorization error
Domain could not be removed
List all explicit mail domains within given context
contextid required | number Id of context |
Success
Generic error, e.g. wrong parameters
Authorization error
Check whether given domain exists in brand
domain required | string Name of explicit domain |
Domain exists
Generic error, e.g. wrong parameters
Authorization error
Domain does not exist
List all explicit mail domains owned by brand
Success
Generic error, e.g. wrong parameters
Authorization error
Retrieve all users with aliases using the given domain
domain required | string Domain name |
Success
Generic error, e.g. wrong parameters
Authorization error
Get the blacklist for user
contextId required | number context id |
userid required | number user id |
Success
Authorization error
Delete the blacklist for user
contextId required | number context id |
userid required | number user id |
Success
Authorization error
Get the filtered blacklist for user
contextId required | number context id |
userid required | number user id |
filter required | string the blacklist filter which can contain wildcard * |
Success
Authorization error
Add blacklist entry for user
contextId required | number context id |
userid required | number user id |
value required | string entry to add |
Success
Authorization error
Delete blacklist entry for user
contextId required | number context id |
userid required | number user id |
value required | string entry to delete |
Success
Authorization error
Get the whitelist for user
contextId required | number context id |
userid required | number user id |
Success
Authorization error
Delete the whitelist for user
contextId required | number context id |
userid required | number user id |
Success
Authorization error
Get the filtered whitelist for user
contextId required | number context id |
userid required | number user id |
filter required | string the whitelist filter which can contain wildcard * |
Success
Authorization error
Add whitelist entry for user
contextId required | number context id |
userid required | number user id |
value required | string entry to add |
Success
Authorization error
Delete whitelist entry for user
contextId required | number context id |
userid required | number user id |
value required | string entry to delete |
Success
Authorization error
Send an "over quota" mail to user
usercontext required | string the user context and user id in the form "userid@contextid" |
quota_threshold | number |
Success
When quota threshold or usercontext are not provided
Authorization error
No acceptable variant
Send an "over quota" mail to user
usercontext required | string the user context and user id in the form "userid@contextid" |
quota_threshold | number |
Success
When quota threshold or usercontext are not provided
Authorization error
No acceptable variant
Send a "disabled send from sending spam" mail to user
usercontext required | string the user context and user id in the form "userid@contextid" |
Success
When usercontext is not provided
Authorization error
When the primary mail account cannot be found
General error
3@4 has no primary mail address
Send a "welcome" mail to user
usercontext required | string the user context and user id in the form "userid@contextid" |
Success
When usercontext is not provided
Authorization error
No acceptable variant