OX App Suite

https://documentation.open-xchange.com
Admin
OX App Suite is a comprehensive open-source collaboration platform providing email, calendar,...
Tokens:30,742
Snippets:336
Trust Score:9.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Access App Suite URL

Source: https://documentation.open-xchange.com/appsuite/operation-guides

Example URL to access the App Suite web application after setup. Ensure the port matches your NodePort configuration.

```bash
https://as8.lab.test:30443/appsuite/

```

--------------------------------

### Install App Suite and Batteries

Source: https://documentation.open-xchange.com/appsuite/operation-guides

Run the installation script (Bash or PowerShell) to deploy App Suite and all its managed components ('batteries').

```bash
./install.sh

```

--------------------------------

### Clone Operation Guides Repository

Source: https://documentation.open-xchange.com/appsuite/operation-guides

Clone the App Suite operation guides repository to your local machine.

```bash
git clone https://gitlab.open-xchange.com/appsuite/operation-guides.git

```

--------------------------------

### Install Python Dependencies

Source: https://documentation.open-xchange.com/appsuite/operation-guides

Install the required Python modules from the requirements.txt file into the virtual environment.

```bash
v/bin/pip install -r requirements.txt

```

--------------------------------

### Install App Suite 8 with Helm

Source: https://documentation.open-xchange.com/appsuite/operation-guides

Use this command for a minimal App Suite 8 installation, assuming all prerequisites are met. The `values.yaml` file is crucial for environment-specific configuration.

```bash
helm install as8 oci://registry.open-xchange.com/appsuite/charts/appsuite --version 8.x.y --values values.yaml

```

--------------------------------

### Update Operation Guides Git Repository

Source: https://documentation.open-xchange.com/appsuite/operation-guides

Standard procedure for pulling updates for the operation guides, checking for breaking changes, and re-rendering the lab configuration.

```bash
git pull

```

--------------------------------

### Get Forwarding Alias Response Sample (Deprecated)

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Example response for retrieving a forwarding alias, showing a list of recipients.

```json
[
  "recipient1@example.com"
]
```

--------------------------------

### Get the whitelist for user

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the whitelist for a specific user within a given context. Requires administrator privileges.

```APIDOC
## Get the whitelist for user

### Description
Retrieves the whitelist for a specific user within a given context. Requires administrator privileges.

### Method
GET

### Endpoint
/oxaas/v1/admin/whitelist/{contextid}/{userid}

### Parameters
#### Path Parameters
- **contextid** (number) - Required - The context ID.
- **userid** (number) - Required - The user ID.

### Responses
#### Success Response (200)
Success
- **whitelist** (array) - A list of whitelisted email addresses or domains.

#### Error Response (401)
Authorization error
```

--------------------------------

### Get User Whitelist

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the entire whitelist for a specific user within a given context. Requires context and user IDs.

```json
{
  "whitelist": [
    "test@example.com",
    "test2@example.com",
    "@example.com"
]

}
```

--------------------------------

### Get Announcements Response Sample

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

This is a sample JSON response when retrieving announcements. It includes details like brands, dates, messages, and versions.

```json
[
  {
    "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
}

]
```

--------------------------------

### Get user blacklist

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the blacklist for a specific user within a given context.

```APIDOC
## Get the blacklist for user
### Description
Get the blacklist for user
### Method
GET
### Endpoint
/oxaas/v1/admin/blacklist/{contextid}/{userid}
### Parameters
#### Path Parameters
- **contextId** (number) - Required - context id
- **userid** (number) - Required - user id
### Responses
#### Success Response (200)
- **blacklist** (array) - A list of blacklisted email addresses or domains.
  - (string) - A blacklisted entry.
#### Error Response (401)
Authorization error
```

--------------------------------

### Get oxlegacyref API Response Sample

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

This JSON sample shows the response when retrieving the oxlegacyref for a user, indicating migration status.

```json
{
  "oxlegacyref": "LEG_1"
}
```

--------------------------------

### Get oxantiphishing API Response Sample

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

This JSON sample illustrates the response when retrieving the oxantiphishing status for a user.

```json
{
  "oxantiphishing": "replace-urls"
}
```

--------------------------------

### Get antivirus state

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the antivirus state for a specific user within a context.

```APIDOC
## get the antivirus state

### Description
Retrieves the antivirus state for a specific user within a context.

### Method
GET

### Endpoint
/oxaas/v1/admin/contexts/{contextid}/users/{userid}/antivirus

### Path Parameters
- **contextid** (number) - Required - The ID of the context.
- **userid** (number) - Required - The ID of the user.

### Responses
- **200** - Success.
- **401** - Authorization error.
- **404** - User does not exist.
```

--------------------------------

### Get User Blacklist

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the blacklist for a specific user within a given context ID. Requires context administrator authorization.

```json
{
  "blacklist": [
    "test@example.com",
    "test2@example.com",
    "@example.com"
]

}
```

--------------------------------

### Get App Suite Ingress Service

