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
{- "custom": [
- "custom1",
- "custom2"
]
}
change user data
contextid required | number context id |
userid required | number user id |
put parameters
custom | string 1 items |
Settings successfully updated
Generic error, e.g. wrong parameters
Authorization error
User does not exist
{- "custom": "string"
}
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789",
- "oxdeliverystatus": "OXAAS"
}
change user data
contextid required | number context id |
userid required | number user id |
Settings successfully updated
Authorization error
User does not exist
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}
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
{- "msisdn": "+49.12345.6789"
}
change user data
contextid required | number context id |
userid required | number user id |
put parameters
msisdn | string 1 items |
Settings successfully updated
Generic error, e.g. wrong parameters
Authorization error
User does not exist
{- "msisdn": "string"
}
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}
change user data
contextid required | number context id |
userid required | number user id |
Settings successfully updated
Authorization error
User does not exist
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}
get class of service 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
{- "classofservice": "cloud_pim"
}
change user data
contextid required | number context id |
userid required | number user id |
put parameters
classofservice | string 1 items |
Settings successfully updated
Generic error, e.g. wrong parameters
Authorization error
User does not exist
{- "classofservice": "string"
}
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "classofservice": "cloud_pim"
}
change user data
contextid required | number context id |
userid required | number user id |
Settings successfully updated
Authorization error
User does not exist
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com"
}
get uidname of user
search required | string string to search for |
field | string Enum: "UIDNAME" "MSISDN" "OXDELIVERYSTATUS" "CUSTOM" "ANY" field to search into |
Success
Generic error, e.g. wrong parameters
Authorization error
User not found
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789",
- "oxdeliverystatus": "OXAAS"
}
get the oxdeliverystatus of user to determine migration status
contextid required | number context id |
userid required | number user id |
Success
Authorization error
User does not exist or oxdeliverystatus not set for user
{- "oxdeliverystatus": "OXAAS"
}
change user data
contextid required | number context id |
userid required | number user id |
put parameters
oxdeliverystatus | string 1 items |
Settings successfully updated
Generic error, e.g. wrong parameters
Authorization error
User does not exist
{- "oxdeliverystatus": "string"
}
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789",
- "oxdeliverystatus": "OXAAS"
}
change user data
contextid required | number context id |
userid required | number user id |
Settings successfully updated
Authorization error
User does not exist
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}
get the oxlegacyref of user to determine migration status
contextid required | number context id |
userid required | number user id |
Success
Authorization error
User does not exist or oxlegacyref not set for user
{- "oxlegacyref": "LEG_1"
}
change user data
contextid required | number context id |
userid required | number user id |
put parameters
oxlegacyref | string 1 items |
Settings successfully updated
Generic error, e.g. wrong parameters
Authorization error
User does not exist
{- "oxlegacyref": "string"
}
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "oxlegacyref": "LEG_1"
}
change user data
contextid required | number context id |
userid required | number user id |
Settings successfully updated
Authorization error
User does not exist
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com"
}
get the oxantiphishing flag of user to determine MTA level antiphishing support
contextid required | number context id |
userid required | number user id |
Success
Authorization error
User does not exist or oxantiphishing not set for user
{- "oxantiphishing": "replace-urls"
}
change user data
contextid required | number context id |
userid required | number user id |
put parameters
oxantiphishing | string 1 items |
Settings successfully updated
Generic error, e.g. wrong parameters
Authorization error
User does not exist
{- "oxantiphishing": "string"
}
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789",
- "oxantiphishing": "replace-urls"
}
change user data
contextid required | number context id |
userid required | number user id |
Settings successfully updated
Authorization error
User does not exist
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789"
}
get uidname of user
contextid required | number context id |
userid required | number user id |
Success
Authorization error
User does not exist
{- "uidname": "johndoe@example.com"
}
change user data
contextid required | number context id |
userid required | number user id |
put parameters
uidname | string 1 items |
Settings successfully updated
Generic error, e.g. wrong parameters
Authorization error
User does not exist
User does already exist
{- "uidname": "string"
}
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789",
- "oxdeliverystatus": "OXAAS"
}
change user data
contextid required | number context id |
userid required | number user id |
post parameters
msisdn | string >= 0 items |
oxdeliverystatus | string >= 0 items |
custom | Array of strings >= 0 items |
Settings successfully updated
At least one setting has been created
Generic error, e.g. wrong parameters
Authorization error
User does not exist
{- "msisdn": "+49.12345.6789",
- "oxdeliverystatus": "OXAAS",
- "custom": [
- "id 1",
- "id 2"
]
}
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789",
- "oxdeliverystatus": "OXAAS"
}
get the antivirus state
contextid required | number context id |
userid required | number user id |
Success
Authorization error
User does not exist
{- "antivirus": true
}
change the users' antivirus state
contextid required | number context id |
userid required | number user id |
put parameters
antivirus | boolean |
Settings successfully updated
Generic error, e.g. missing or wrong parameters
Authorization error
User does not exist
{- "antivirus": true
}
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789",
- "oxdeliverystatus": "OXAAS"
}
get the spamlevel
contextid required | number context id |
userid required | number user id |
Success
Authorization error
User does not exist
{- "spamlevel": "medium"
}
change the users' spamlevel
contextid required | number context id |
userid required | number user id |
put parameters
spamlevel | string |
Settings successfully updated
Generic error, e.g. missing or wrong parameters
Authorization error
User does not exist
{- "spamlevel": "string"
}
{- "context-id": 24,
- "user-id": 42,
- "uidname": "johndoe@example.com",
- "msisdn": "+49.12345.6789",
- "oxdeliverystatus": "OXAAS"
}
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
[- "recipient1@example.com"
]
create the forwarding Alias
contextId required | string context id or context name |
alias required | string alias mail address |
post parameters
recipient | string 1 items |
Success
if already exists (without making any changes to the recipients)
Authorization error
Context not found
{- "recipient": "recipient@example.com"
}
null
update the forwarding Alias
contextId required | string context id or context name |
alias required | string alias mail address |
post parameters
recipient | string 1 items |
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
{- "recipient": "recipient@example.com"
}
null
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
null
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
null
get the forwarding Aliases in a Context
contextId required | string context id or context name |
Success
Authorization error
Context not found
{- "alias@example.com": [
- "recipient1@example.com"
], - "alias2@example.com": [
- "recipient2@example.com"
]
}
delete all forwarding Aliases in a context
contextId required | string context id or context name |
Success
Authorization error
Context not found
null
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
null
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
null
get all data in one request
uid required | string user identifier |
Success
Authorization error
General Error
{- "recentmails": [
- {
- "id": "string",
- "subject": "string",
- "from": "string",
- "seen": true,
- "arrival": 0
}
], - "quota": {
- "mailQuota": {
- "usedQuota": 0,
- "maxQuota": 0
}
}, - "newmessages": {
- "newmessages": 0
}, - "recentmessages": {
- "newmessages": 0
}
}
get the number of new messages since last login in INBOX
uid required | string user identifier |
Success
Authorization error
General Error
{- "newmessages": 0
}
get the current user quota
uid required | string user identifier |
Success
Authorization error
General Error
{- "mailQuota": {
- "usedQuota": 0,
- "maxQuota": 0
}
}
get 5 recent mails from user in INBOX
uid required | string user identifier |
Success
Authorization error
General Error
[- {
- "id": "string",
- "subject": "string",
- "from": "string",
- "seen": true,
- "arrival": 0
}
]
get the number of unread mails in all folders
uid required | string user identifier |
Success
Authorization error
General Error
{- "newmessages": 0
}
get the unread message count from INBOX for user
uid required | string user identifier |
Success
Authorization error
General Error
{- "newmessages": 0
}
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
{- "error": "Error message"
}
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
{- "domain": "example.com"
}
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
{- "error": "Error message"
}
List all explicit mail domains within given context
contextid required | number Id of context |
Success
Generic error, e.g. wrong parameters
Authorization error
{- "domains": [
- "example.com",
- "example.org"
]
}
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
{- "error": "Error message"
}
List all explicit mail domains owned by brand
Success
Generic error, e.g. wrong parameters
Authorization error
{- "domains": [
- "example.com",
- "example.org"
]
}
Retrieve all users with aliases using the given domain
domain required | string Domain name |
Success
Generic error, e.g. wrong parameters
Authorization error
{- "users": [
- {
- "context-id": 42,
- "uidname": "janedoe",
- "aliases": [
- "jane@example.com"
]
}
]
}
Get the blacklist for user
contextId required | number context id |
userid required | number user id |
Success
Authorization error
{- "blacklist": [
- "test@example.com",
- "test2@example.com",
- "@example.com"
]
}
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
{- "blacklist": [
- "test@example.com",
- "test2@example.com",
- "@example.com"
]
}
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
{- "whitelist": [
- "test@example.com",
- "test2@example.com",
- "@example.com"
]
}
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
{- "whitelist": [
- "test@example.com",
- "test2@example.com",
- "@example.com"
]
}
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" |
the user quota threshold
quota_threshold | number |
Success
When quota threshold or usercontext are not provided
Authorization error
No acceptable variant
{- "quota_threshold": 1000
}
{- "mail": "the message content"
}
Send an "over quota" mail to user
usercontext required | string the user context and user id in the form "userid@contextid" |
the user quota threshold
quota_threshold | number |
Success
When quota threshold or usercontext are not provided
Authorization error
No acceptable variant
{- "quota_threshold": 1000
}
{- "mail": "the message content"
}
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
{- "mail": "the message content"
}
Create new announcement
id | integer |
version | integer |
name | string |
msgJsonObject | object |
startDatetime | string <date-time> |
endDatetime | string <date-time> |
timezone | string; |
discardable | boolean |
enabled | boolean |
ownerBrand | string |
brands | Array of strings |
Created
Generic error, e.g. wrong parameters
Authorization error
{- "application/json": {
- "brands": [
- "example.com"
], - "discardable": true,
- "enabled": true,
- "msgJsonObject": {
- "defaultLang": "de",
- "msgsByLang": {
- "de": {
- "message": "Spater hutete zur labsal nah sohlen leisen schale. Zog ige vorpfeifen ist bangigkeit wir eigentlich todesfalle. So la im warmen em freude drohte schade lustig. ",
- "summary": "Bald ist Weihnachten"
}, - "en": {
- "message": "As it so contrasted oh estimating instrument. Size like body some one had. Are conduct viewing boy minutes warrant expense. ",
- "summary": "It's Christmas, soon"
}
}
}, - "name": "The first November Announcement",
- "startDatetime": "2021-11-08T10:00:00",
- "endDatetime": "2021-11-15T10:00:00",
- "timezone": "Europe/Berlin"
}
}
{- "error": "Error message"
}
List all announcements
Success
Generic error, e.g. wrong parameters
Authorization error
[- {
- "brands": [
- "example.com"
], - "discardable": true,
- "enabled": true,
- "endDatetime": "2021-11-15T10:00:00",
- "id": 1,
- "msgJsonObject": {
- "defaultLang": "de",
- "msgsByLang": {
- "de": {
- "message": "Spater hutete zur labsal nah sohlen leisen schale. Zog ige vorpfeifen ist bangigkeit wir eigentlich todesfalle. So la im warmen em freude drohte schade lustig. ",
- "summary": "Bald ist Weihnachten"
}, - "en": {
- "message": "As it so contrasted oh estimating instrument. Size like body some one had. Are conduct viewing boy minutes warrant expense. ",
- "summary": "It's Christmas, soon"
}
}
}, - "name": "The first November Announcement",
- "ownerBrand": "example.com",
- "startDatetime": "2021-11-08T10:00:00",
- "timezone": "Europe/Berlin",
- "version": 1
}
]
Delete an existing announcement
id required | number Announcement id |
Success
Generic error, e.g. wrong parameters
Authorization error
Update an existing announcement
id required | number Announcement id |
id | integer |
version | integer |
name | string |
msgJsonObject | object |
startDatetime | string <date-time> |
endDatetime | string <date-time> |
timezone | string; |
discardable | boolean |
enabled | boolean |
ownerBrand | string |
brands | Array of strings |
Success
Generic error, e.g. wrong parameters
Authorization error
{- "application/json": {
- "brands": [
- "example.com"
], - "discardable": true,
- "enabled": true,
- "id": 1,
- "msgJsonObject": {
- "defaultLang": "de",
- "msgsByLang": {
- "de": {
- "message": "Spater hutete zur labsal nah sohlen leisen schale. Zog ige vorpfeifen ist bangigkeit wir eigentlich todesfalle. So la im warmen em freude drohte schade lustig. ",
- "summary": "Bald ist Weihnachten"
}, - "en": {
- "message": "As it so contrasted oh estimating instrument. Size like body some one had. Are conduct viewing boy minutes warrant expense. ",
- "summary": "It's Christmas, soon"
}
}
}, - "name": "The first November Announcement",
- "startDatetime": "2021-11-08T10:00:00",
- "endDatetime": "2021-11-15T10:00:00",
- "timezone": "Europe/Berlin"
}
}
{- "error": "Error message"
}
Enable an existing announcement
id required | number Announcement id |
Success
Generic error, e.g. wrong parameters
Authorization error
Disable an existing announcement
id required | number Announcement id |
Success
Generic error, e.g. wrong parameters
Authorization error