Source: https://documentation.open-xchange.com/appsuite/operation-guides

Use this command to retrieve the NodePort service details for the istio-ingressgateway, which is used for web UI access.

```bash
% kubectl get service -n as8 istio-ingressgateway
NAME                   TYPE       CLUSTER-IP     EXTERNAL-IP   PORT(S)                                      AGE
istio-ingressgateway   NodePort   10.233.13.12   <none>        15021:30021/TCP,80:30080/TCP,443:30443/TCP   18m

```

--------------------------------

### Get User Delivery Status

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the delivery status for a specific user within a given context.

```APIDOC
## GET /oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxdeliverystatus

### Description
Retrieves the oxdeliverystatus of a user to determine migration status.

### Method
GET

### Endpoint
/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxdeliverystatus

### Parameters
#### Path Parameters
- **contextid** (number) - Required - Context ID
- **userid** (number) - Required - User ID

### Responses
#### Success Response (200)
- **oxdeliverystatus** (string) - The delivery status of the user.

#### Response Example (200)
```json
{
  "oxdeliverystatus": "OXAAS"
}
```
```

--------------------------------

### Get All Forwarding Aliases in Context (Deprecated)

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves a list of all forwarding aliases configured within a specific context. This endpoint is deprecated.

```http
GET /api/oxaas/v1/admin/forwards/{contextId}
```

--------------------------------

### Get User Class of Service

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the class of service for a specific user within a given context.

```APIDOC
## GET /oxaas/v1/admin/contexts/{contextid}/users/{userid}/classofservice

### Description
Retrieves the class of service for a specific user.

### Method
GET

### Endpoint
/oxaas/v1/admin/contexts/{contextid}/users/{userid}/classofservice

### Parameters
#### Path Parameters
- **contextid** (number) - Required - Context ID
- **userid** (number) - Required - User ID

### Responses
#### Success Response (200)
- **classofservice** (array of strings) - The class of service assigned to the user.

#### Response Example (200)
```json
{
  "classofservice": [
    "cloud_pim"
  ]
}
```
```

--------------------------------

### Retrieve All Forwarding Aliases Response

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

This is an example of a successful response when retrieving all forwarding aliases for a given context. It lists aliases and their associated recipients and spamlevels.

```json
{
  "fwd1@example.com": {
    "recipients": [
      "jane@example.com",
      "john@example.com"
],
    "spamlevel": "medium"
},
  "fwd2@example.com": {
    "recipients": [
      "peter@example.com"
],
    "spamlevel": "medium"
}

}
```

--------------------------------

### Get Quota Mode

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the quota mode setting for a specific user within a context. Requires context administrator authorization.

```APIDOC
## Get Quota Mode

### Description
Retrieves the quota mode setting for a specific user within a context.

### Method
GET

### Endpoint
/oxaas/v1/admin/contexts/{contextid}/users/{userid}/quotamode

### Parameters
#### Path Parameters
- **contextid** (number) - Required - context id
- **userid** (number) - Required - user id

### Response
#### Success Response (200)
- **quotamode** (string) - The current quota mode (e.g., "unified", "default").

#### Response Example
```json
{
  "quotamode": "unified"
}
```

#### Error Responses
- **401**: Authorization error
- **404**: User does not exist
```

--------------------------------

### Get Forwarding Aliases in Context (Deprecated)

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves a list of all forwarding aliases within a specified context. This endpoint is deprecated.

```APIDOC
## GET /api/oxaas/v1/admin/forwards/{contextId} (Deprecated)

### Description
Gets the forwarding aliases in a context.

### Method
GET

### Endpoint
/api/oxaas/v1/admin/forwards/{contextId}

### Path Parameters
- **contextId** (string) - Required - Context ID or context name.

### Authorizations
_contextAdminAuth_

### Responses
- **200** - Success.
- **403** - Authorization error.
```

--------------------------------

### Get OX Legacy Reference

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the OXLegacyRef for a user to determine migration status. Requires context administrator authorization.

```APIDOC
## GET /oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxlegacyref

### Description
Gets the OXLegacyRef of a user to determine migration status.

### Method
GET

### Endpoint
/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxlegacyref

### Parameters
#### Path Parameters
- **contextid** (number) - Required - context id
- **userid** (number) - Required - user id

### Responses
#### Success Response (200)
Success

#### Error Response (401)
Authorization error

#### Error Response (404)
User does not exist or oxlegacyref not set for user
```

--------------------------------

### Get User Delivery Status

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the oxdeliverystatus for a specific user to determine migration status. Requires contextAdminAuth.

```json
{
  * "oxdeliverystatus": "OXAAS"

}
```

--------------------------------

### Get User Quota Mode

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the quota mode setting for a specific user. Requires context ID and user ID as path parameters.

```json
{
  "quotamode": "unified"
}
```

--------------------------------

### Get User Class of Service

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the class of service for a specific user within a given context. Requires contextAdminAuth.

```json
{
  * "classofservice": [
    * "cloud_pim"
]

}
```

--------------------------------

### Get the antivirus state of a user

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieve the current antivirus state for a specified user within a context. This operation requires contextAdminAuth authorization.

```json
{
  "antivirus": true

}
```

--------------------------------

### Get user quota

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the current user's mail quota, including used and maximum quota. Requires tenant authorization.

```json
{
  "mailQuota": {
    "usedQuota": 0,
    "maxQuota": 0
}

}
```

--------------------------------

### Get all mail data

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves all mail data for a given user, including recent emails, quota information, and new message counts. Requires tenant authorization.

```json
{
  "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 filtered whitelist for user

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves a filtered whitelist for a specific user within a given context, based on a provided filter string. Requires administrator privileges.

```APIDOC
## Get the filtered whitelist for user

### Description
Retrieves a filtered whitelist for a specific user within a given context, based on a provided filter string. Requires administrator privileges.

### Method
GET

### Endpoint
/oxaas/v1/admin/whitelist/{contextid}/{userid}/{filter}

### Parameters
#### Path Parameters
- **contextid** (number) - Required - The context ID.
- **userid** (number) - Required - The user ID.
- **filter** (string) - Required - The whitelist filter, which can contain wildcards.

### Responses
#### Success Response (200)
Success
- **whitelist** (array) - A list of whitelisted email addresses or domains matching the filter.

#### Error Response (401)
Authorization error
```

--------------------------------

### Apache Virtual Host for TLS Termination and WebSockets

Source: https://documentation.open-xchange.com/appsuite/operation-guides/transition.html

Configure Apache as an external proxy for TLS termination and WebSocket support. This setup routes traffic to backend servers, handling both standard HTTP and WebSocket connections.

```apache
<VirtualHost *:443>
    ServerAdmin webmaster@example.tld

    ServerName as8.example.tld

    SSLEngine on
    SSLCertificateFile /path/to/as8.cert.pem
    SSLCertificateKeyFile /path/to/as8.key.pem

    ProxyRequests Off
    ProxyStatus On
    ProxyPreserveHost On
    RequestHeader set X-Forwarded-Proto "https"

    <Proxy balancer://as8ws>
        Require all granted
        BalancerMember ws://kubelet1:30080 timeout=1900 smax=0 ttl=60 retry=60 loadfactor=50 keepalive=On
        BalancerMember ws://kubelet2:30080 timeout=1900 smax=0 ttl=60 retry=60 loadfactor=50 keepalive=On
        BalancerMember ws://kubelet3:30080 timeout=1900 smax=0 ttl=60 retry=60 loadfactor=50 keepalive=On
        SetEnv proxy-initial-not-pooled
        SetEnv proxy-sendchunked
    </Proxy>
    ProxyPass /appsuite/rt2 balancer://as8ws/appsuite/rt2
    ProxyPass /socket.io balancer://as8ws/socket.io

    <Proxy balancer://as8>
        Require all granted
        BalancerMember http://kubelet1:30080 timeout=100 smax=0 ttl=60 retry=60 loadfactor=50
        BalancerMember http://kubelet2:30080 timeout=100 smax=0 ttl=60 retry=60 loadfactor=50
        BalancerMember http://kubelet3:30080 timeout=100 smax=0 ttl=60 retry=60 loadfactor=50
        SetEnv proxy-initial-not-pooled
        SetEnv proxy-sendchunked
    </Proxy>
    ProxyPass /appsuite/ balancer://as8/appsuite/
    # more endpoints required depending on feature scope
    # note: be sure to protect sensitive endpoints like /webservices if you expose them here 
</VirtualHost>
```

--------------------------------

### Set Up Python Virtual Environment

Source: https://documentation.open-xchange.com/appsuite/operation-guides

Navigate to the cloned repository and create a Python virtual environment. Upgrade pip and wheel within the environment.

```bash
cd operation-guides
python3 -mvenv v
v/bin/pip install --upgrade pip wheel

```

--------------------------------

### Get User Spam Level

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the current spam level setting for a specific user within a context. Requires context ID and user ID as path parameters.

```json
{
  "spamlevel": "medium"
}
```

--------------------------------

### Navigate to Rendered Lab Directory

Source: https://documentation.open-xchange.com/appsuite/operation-guides

Change the current directory to the 'rendered/lab' subdirectory, which contains the generated deployment files.

```bash
cd rendered/lab

```

--------------------------------

### Get user uidname

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the uidname for a specific user within a context.

```APIDOC
## get uidname of user

### Description
Retrieves the uidname for a specific user within a context.

### Method
GET

### Endpoint
/oxaas/v1/admin/contexts/{contextid}/users/{userid}/uidname

### Path Parameters
- **contextid** (number) - Required - The ID of the context.
- **userid** (number) - Required - The ID of the user.

### Responses
- **200** - Success.
- **401** - Authorization error.
- **404** - User does not exist.
```

--------------------------------

### Render Deployment Templates

Source: https://documentation.open-xchange.com/appsuite/operation-guides

Execute the rendering script to generate deployment files from templates. This process also generates random passwords.

```bash
v/bin/python render.py

```

--------------------------------

### Get Forwarding Alias (Deprecated)

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves a specific forwarding alias. This endpoint is deprecated.

```http
GET /api/oxaas/v1/admin/forwards/{contextId}/{alias}
```

--------------------------------

### Add Host Entry for App Suite

Source: https://documentation.open-xchange.com/appsuite/operation-guides

Add this entry to your local /etc/hosts file to resolve the App Suite hostname. Replace '10.50.2.89' with your k8s node IP.

```bash
10.50.2.89 as8.lab.test

```

--------------------------------

### Verify Kubernetes Deployment

Source: https://documentation.open-xchange.com/appsuite/operation-guides

Check the status of all resources within the 'as8' namespace to ensure that Pods, Deployments, and StatefulSets are ready.

```bash
kubectl get all -n as8

```

--------------------------------

### Get Unread Message Count

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the count of unread messages in the INBOX for a specified user.

```APIDOC
## GET /api/oxaas/mail/unread/{uid}

### Description
Get the unread message count from INBOX for user.

### Method
GET

### Endpoint
/api/oxaas/mail/unread/{uid}

### Parameters
#### Path Parameters
- **uid** (string) - Required - User identifier

### Responses
#### Success Response (200)
- Success

#### Error Responses
- **401**: Authorization error
- **500**: General Error

### Response Example (200)
```json
{
  "newmessages": 0
}
```
```

--------------------------------

### Create Kubernetes Namespace

Source: https://documentation.open-xchange.com/appsuite/operation-guides

Create the 'as8' namespace in your Kubernetes cluster. This is where App Suite and its components will be deployed.

```bash
kubectl create namespace as8

```

--------------------------------

### AS8 Transition Command-Line Operations

Source: https://documentation.open-xchange.com/appsuite/operation-guides/transition.html

Execute these commands for each context during the AS8 transition process. These commands disable the schema, change the server, and then re-enable the schema.

```bash
/opt/open-exchange/sbin/disableschema -m oxdb_7 -A oxadminmaster -P ...
/opt/open-exchange/sbin/changeserver -m oxdb_7 -s 1 -A oxadminmaster -P ...
/opt/open-exchange/sbin/enableschema -m oxdb_7 -A oxadminmaster -P ...
```

--------------------------------

### Get filtered user blacklist

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves a filtered blacklist for a specific user, allowing wildcard searches.

```APIDOC
## Get the filtered blacklist for user
### Description
Get the filtered blacklist for user
### Method
GET
### Endpoint
/oxaas/v1/admin/blacklist/{contextid}/{userid}/{filter}
### Parameters
#### Path Parameters
- **contextId** (number) - Required - context id
- **userid** (number) - Required - user id
- **filter** (string) - Required - the blacklist filter which can contain wildcard *
### Responses
#### Success Response (200)
Success
#### Error Response (401)
Authorization error
```

--------------------------------

### Send Welcome Mail

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Sends a "welcome" email notification to a specified user. Requires user context.

```APIDOC
## Send a "welcome" mail to user

### Description
Sends a "welcome" mail to user.

### Method
POST

### Endpoint
/api/oxaas/notification/mail/welcomemail/{usercontext}

### Parameters
#### Path Parameters
- **usercontext** (string) - Required - The user context and user id in the form "userid@contextid".

### Response
#### Success Response (200)
- **mail** (string) - The message content.

#### Response Example
```json
{
  "mail": "the message content"
}
```
```

--------------------------------

### Apache mod_proxy_http Configuration for Hybrid Transition

Source: https://documentation.open-xchange.com/appsuite/operation-guides/transition.html

Use this configuration to set up Apache mod_proxy_http for a hybrid transition, forwarding API calls and static files, and then routing traffic to AS8 endpoints.

```apache
ProxyPass /api/ http://localhost:8080/api/
ProxyPass / http://localhost:8080/
```

--------------------------------

### get the number of unread mails in all folders

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the total count of unread emails across all folders for a user.

```APIDOC
## get the number of unread mails in all folders

### Description
Retrieves the number of unread mails in all folders for a user.

### Method
GET

### Endpoint
/api/oxaas/mail/{uid}/recentmessages

### Parameters
#### Path Parameters
- **uid** (string) - Required - User identifier

### Responses
#### Success Response (200)
- Returns the count of unread messages.

#### Error Response (401)
Authorization error
```

--------------------------------

### List Users in Context

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Lists users within a specified context. Supports filtering by user IDs. Requires reseller administrator authorization.

```APIDOC
## List Users in Context

### Description
Lists users within a specified context. Supports filtering by user IDs.

### Method
GET

### Endpoint
/oxaas/v1/admin/contexts/{contextid}/users

### Parameters
#### Path Parameters
- **contextid** (number) - Required - context id

#### Query Parameters
- **uids** (string) - Optional - Comma-separated list of user IDs to return, or all users if omitted.

### Response
#### Success Response (200)
- **oxadmin**: Object containing admin user details.
- **testuser**: Object containing user details.

#### Response Example
```json
{
  "oxadmin": {
    "classofservice": [],
    "context-id": 57,
    "oxantiphishing": "MISSING",
    "quota-object-count": 0,
    "quota-usage": 0,
    "quotamode": "default",
    "spamlevel": "medium",
    "is-user-admin": false,
    "uidname": "oxadmin",
    "user-id": 2
  },
  "testuser": {
    "classofservice": [
      "cosName=cloud_pim,ou=services,o=oxcs"
    ],
    "context-id": 57,
    "max-quota": 800,
    "oxantiphishing": "MISSING",
    "oxdeliverystatus": "OXAAS",
    "quota-object-count": 60,
    "quota-usage": 99155678,
    "quotamode": "unified",
    "spamlevel": "high",
    "is-user-admin": false,
    "uidname": "testuser",
    "user-id": 3
  }
}
```

#### Error Responses
- **400**: Generic error, e.g. wrong parameters
- **401**: Authorization error
```

--------------------------------

### get 5 recent mails from user in INBOX

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the 5 most recent emails from a user's inbox.

```APIDOC
## get 5 recent mails from user in INBOX

### Description
Retrieves the 5 most recent mails from a user's inbox.

### Method
GET

### Endpoint
/api/oxaas/mail/{uid}/recentmails

### Parameters
#### Path Parameters
- **uid** (string) - Required - User identifier

### Responses
#### Success Response (200)
- Returns an array of recent mail objects.
  - **id** (string) - Unique identifier for the email.
  - **subject** (string) - Subject of the email.
  - **from** (string) - Sender of the email.
  - **seen** (boolean) - Indicates if the email has been seen.
  - **arrival** (integer) - Timestamp of email arrival.

#### Response Example
```json
[
  {
    "id": "string",
    "subject": "string",
    "from": "string",
    "seen": true,
    "arrival": 0
  }
]
```

#### Error Response (401)
Authorization error
```

--------------------------------

### Get recent mails

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the 5 most recent emails from the user's INBOX. Requires tenant authorization.

```json
[
  {
    "id": "string",
    "subject": "string",
    "from": "string",
    "seen": true,
    "arrival": 0
}

]
```

--------------------------------

### Retrieve Users with Aliases by Domain

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Fetches all users and their aliases for a specified domain. Requires reseller administrator authorization.

```json
{
  "users": [
    {
      "context-id": 42,
      "uidname": "janedoe",
      "aliases": [
        "jane@example.com"
]
}
]

}
```

--------------------------------

### Import CA Certificate on Fedora

Source: https://documentation.open-xchange.com/appsuite/operation-guides

Command to add the CA certificate as a trusted anchor on Fedora and similar systems using p11-kit.

```bash
sudo trust anchor cacert.pem

```

--------------------------------

### Get User Custom Name

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the custom name associated with a specific user within a given context.

```APIDOC
## GET /oxaas/v1/admin/contexts/{contextid}/users/{userid}/custom

### Description
Retrieves the custom name of a user.

### Method
GET

### Endpoint
/oxaas/v1/admin/contexts/{contextid}/users/{userid}/custom

### Parameters
#### Path Parameters
- **contextid** (number) - Required - context id
- **userid** (number) - Required - user id

### Responses
#### Success Response (200)
- **custom** (array) - Contains custom names for the user.

#### Response Example (200)
```json
{
  "custom": [
    "custom1",
    "custom2"
  ]
}
```
```

--------------------------------

### get the current user quota

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the current mail quota information for a user, including used and maximum quota.

```APIDOC
## get the current user quota

### Description
Retrieves the current user quota for mail.

### Method
GET

### Endpoint
/api/oxaas/mail/{uid}/quota

### Parameters
#### Path Parameters
- **uid** (string) - Required - User identifier

### Responses
#### Success Response (200)
- **mailQuota** (object) - Contains used and max quota.
  - **usedQuota** (integer) - The amount of quota used.
  - **maxQuota** (integer) - The maximum quota allowed.

#### Response Example
```json
{
  "mailQuota": {
    "usedQuota": 0,
    "maxQuota": 0
  }
}
```

#### Error Response (401)
Authorization error
```

--------------------------------

### Add whitelist entry for user

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Adds a specified entry to a user's whitelist within a given context. Requires administrator privileges.

```APIDOC
## Add whitelist entry for user

### Description
Adds a specified entry to a user's whitelist within a given context. Requires administrator privileges.

### Method
PUT

### Endpoint
/oxaas/v1/admin/whitelist/{contextid}/{userid}/{value}

### Parameters
#### Path Parameters
- **contextid** (number) - Required - The context ID.
- **userid** (number) - Required - The user ID.
- **value** (string) - Required - The whitelist entry to add.

### Responses
#### Success Response (200)
Success

#### Error Response (401)
Authorization error
```

--------------------------------

### Import CA Certificate on Windows

Source: https://documentation.open-xchange.com/appsuite/operation-guides

PowerShell command to import the CA certificate into the local machine's root certificate store on Windows.

```powershell
Import-Certificate -FilePath cacert.pem -CertStoreLocation Cert:\LocalMachine\Root

```

--------------------------------

### Create Shared Domain

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Creates a new shared domain. Requires reseller administrator authorization. Returns the created domain on success.

```json
{
  "domain": "example.com"

}
```

--------------------------------

### Get Forwarding Alias (Deprecated)

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves details of a specific forwarding alias. This endpoint is deprecated and will be removed in future versions.

```APIDOC
## GET /api/oxaas/v1/admin/forwards/{contextId}/{alias} (Deprecated)

### Description
Gets the forwarding alias.

### Method
GET

### Endpoint
/api/oxaas/v1/admin/forwards/{contextId}/{alias}

### Path Parameters
- **contextId** (string) - Required - Context ID or context name.
- **alias** (string) - Required - Alias mail address.

### Authorizations
_contextAdminAuth_

### Responses
- **200** - Success
- **403** - Authorization error
- **404** - Forwarding alias does not exist
```

--------------------------------

### Import CA Certificate on macOS

Source: https://documentation.open-xchange.com/appsuite/operation-guides

Command to add the CA certificate to the system's keychain on macOS.

```bash
sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain cacert.pem

```

--------------------------------

### Import CA Certificate on Debian/Ubuntu

Source: https://documentation.open-xchange.com/appsuite/operation-guides

Command to copy the CA certificate and update the system's trusted certificates on Debian-based systems.

```bash
sudo cp cacert.pem /usr/local/share/ca-certificates && sudo update-ca-certificates

```

--------------------------------

### List Users in Context

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves a list of users within a specified context. Can optionally filter by a comma-separated list of user IDs.

```json
{
  "oxadmin": {
    "classofservice": [ ],
    "context-id": 57,
    "oxantiphishing": "MISSING",
    "quota-object-count": 0,
    "quota-usage": 0,
    "quotamode": "default",
    "spamlevel": "medium",
    "is-user-admin": false,
    "uidname": "oxadmin",
    "user-id": 2
},
  "testuser": {
    "classofservice": [
      "cosName=cloud_pim,ou=services,o=oxcs"
],
    "context-id": 57,
    "max-quota": 800,
    "oxantiphishing": "MISSING",
    "oxdeliverystatus": "OXAAS",
    "quota-object-count": 60,
    "quota-usage": 99155678,
    "quotamode": "unified",
    "spamlevel": "high",
    "is-user-admin": false,
    "uidname": "testuser",
    "user-id": 3
}

}
```

--------------------------------

### Get Unread Message Count

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the count of unread messages for a specific user's INBOX. Requires user identifier.

```json
{
  "newmessages": 0
}
```

--------------------------------

### get the number of new messages since last login in

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the count of new messages for a user since their last login.

```APIDOC
## get the number of new messages since last login in

### Description
Retrieves the number of new messages for a user since their last login.

### Method
GET

### Endpoint
/api/oxaas/mail/{uid}/newmessages

### Parameters
#### Path Parameters
- **uid** (string) - Required - User identifier

### Responses
#### Success Response (200)
- **newmessages** (integer) - The number of new messages.

#### Response Example
```json
{
  "newmessages": 0
}
```

#### Error Response (401)
Authorization error
```

--------------------------------

### List All Announcements

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves a list of all existing announcements. Requires reseller admin authorization.

```APIDOC
## List all announcements

### Description
Lists all announcements.

### Method
GET

### Endpoint
/api/oxaas/v1/admin/announcements/*

### Responses
#### Success Response (200)
Success

#### Error Response (400)
Generic error, e.g. wrong parameters

#### Error Response (401)
Authorization error
```

--------------------------------

### Create shared domain

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Creates a new shared domain.

```APIDOC
## Create given shared domain
### Description
Create given shared domain
### Method
POST
### Endpoint
/api/oxaas/v1/admin/sharedmaildomains/{domain}
### Parameters
#### Path Parameters
- **domain** (string) - Required - Name of shared domain
### Responses
#### Success Response (200)
Success
#### Error Response (401)
Authorization error
#### Error Response (403)
Domain could not be added
### Request Example
{
  "domain": "example.com"
}
```

--------------------------------

### Enable an existing announcement

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Enables an existing announcement by its ID. Requires reseller administrator authorization.

```APIDOC
## PUT /api/oxaas/v1/admin/announcements/enable/{id}

### Description
Enable an existing announcement.

### Method
PUT

### Endpoint
/api/oxaas/v1/admin/announcements/enable/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - Announcement id

### Responses
#### Success Response (200)
Success

#### Error Response (400)
Generic error, e.g. wrong parameters

#### Error Response (401)
Authorization error
```

--------------------------------

### Create Explicit Mail Domain in Context

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Creates a given explicit mail domain within a specified context.

```APIDOC
## POST /api/oxaas/v1/admin/explicitmaildomains/{contextid}/{domain}

### Description
Create given domain in context.

### Method
POST

### Endpoint
/api/oxaas/v1/admin/explicitmaildomains/{contextid}/{domain}

### Parameters
#### Path Parameters
- **contextid** (number) - Required - Id of context
- **domain** (string) - Required - Name of explicit domain

### Responses
#### Success Response (200)
- Success

#### Error Responses
- **400**: Generic error, e.g. wrong parameters
- **401**: Authorization error
- **409**: Domain could not be added

### Response Example (200)
```json
{
  "domain": "example.com"
}
```
```

--------------------------------

### Create Forwarding Alias Request Payload (Deprecated)

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Example request payload for creating or replacing a forwarding alias with a single recipient.

```json
{
  "recipient": "recipient1@example.com"
}
```

--------------------------------

### Query Whether the User is a Context Provisioning Admin

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Checks if a user is a context provisioning admin, determining their authorization to perform provisioning operations on their context.

```APIDOC
## get/oxaas/v1/admin/contexts/{contextid}/users/{userid}/is-user-admin

### Description
Get the is-user-admin flag of a user to determine whether that user is allowed to perform provisioning operations on their context.

### Method
GET

### Endpoint
/oxaas/v1/admin/contexts/{contextid}/users/{userid}/is-user-admin

### Parameters
#### Path Parameters
- **contextid** (number) - Required - context id
- **userid** (number) - Required - user id

### Responses
#### Success Response (200)
Success

#### Error Response (401)
Authorization error

#### Error Response (404)
User does not exist or oxantiphishing not set for user

### Response Example (200)
```json
{
  "is-user-admin": true
}
```
```

--------------------------------

### Update Antivirus Setting

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Use this endpoint to enable or disable the antivirus feature for a user. Requires a boolean value for the 'antivirus' parameter.

```json
{
  "antivirus": true
}
```

--------------------------------

### Get Spam Level

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the current spam level setting for a specific user within a context. Requires context administrator authorization.

```APIDOC
## Get Spam Level

### Description
Retrieves the current spam level setting for a specific user within a context.

### Method
GET

### Endpoint
/oxaas/v1/admin/contexts/{contextid}/users/{userid}/spamlevel

### Parameters
#### Path Parameters
- **contextid** (number) - Required - context id
- **userid** (number) - Required - user id

### Response
#### Success Response (200)
- **spamlevel** (string) - The current spam level (e.g., "medium").

#### Response Example
```json
{
  "spamlevel": "medium"
}
```

#### Error Responses
- **401**: Authorization error
- **404**: User does not exist
```

--------------------------------

### Get uidname of a user

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieve the unique user identifier (uidname) for a given user within a specific context. Requires contextAdminAuth authorization.

```json
{
  "context-id": 24,
  "user-id": 42,
  "uidname": "johndoe@example.com",
  "msisdn": "+49.12345.6789"

}
```

--------------------------------

### Check if User is Context Provisioning Admin

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Queries the provisioning admin flag for a specific user within a context. This determines if the user can perform provisioning operations. Requires context admin authorization.

```json
{
  "is-user-admin": true
}
```

--------------------------------

### Create Explicit Domain in Context

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Adds a new explicit mail domain to a specified context. Requires context ID and domain name.

```json
{
  "domain": "example.com"
}
```

--------------------------------

### Get OX Antiphishing

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the OXAntiphishing flag for a user to determine MTA level antiphishing support. Requires context administrator authorization.

```APIDOC
## GET /oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxantiphishing

### Description
Gets the OXAntiphishing flag of a user to determine MTA level antiphishing support.

### Method
GET

### Endpoint
/oxaas/v1/admin/contexts/{contextid}/users/{userid}/oxantiphishing

### Parameters
#### Path Parameters
- **contextid** (number) - Required - context id
- **userid** (number) - Required - user id

### Responses
#### Success Response (200)
Success

#### Error Response (401)
Authorization error

#### Error Response (404)
User does not exist or oxantiphishing not set for user
```

--------------------------------

### Create a Forwarding Alias

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Creates a new forwarding alias within a specified context.

```APIDOC
## post/api/oxaas/v2/admin/forwards/{contextId}/{alias}

### Description
Create a forwarding alias.

### Method
POST

### Endpoint
/api/oxaas/v2/admin/forwards/{contextId}/{alias}

### Parameters
#### Path Parameters
- **contextId** (string) - Required - context id or context name
- **alias** (string) - Required - alias mail address
```

--------------------------------

### Get User MSISDN

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the MSISDN (Mobile Station International Subscriber Directory Number) for a specific user within a given context.

```APIDOC
## GET /oxaas/v1/admin/contexts/{contextid}/users/{userid}/msisdn

### Description
Retrieves the MSISDN of a user.

### Method
GET

### Endpoint
/oxaas/v1/admin/contexts/{contextid}/users/{userid}/msisdn

### Parameters
#### Path Parameters
- **contextid** (number) - Required - context id
- **userid** (number) - Required - user id

### Responses
#### Success Response (200)
- **msisdn** (string) - The MSISDN of the user.

#### Response Example (200)
```json
{
  "msisdn": "+49.12345.6789"
}
```
```

--------------------------------

### Get new messages count

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the number of new messages in the user's INBOX since their last login. Requires tenant authorization.

```json
{
  "newmessages": 0

}
```

--------------------------------

### Error Response Sample

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

This is a sample JSON response for errors, typically returned with a 400 status code. It contains a simple error message.

```json
{
  "error": "Error message"

}
```

--------------------------------

### Get User Custom IDs - Admin API

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the custom IDs associated with a specific user within a context. Requires contextAdminAuth authorization.

```json
{
  * "custom": [
    * "custom1",
    * "custom2"
]

}
```

--------------------------------

### Retrieve All Forwarding Aliases

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves all forwarding aliases associated with a given context.

```APIDOC
## retrieve all forwarding aliases
GET/api/oxaas/v2/admin/forwards/{contextId}

### Description
Retrieves all forwarding aliases for the specified context.

### Method
GET

### Endpoint
/api/oxaas/v2/admin/forwards/{contextId}

### Parameters
#### Path Parameters
- **contextId** (string) - Required - The context ID or name.

### Response
#### Success Response (200)
Success.

#### Response Example
```json
{
  "fwd1@example.com": {
    "recipients": [
      "jane@example.com",
      "john@example.com"
    ],
    "spamlevel": "medium"
  },
  "fwd2@example.com": {
    "recipients": [
      "peter@example.com"
    ],
    "spamlevel": "medium"
  }
}
```

#### Error Responses
- **403**: Authorization error.
- **404**: Context not found.
```

--------------------------------

### Check Explicit Domain Existence in Context

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Verifies if a given domain is registered within a specific context. Requires context ID and domain name.

```json
{
  "error": "Error message"
}
```

--------------------------------

### Get User MSISDN - Admin API

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves the MSISDN (Mobile Station International Subscriber Directory Number) for a specific user. Requires contextAdminAuth authorization.

```json
{
  * "msisdn": "+49.12345.6789"

}
```

--------------------------------

### List Explicit Mail Domains in Context

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Lists all explicit mail domains within a given context.

```APIDOC
## GET /api/oxaas/v1/admin/explicitmaildomains/{contextid}

### Description
List all explicit mail domains within given context.

### Method
GET

### Endpoint
/api/oxaas/v1/admin/explicitmaildomains/{contextid}

### Parameters
#### Path Parameters
- **contextid** (number) - Required - Id of context

### Responses
#### Success Response (200)
- Success

#### Error Responses
- **400**: Generic error, e.g. wrong parameters
- **401**: Authorization error

### Response Example (200)
```json
{
  "domains": [
    "example.com",
    "example.org"
  ]
}
```
```

--------------------------------

### Add blacklist entry for user

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Adds a specified entry to a user's blacklist within a given context. Requires administrator privileges.

```APIDOC
## Add blacklist entry for user

### Description
Adds a specified entry to a user's blacklist within a given context. Requires administrator privileges.

### Method
PUT

### Endpoint
/oxaas/v1/admin/blacklist/{contextid}/{userid}/{value}

### Parameters
#### Path Parameters
- **contextid** (number) - Required - The context ID.
- **userid** (number) - Required - The user ID.
- **value** (string) - Required - The blacklist entry to add.

### Responses
#### Success Response (200)
Success

#### Error Response (401)
Authorization error
```

--------------------------------

### get all data in one request

Source: https://documentation.open-xchange.com/components/cloudplugins/stable

Retrieves all mail-related data for a given user in a single request, including recent emails, quota information, and new message counts.

```APIDOC
## get all data in one request

### Description
Retrieves all mail data for a user in one request.

### Method
GET

### Endpoint
/api/oxaas/mail/{uid}

### Parameters
#### Path Parameters
- **uid** (string) - Required - User identifier

### Responses
#### Success Response (200)
- **recentmails** (array) - List of recent emails.
- **quota** (object) - Quota information.
- **newmessages** (object) - New message count.
- **recentmessages** (object) - Recent message count.

#### Response Example
```json
{
  "recentmails": [
    {
      "id": "string",
      "subject": "string",
      "from": "string",
      "seen": true,
      "arrival": 0
    }
  ],
  "quota": {
    "mailQuota": {
      "usedQuota": 0,
      "maxQuota": 0
    }
  },
  "newmessages": {
    "newmessages": 0
  },
  "recentmessages": {
    "newmessages": 0
  }
}
```

#### Error Response (401)
Authorization error
```
Tokens:
Raw