WildDuck Mail Server

https://docs.wildduck.email
Admin
WildDuck is a scalable, no-SPOF IMAP/POP3 mail server built on Node.js and MongoDB with full...
Tokens:99,782
Snippets:806
Trust Score:8.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Retrieve Setting with HttpClient

Source: https://docs.wildduck.email/docs/wildduck-api/get-setting

Example implementation using C# HttpClient to perform a GET request.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.wildduck.email/settings/:key");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Setup Maildir Import Tool

Source: https://docs.wildduck.email/docs/ecosystem/import-export

Clone and install the import-maildir utility to prepare for direct database imports.

```bash
git clone https://github.com/nodemailer/import-maildir.git  
cd import-maildir  
npm install --production  
```

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

### C# HttpClient Request

Source: https://docs.wildduck.email/docs/wildduck-api/get-addresses

Example of how to perform the GET request using C# HttpClient.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.wildduck.email/addresses");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### X-Access-Token Header Example

Source: https://docs.wildduck.email/docs/wildduck-api/assert-web-auth-n

Example of the required header for authentication when enabled in the WildDuck configuration.

```json
{
    "X-Access-Token": "59fc66a03e54454869460e45"
}
```

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

### C# HttpClient request example

Source: https://docs.wildduck.email/docs/wildduck-api/get-allowed-domains

Example implementation using C# HttpClient to fetch allowlisted domains.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.wildduck.email/domainaccess/:tag/allow");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### C# HttpClient Request

Source: https://docs.wildduck.email/docs/wildduck-api/get-authlog-event

Example implementation using C# HttpClient to perform the GET request.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.wildduck.email/users/:user/authlog/:event");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### C# HttpClient Request

Source: https://docs.wildduck.email/docs/wildduck-api/get-autoreply

Example implementation using C# HttpClient to perform the GET request.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.wildduck.email/users/:user/autoreply");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Retrieve Mailbox with HttpClient

Source: https://docs.wildduck.email/docs/wildduck-api/get-mailbox

Example implementation using C# HttpClient to perform the GET request.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.wildduck.email/users/:user/mailboxes/:mailbox");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Install dependencies

Source: https://docs.wildduck.email/docs/getting-started/installation

Install required npm packages, excluding development dependencies.

```bash
$ npm install --omit=dev  
```

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

### Clone WildDuck repository

Source: https://docs.wildduck.email/docs/getting-started/installation

Download the source code from GitHub to begin manual installation.

```bash
$ git clone https://github.com/zone-eu/wildduck.git  
$ cd wildduck  
```

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

### Success Response Example

Source: https://docs.wildduck.email/docs/wildduck-api/rename-domain

Example JSON response indicating the number of modified entities.

```json
{
  "success": true,
  "modifiedAddresses": 0,
  "modifiedUsers": 0,
  "modifiedDkim": 0,
  "modifiedAliases": 0
}
```

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

### Retrieve DKIM information using HttpClient

Source: https://docs.wildduck.email/docs/wildduck-api/get-dkim-key

Example implementation using C# HttpClient to perform the GET request.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.wildduck.email/dkim/:dkim");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### C# HttpClient Implementation

Source: https://docs.wildduck.email/docs/wildduck-api/create-blocked-domain

Example usage of the HttpClient class to perform the POST request.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.wildduck.email/domainaccess/:tag/block");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("X-Access-Token", "<X-Access-Token>");  
var content = new StringContent("{\n  \"domain\": \"string\",\n  \"sess\": \"string\",\n  \"ip\": \"string\"\n}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### GET /users/:user/autoreply

Source: https://docs.wildduck.email/docs/concepts/message-filtering

Get autoreply status.

```APIDOC
## GET /users/:user/autoreply

### Description
Retrieve the current status and configuration of the user's autoreply (vacation message).

### Method
GET

### Endpoint
/users/:user/autoreply
```

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

### Response schema example

Source: https://docs.wildduck.email/docs/wildduck-api/cancel-user-delete

Example JSON response structure returned upon a successful restoration request.

```json
{
  "success": true,
  "code": "string",
  "user": "string",
  "task": "string",
  "addresses": {
    "recovered": 0,
    "main": "string"
  }
}
```

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

### Configure POP3 service

Source: https://docs.wildduck.email/docs/operations/configuration

Define POP3 server behavior and public setup details.

```toml
[pop3]  
enabled = true         # enable POP3 service  
port = 9995            # POP3 port (use 995 for production)  
host = "0.0.0.0"      # bind address  
secure = true          # use TLS  
maxMessages = 250      # max messages shown in LIST/UIDL  
  
[pop3.setup]  
hostname = "localhost" # public POP3 hostname (for client config)  
secure = true
```

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

### C# Export Request

Source: https://docs.wildduck.email/docs/wildduck-api/create-export

Example implementation using HttpClient to perform the export request.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.wildduck.email/data/export");  
request.Headers.Add("Accept", "application/octet-stream");  
request.Headers.Add("X-Access-Token", "<X-Access-Token>");  
var content = new StringContent("{\n  \"users\": [\n    \"string\"\n  ],\n  \"tags\": [\n    \"string\"\n  ],\n  \"sess\": \"string\",\n  \"ip\": \"string\"\n}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

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

### Settings Response Schema

Source: https://docs.wildduck.email/docs/wildduck-api/get-settings

Example JSON structure returned by the settings endpoint.

```json
{
  "success": true,
  "filter": "string",
  "settings": [
    {
      "key": "string",
      "value": "string",
      "name": "string",
      "description": "string",
      "default": "string",
      "type": "string",
      "custom": true
    }
  ]
}
```

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

### Start server with custom configuration

Source: https://docs.wildduck.email/docs/operations/configuration

Pass a custom TOML file at startup to override default settings.

```bash
node server.js --config=/etc/wildduck.toml
```

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

### C# HttpClient Request

Source: https://docs.wildduck.email/docs/wildduck-api/get-mailboxes

Example implementation using C# HttpClient to fetch mailboxes.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.wildduck.email/users/:user/mailboxes");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Run WildDuck server

Source: https://docs.wildduck.email/docs/getting-started/installation

Start the server using default settings or a custom configuration file.

```bash
node server.js  
```

```bash
node server.js --config=/etc/wildduck.toml  
```

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

### Request Body Example

Source: https://docs.wildduck.email/docs/wildduck-api/submit-stored-message

The JSON structure for the request body when submitting a message.

```json
{
  "deleteFiles": true,
  "sendTime": "2024-07-29T15:51:28.071Z",
  "sess": "string",
  "ip": "string"
}
```

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

### Run Wildduck Container

Source: https://docs.wildduck.email/docs/operations/docker

Basic command to start the Wildduck container using default configuration settings.

```bash
docker run ghcr.io/zone-eu/wildduck
```

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

### Get the WebAuthN registration challenge

Source: https://docs.wildduck.email/docs/wildduck-api/two-factor-auth

Initiates the registration challenge for a new WebAuthN authenticator.

```APIDOC
## Get the WebAuthN registration challenge

### Description
This method initiates the WebAuthN authenticator registration challenge.
```

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

### Success Response Schema

Source: https://docs.wildduck.email/docs/wildduck-api/update-tls-certificate

Example of a successful JSON response after creating or updating a certificate.

```json
{
  "success": true,
  "id": "609d201236d1d936948f23b1",
  "servername": "imap.example.com",
  "description": "Some notes about this certificate",
  "fingerprint": "59:8b:ed:11:5b:4f:ce:b4:e5:1a:2f:35:b1:6f:7d:93:40:c8:2f:9c:38:3b:cd:f4:04:92:a1:0e:17:2c:3f:f3",
  "expires": "2024-06-26T21:55:55.000Z",
  "altNames": [
    "string"
  ],
  "acme": true
}
```

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

### Resolve Certificate ID with HttpClient

Source: https://docs.wildduck.email/docs/wildduck-api/resolve-tls-certificate

Example implementation using C# HttpClient to perform the GET request.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.wildduck.email/certs/resolve/:servername");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Execute mbsync

Source: https://docs.wildduck.email/docs/ecosystem/migration-guide

Run the synchronization process.

```bash
mbsync -a
```

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

### Retrieve Archived Messages with C#

Source: https://docs.wildduck.email/docs/wildduck-api/get-archived-messages

Example using HttpClient to perform a GET request to the archived messages endpoint.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.wildduck.email/users/:user/archived/messages");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Configure database connections

Source: https://docs.wildduck.email/docs/operations/configuration

Set MongoDB and Redis connection strings.

```toml
[dbs]  
# MongoDB connection URL  
mongo = "mongodb://127.0.0.1:27017/wildduck"  
# Redis connection URL  
redis = "redis://127.0.0.1:6379/3"  
  
# Separate database for attachments (recommended for disk separation)  
#[dbs.gridfs]  
#mongo = "mongodb://127.0.0.1:27017/attachments"
```

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

### C# HttpClient Audit Request

Source: https://docs.wildduck.email/docs/wildduck-api/get-audit

Example implementation using C# HttpClient to perform a GET request to the audit endpoint.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.wildduck.email/audit/:audit");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Search Messages C# HttpClient Request

Source: https://docs.wildduck.email/docs/wildduck-api/search-messages

Example of performing a GET request to the search messages endpoint using C# HttpClient.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.wildduck.email/users/:user/search");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Configure logging and GELF

Source: https://docs.wildduck.email/docs/operations/configuration

Set log levels and optional Graylog integration.

```toml
[log]  
level = "silly"        # silly, verbose, info, warn, error  
skipFetchLog = false   # skip logging individual FETCH responses  
  
[log.gelf]  
enabled = false        # enable GELF logging to Graylog  
component = "wildduck"  
[log.gelf.options]  
graylogPort = 12201  
graylogHostname = "127.0.0.1"
```

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

### Create Address with HttpClient

Source: https://docs.wildduck.email/docs/wildduck-api/create-user-address

Example implementation using C# HttpClient to send a POST request to the address creation endpoint.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.wildduck.email/users/:user/addresses");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var content = new StringContent("{\n  \"address\": \"string\",\n  \"name\": \"string\",\n  \"main\": true,\n  \"allowWildcard\": true,\n  \"tags\": [\n    \"string\"\n  ],\n  \"metaData\": {},\n  \"internalData\": {},\n  \"sess\": \"string\",\n  \"ip\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### GET /domainaliases/:alias

Source: https://docs.wildduck.email/docs/concepts/domain-management

Get a domain alias by ID.

```APIDOC
## GET /domainaliases/:alias

### Description
Get a domain alias by ID.

### Method
GET

### Endpoint
/domainaliases/:alias

### Parameters
#### Path Parameters
- **alias** (string) - Required - The alias ID.
```

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

### Create User with HttpClient

Source: https://docs.wildduck.email/docs/wildduck-api/create-user

C# implementation using HttpClient to send a POST request to the user creation endpoint.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.wildduck.email/users");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var content = new StringContent("{\n  \"username\": \"string\",\n  \"password\": false,\n  \"hashedPassword\": false,\n  \"allowUnsafe\": true,\n  \"address\": \"string\",\n  \"emptyAddress\": false,\n  \"language\": \"string\",\n  \"retention\": 0,\n  \"name\": \"string\",\n  \"targets\": [\n    \"string\"\n  ],\n  \"mtaRelay\": \"string\",\n  \"spamLevel\": 50,\n  \"quota\": 0,\n  \"recipients\": 0,\n  \"forwards\": 0,\n  \"filters\": 0,\n  \"requirePasswordChange\": false,\n  \"require2faEnabled\": false,\n  \"imapMaxUpload\": 0,\n  \"imapMaxDownload\": 0,\n  \"pop3MaxDownload\": 0,\n  \"pop3MaxMessages\": 0,\n  \"imapMaxConnections\": 0,\n  \"receivedMax\": 0,\n  \"fromWhitelist\": [\n    \"string\"\n  ],\n  \"tags\": [\n    \"string\"\n  ],\n  \"addTagsToAddress\": false,\n  \"uploadSentMessages\": false,\n  \"mailboxes\": {\n    \"sent\": \"string\",\n    \"trash\": \"string\",\n    \"junk\": \"string\",\n    \"drafts\": \"string\"\n  },\n  \"disabledScopes\": [\n    \"imap\"\n  ],\n  \"metaData\": {},\n  \"internalData\": {},\n  \"pubKey\": \"string\",\n  \"smimeCerts\": [\n    \"string\"\n  ],\n  \"smimeCipher\": \"AES-CBC\",\n  \"smimeKeyTransport\": \"PKCS#1 v1.5\",\n  \"encryptMessages\": false,\n  \"encryptForwarded\": false,\n  \"featureFlags\": {\n    \"indexing\": false\n  },\n  \"sess\": \"string\",\n  \"ip\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### GET /users/:user/filters/:filter

Source: https://docs.wildduck.email/docs/concepts/message-filtering

Get details of a specific filter.

```APIDOC
## GET /users/:user/filters/:filter

### Description
Retrieve the details of a specific filter by its identifier.

### Method
GET

### Endpoint
/users/:user/filters/:filter
```

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

### Configure mbsync

Source: https://docs.wildduck.email/docs/ecosystem/migration-guide

Define the IMAP and Maildir stores in the .mbsyncrc configuration file.

```bash
$ cat ~/.mbsyncrc  
IMAPAccount yourdomain  
# Address to connect to  
Host 192.168.0.1  
User anon@yourdomain.com  
Pass gbxiccfdfbqb  
# To store the password in an encrypted file use PassCmd instead of Pass  
# PassCmd "gpg2 -q --for-your-eyes-only --no-tty -d ~/.mailpass.gpg"  
#  
# Use SSL  
SSLType IMAPS  
# The following line should work. If get certificate errors, uncomment the two following lines and read the "Troubleshooting" section.  
CertificateFile /pst/19216801.cert  
#CertificateFile ~/.cert/imap.gmail.com.pem  
#CertificateFile ~/.cert/Equifax_Secure_CA.pem  
  
IMAPStore yourdomain-remote  
Account yourdomain  
  
MaildirStore yourdomain-local  
Subfolders Verbatim  
# The trailing "/" is important  
Path /pst/maildir-anon/  
Inbox /pst/maildir-anon/Inbox  
  
Channel yourdomain  
Far :yourdomain-remote:  
Near :yourdomain-local:  
# Exclude everything under the internal [Gmail] folder, except the interesting folders  
#Patterns * ![Gmail]* "[Gmail]/Sent Mail" "[Gmail]/Starred" "[Gmail]/All Mail"  
# Or include everything  
Patterns *  
# Automatically create missing mailboxes, both locally and on the server  
Create Both  
# Save the synchronization state files in the relevant directory  
SyncState *  
```

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

### Configure Wildduck via Environment Variables

Source: https://docs.wildduck.email/docs/operations/docker

Pass configuration options to the container using APPCONF environment variables to define database connections and host settings.

```bash
FQDN='example.com'  
MAIL_DOMAIN='mail.example.com'  
docker run \   
-e APPCONF_dbs_mongo='mongodb://mongo:27017/wildduck' \  
-e APPCONF_dbs_redis='redis://redis:6379/3' \  
-e APPCONF_smtp_setup_hostname=$FQDN \  
-e APPCONF_log_gelf_hostname=$FQDN \  
-e APPCONF_imap_setup_hostname=$FQDN \  
-e APPCONF_emailDomain=$MAIL_DOMAIN \  
ghcr.io/zone-eu/wildduck
```

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

### Get Users Response Schema

Source: https://docs.wildduck.email/docs/wildduck-api/get-users

The JSON structure returned by the GET /users endpoint.

```json
{
  "success": true,
  "total": 541,
  "page": 1,
  "previousCursor": "string",
  "nextCursor": "string",
  "query": "string",
  "results": [
    {
      "id": "string",
      "username": "string",
      "name": "string",
      "address": "string",
      "tags": [
        "string"
      ],
      "targets": [
        "string"
      ],
      "enabled2fa": [
        "string"
      ],
      "autoreply": true,
      "encryptMessages": true,
      "encryptForwarded": true,
      "quota": {
        "allowed": 0,
        "used": 0
      },
      "metaData": {},
      "internalData": {},
      "hasPasswordSet": true,
      "activated": true,
      "disabled": true,
      "suspended": true
    }
  ]
}
```

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

### Create ASP using C# HttpClient

Source: https://docs.wildduck.email/docs/wildduck-api/create-asp

Implementation of the POST request using the C# HttpClient library.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.wildduck.email/users/:user/asps");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var content = new StringContent("{\n  \"description\": \"string\",\n  \"scopes\": [\n    \"imap\"\n  ],\n  \"address\": \"string\",\n  \"password\": \"string\",\n  \"generateMobileconfig\": false,\n  \"ttl\": 0,\n  \"protocol\": \"API\",\n  \"sess\": \"string\",\n  \"ip\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### POST /users/:user/2fa/totp/setup

Source: https://docs.wildduck.email/docs/security/authentication

Generates a TOTP seed and returns a QR code for setting up time-based one-time passwords.

```APIDOC
## POST /users/:user/2fa/totp/setup

### Description
Generates a TOTP seed and returns a QR code for setting up time-based one-time passwords.

### Method
POST

### Endpoint
/users/:user/2fa/totp/setup

### Parameters
#### Path Parameters
- **user** (string) - Required - The user identifier.
```

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

### GET /dkim/:dkim

Source: https://docs.wildduck.email/docs/concepts/domain-management

Get key details including the public key for DNS configuration.

```APIDOC
## GET /dkim/:dkim

### Description
Get key details including the public key for DNS configuration.

### Method
GET

### Endpoint
/dkim/:dkim

### Parameters
#### Path Parameters
- **dkim** (string) - Required - The DKIM key ID.
```

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

### C# HttpClient Implementation

Source: https://docs.wildduck.email/docs/wildduck-api/update-autoreply

Example of performing the PUT request using the C# HttpClient library.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://api.wildduck.email/users/:user/autoreply");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var content = new StringContent("{\n  \"status\": true,\n  \"name\": \"\",\n  \"subject\": \"\",\n  \"text\": \"\",\n  \"html\": \"\",\n  \"start\": false,\n  \"end\": false,\n  \"sess\": \"string\",\n  \"ip\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Create Webhook with HttpClient

Source: https://docs.wildduck.email/docs/wildduck-api/create-webhook

Example implementation using C# HttpClient to send a POST request to the webhook endpoint.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.wildduck.email/webhooks");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var content = new StringContent("{\n  \"type\": [\n    \"string\"\n  ],\n  \"user\": \"string\",\n  \"url\": \"string\",\n  \"sess\": \"string\",\n  \"ip\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Get Users Request with C# HttpClient

Source: https://docs.wildduck.email/docs/wildduck-api/get-users

Implementation of the GET /users request using C# HttpClient.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.wildduck.email/users");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Run WildDuck container

Source: https://docs.wildduck.email/docs/getting-started/installation

Execute the WildDuck container using host networking and default configuration.

```bash
docker run --network=host ghcr.io/zone-eu/wildduck  
```

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

### GET /domainaliases

Source: https://docs.wildduck.email/docs/concepts/domain-management

List all domain aliases.

```APIDOC
## GET /domainaliases

### Description
List all domain aliases.

### Method
GET

### Endpoint
/domainaliases
```

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

### GET /dkim

Source: https://docs.wildduck.email/docs/concepts/domain-management

List all DKIM keys.

```APIDOC
## GET /dkim

### Description
List all DKIM keys.

### Method
GET

### Endpoint
/dkim
```

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

### Authenticate User with C# HttpClient

Source: https://docs.wildduck.email/docs/wildduck-api/authenticate

Example implementation using C# HttpClient to perform the authentication request.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.wildduck.email/authenticate");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var content = new StringContent("{\n  \"username\": \"string\",\n  \"password\": \"string\",\n  \"protocol\": \"API\",\n  \"scope\": \"master\",\n  \"appId\": \"string\",\n  \"token\": false,\n  \"sess\": \"string\",\n  \"ip\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### GET /domainaliases/resolve/:alias

Source: https://docs.wildduck.email/docs/concepts/domain-management

Resolve a domain alias.

```APIDOC
## GET /domainaliases/resolve/:alias

### Description
Resolve a domain alias.

### Method
GET

### Endpoint
/domainaliases/resolve/:alias

### Parameters
#### Path Parameters
- **alias** (string) - Required - The alias domain.
```

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

### Run import-maildir

Source: https://docs.wildduck.email/docs/ecosystem/migration-guide

Execute the import process for single or multiple users.

```bash
$ ./bin/import-maildir userid:maildirpath  
```

```bash
$ ./bin/import-maildir user@example.com:/var/mail/user_example.com/  
```

```bash
$ ./bin/import-maildir user1@example.com:/var/mail/user1_example.com/ user2@example.com:/var/mail/user2_example.com/ user3@example.com:/var/mail/user3_example.com/  
```

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

### Execute Maildir Import

Source: https://docs.wildduck.email/docs/ecosystem/import-export

Run the import tool by specifying the target user identifier and the source maildir path.

```bash
./bin/import-maildir user@example.com:/var/mail/user_example.com/  
```

```bash
./bin/import-maildir user1@example.com:/var/mail/user1/ user2@example.com:/var/mail/user2/  
```

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

### Get Setting value

Source: https://docs.wildduck.email/docs/wildduck-api/settings

Retrieves the value of a specific setting.

```APIDOC
## GET /settings/:key

### Description
Get the current value of a specific setting by its key.

### Method
GET

### Endpoint
/settings/:key

### Parameters
#### Path Parameters
- **key** (string) - Required - The unique identifier for the setting.
```

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

### Retrieve Filters using HttpClient

Source: https://docs.wildduck.email/docs/wildduck-api/get-all-filters

Example of fetching all filters using the C# HttpClient class.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.wildduck.email/filters");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("X-Access-Token", "<X-Access-Token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### GET /filters

Source: https://docs.wildduck.email/docs/wildduck-api/get-all-filters

Retrieves a list of all filters associated with the account.

```APIDOC
## GET /filters

### Description
Retrieves a list of all filters. Authentication is required via the X-Access-Token header.

### Method
GET

### Endpoint
https://api.wildduck.email/filters

### Parameters
#### Query Parameters
- **forward** (boolean) - Optional - Filter by forward status
- **metaData** (boolean) - Optional - Include metadata in response
- **limit** (integer) - Optional - Limit the number of results
- **next** (string) - Optional - Pagination token for next page
- **previous** (string) - Optional - Pagination token for previous page
- **sess** (string) - Optional - Filter by session
- **ip** (string) - Optional - Filter by IP address

### Request Example
GET /filters?limit=10
X-Access-Token: <your_token>
```

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

### GET /users/:user/asps

Source: https://docs.wildduck.email/docs/security/authentication

Lists application-specific passwords for a user.

```APIDOC
## GET /users/:user/asps

### Description
Lists application-specific passwords for a user.

### Method
GET

### Endpoint
/users/:user/asps

### Parameters
#### Path Parameters
- **user** (string) - Required - The user identifier.
```

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

### Create Filter with HttpClient

Source: https://docs.wildduck.email/docs/wildduck-api/create-filter

Example implementation using C# HttpClient to send a POST request for creating a filter.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.wildduck.email/users/:user/filters");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"query\": {\n    \"from\": \"string\",\n    \"to\": \"string\",\n    \"subject\": \"string\",\n    \"listId\": \"string\",\n    \"text\": \"urgent,immediate OR deadline OR meeting standup\",\n    \"ha\": true,\n    \"size\": 0\n  },\n  \"action\": {\n    \"seen\": null,\n    \"flag\": null,\n    \"delete\": null,\n    \"spam\": null,\n    \"mailbox\": \"string\",\n    \"targets\": [\n      \"string\"\n    ]\n  },\n  \"disabled\": false,\n  \"metaData\": {},\n  \"sess\": \"string\",\n  \"ip\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### GET /webhooks

Source: https://docs.wildduck.email/docs/api/webhooks

Retrieve a list of all registered webhook subscriptions.

```APIDOC
## GET /webhooks

### Description
List all currently registered webhook subscriptions.

### Method
GET

### Endpoint
/webhooks
```

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

### Enable webhooks

Source: https://docs.wildduck.email/docs/operations/configuration

Toggle webhook functionality.

```toml
[webhooks]  
enabled = true   # at least one server must have this enabled
```

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

### GET /dkim/resolve/:domain

Source: https://docs.wildduck.email/docs/concepts/domain-management

Resolve DKIM key for a domain.

```APIDOC
## GET /dkim/resolve/:domain

### Description
Resolve DKIM key for a domain.

### Method
GET

### Endpoint
/dkim/resolve/:domain

### Parameters
#### Path Parameters
- **domain** (string) - Required - The domain to resolve.
```

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

### GET /users/:user/filters

Source: https://docs.wildduck.email/docs/concepts/message-filtering

List all filters for a specific user.

```APIDOC
## GET /users/:user/filters

### Description
Retrieve a list of all message filtering rules configured for the specified user.

### Method
GET

### Endpoint
/users/:user/filters
```

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

### Configure import-maildir

Source: https://docs.wildduck.email/docs/ecosystem/migration-guide

Edit the configuration file to set database credentials.

```bash
$ nano config/default.toml  
```

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

### GET Settings Endpoint

Source: https://docs.wildduck.email/docs/wildduck-api/get-settings

The base endpoint for retrieving registered settings.

```http
GET 
## https://api.wildduck.email/settings
```

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

### GET /domainaliases/:alias

Source: https://docs.wildduck.email/docs/wildduck-api/get-domain-alias

Retrieves the details of a specific domain alias.

```APIDOC
## GET /domainaliases/:alias

### Description
Retrieves information about a specific domain alias using its ID.

### Method
GET

### Endpoint
https://api.wildduck.email/domainaliases/:alias

### Parameters
#### Path Parameters
- **alias** (string) - Required - ID of the Alias

#### Query Parameters
- **sess** (string) - Optional - Session identifier for the logs
- **ip** (string) - Optional - IP address for the logs

### Response
#### Success Response (200)
- **success** (boolean) - Indicates successful response
- **id** (string) - ID of the Alias
- **alias** (string) - Alias domain
- **domain** (string) - Alias target
- **created** (date-time) - Datestring of the time the alias was created

#### Response Example
{
  "success": true,
  "id": "string",
  "alias": "string",
  "domain": "string",
  "created": "2024-07-29T15:51:28.071Z"
}
```

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

### GET /dkim/:dkim

Source: https://docs.wildduck.email/docs/wildduck-api/get-dkim-key

Retrieves the details of a specific DKIM key.

```APIDOC
## GET /dkim/:dkim

### Description
Retrieves detailed information about a specific DKIM key, including its domain, selector, fingerprint, and DNS TXT record information.

### Method
GET

### Endpoint
https://api.wildduck.email/dkim/:dkim

### Parameters
#### Path Parameters
- **dkim** (string) - Required - ID of the DKIM

#### Query Parameters
- **sess** (string) - Optional - Session identifier for the logs
- **ip** (string) - Optional - IP address for the logs

### Authorization
- **X-Access-Token** (apiKey) - Required - Header: X-Access-Token

### Response
#### Success Response (200)
- **success** (boolean) - Indicates successful response
- **id** (string) - ID of the DKIM
- **domain** (string) - The domain this DKIM key applies to
- **selector** (string) - DKIM selector
- **description** (string) - Key description
- **fingerprint** (string) - Key fingerprint (SHA1)
- **publicKey** (string) - Public key in DNS format
- **dnsTxt** (object) - Value for DNS TXT entry
  - **name** (string) - Domain name of TXT
  - **value** (string) - Value of TXT
- **created** (date-time) - DKIM created datestring

#### Response Example
{
  "success": true,
  "id": "string",
  "domain": "string",
  "selector": "string",
  "description": "string",
  "fingerprint": "string",
  "publicKey": "string",
  "dnsTxt": {
    "name": "string",
    "value": "string"
  },
  "created": "2024-07-29T15:51:28.071Z"
}
```

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

### Create Mailbox with HttpClient

Source: https://docs.wildduck.email/docs/wildduck-api/create-mailbox

C# implementation using HttpClient to send a POST request for mailbox creation.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.wildduck.email/users/:user/mailboxes");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-Access-Token", "<X-Access-Token>");
var content = new StringContent("{\n  \"path\": \"string\",\n  \"hidden\": false,\n  \"retention\": 0,\n  \"sess\": \"string\",\n  \"encryptMessages\": false,\n  \"ip\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### GET https://api.wildduck.email/filters

Source: https://docs.wildduck.email/docs/wildduck-api/get-all-filters

Retrieves a list of all filters configured for the user.

```APIDOC
## GET https://api.wildduck.email/filters

### Description
Retrieves a list of all filters configured for the user. Supports pagination and filtering by forward address.

### Method
GET

### Endpoint
https://api.wildduck.email/filters

### Parameters
#### Query Parameters
- **forward** (string) - Optional - Partial match of a forward email address or URL
- **metaData** (boolean) - Optional - If true, then includes metaData in the response
- **limit** (number) - Optional - How many records to return (Default: 20)
- **next** (string) - Optional - Cursor value for next page
- **previous** (string) - Optional - Cursor value for previous page
- **sess** (string) - Optional - Session identifier for the logs
- **ip** (string) - Optional - IP address for the logs

### Response
#### Success Response (200)
- **success** (boolean) - Indicates successful response
- **total** (number) - How many results were found
- **page** (number) - Current page number
- **previousCursor** (object) - Cursor string or false
- **nextCursor** (object) - Cursor string or false
- **results** (array) - List of filter objects

#### Response Example
{
  "success": true,
  "total": 541,
  "page": 0,
  "previousCursor": "string",
  "nextCursor": "string",
  "results": [
    {
      "id": "string",
      "user": "string",
      "name": "string",
      "created": "2024-07-29T15:51:28.071Z",
      "query": [],
      "action": [],
      "disabled": true,
      "metaData": {},
      "targets": ["string"],
      "originalQuery": {
        "from": "string",
        "to": "string",
        "subject": "string",
        "listId": "string",
        "text": "urgent,immediate OR deadline OR meeting standup",
        "ha": true,
        "size": 0
      },
      "originalAction": {
        "seen": null,
        "flag": null,
        "delete": null,
        "spam": null,
        "mailbox": "string",
        "targets": ["string"]
      }
    }
  ]
}
```

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

### API Endpoint Definition

Source: https://docs.wildduck.email/docs/wildduck-api/generate-totp-seed

The POST endpoint for initiating 2FA setup.

```http
POST 
## https://api.wildduck.email/users/:user/2fa/totp/setup
```

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

### Configure process settings

Source: https://docs.wildduck.email/docs/operations/configuration

Define the process title and worker count.

```toml
ident = "wildduck"   # process title  
processes = 1         # number of worker processes ("cpus" for auto)  
#user = "wildduck"   # downgrade privileges after start  
#group = "wildduck"
```

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

### GET https://api.wildduck.email/users/:user/search

Source: https://docs.wildduck.email/docs/wildduck-api/search-messages

Search for matching messages for a specific user.

```APIDOC
## GET https://api.wildduck.email/users/:user/search

### Description
This method allows searching for matching messages for a specific user.

### Method
GET

### Endpoint
https://api.wildduck.email/users/:user/search

### Parameters
#### Path Parameters
- **user** (string) - Required - ID of the User

#### Query Parameters
- **q** (string) - Optional - Additional query string
- **mailbox** (string) - Optional - ID of the Mailbox
- **id** (string) - Optional - Message ID values
- **thread** (string) - Optional - Thread ID
- **or** (object) - Optional - At least one of the included terms must match
- **query** (string) - Optional - Search string, uses MongoDB fulltext index
- **datestart** (date-time) - Optional - Datestring for the earliest message storing time
- **dateend** (date-time) - Optional - Datestring for the latest message storing time
- **from** (string) - Optional - Partial match for the From: header line
- **to** (string) - Optional - Partial match for the To: and Cc: header lines
- **subject** (string) - Optional - Partial match for the Subject: header line
- **minSize** (number) - Optional - Minimal message size in bytes
- **maxSize** (number) - Optional - Maximal message size in bytes
- **attachments** (boolean) - Optional - If true, matches only messages with attachments
- **flagged** (boolean) - Optional - If true, matches only messages with \Flagged flags
- **unseen** (boolean) - Optional - If true, matches only messages without \Seen flags
- **seen** (boolean) - Optional - If true, matches only messages with \Seen flags
- **useAndSearch** (boolean) - Optional - If true, fulltext search terms are combined with AND semantics
- **includeHeaders** (string) - Optional - Comma separated list of header keys to include
- **metaData** (boolean) - Optional - If true, includes metaData in the response
- **searchable** (boolean) - Optional - If true, matches messages not in Junk or Trash
- **sess** (string) - Optional - Session identifier for the logs
- **ip** (string) - Optional - IP address for the logs
- **threadCounters** (boolean) - Optional - If true, includes threadMessageCount in the response
- **limit** (number) - Optional - How many records to return
- **order** (any) - Optional - Ordering of the records (asc, desc)
- **next** (string) - Optional - Cursor value for next page
- **previous** (string) - Optional - Cursor value for previous page
```

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

### Configure OpenSearch in WildDuck

Source: https://docs.wildduck.email/docs/concepts/full-text-search

Define the OpenSearch connection details and enable the indexing worker in the configuration file.

```toml
[elasticsearch]  
enabled = false  
url = "http://127.0.0.1:9200"  
user = "elastic"  
pass = "supersecret"  
index = "wildduck"  
  
[elasticsearch.indexer]  
enabled = false   # enable the indexing worker
```

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

### GET /users/resolve/:username

Source: https://docs.wildduck.email/docs/wildduck-api/resolve-user

Resolves a username to its corresponding unique user ID.

```APIDOC
## GET https://api.wildduck.email/users/resolve/:username

### Description
Resolves a username to its corresponding unique user ID. The username must be alphanumeric and start with a letter.

### Method
GET

### Endpoint
https://api.wildduck.email/users/resolve/:username

### Parameters
#### Path Parameters
- **username** (string) - Required - Username of the User. Alphanumeric value. Must start with a letter, dots are allowed but informational only.

#### Query Parameters
- **sess** (string) - Optional - Session identifier for the logs
- **ip** (string) - Optional - IP address for the logs

### Authorization
- **X-Access-Token** (apiKey) - Required (if authentication is enabled) - Supply an access token in the X-Access-Token header.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates successful response
- **id** (string) - Unique ID (24 byte hex)

#### Response Example
{
  "success": true,
  "id": "609d201236d1d936948f23b1"
}
```

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

### Bash function invocation syntax

Source: https://docs.wildduck.email/docs/operations/command-line

Demonstrates how to call bash functions with varying numbers of arguments.

```bash
$ functionname  
$ functionname myargument1  
$ functionname myargument1 my2  
```

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

### GET /users/:user

Source: https://docs.wildduck.email/docs/wildduck-api/get-user

Retrieves the details of a specific user account by their identifier.

```APIDOC
## GET /users/:user

### Description
Retrieves the profile and configuration details for a specific user.

### Method
GET

### Endpoint
https://api.wildduck.email/users/:user

### Parameters
#### Path Parameters
- **user** (string) - Required - The identifier of the user to retrieve.

#### Query Parameters
- **sess** (string) - Optional - Session identifier.
- **ip** (string) - Optional - IP address associated with the request.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **id** (string) - User ID.
- **username** (string) - Username.
- **name** (string) - User display name.
- **address** (string) - Email address.
- **hasPasswordSet** (boolean) - If true, the user has a password set.
- **activated** (boolean) - Is the account activated.
- **disabled** (boolean) - If true, the user cannot authenticate or receive mail.
- **suspended** (boolean) - If true, the user cannot authenticate.
- **passwordPwned** (boolean) - Specifies if the password was found in a Pwned list.
- **require2faEnabled** (boolean) - If true, the account requires 2FA.
- **requirePasswordChange** (boolean) - Indicates if the password should be replaced.

### Authorization
- **X-Access-Token** (header) - Required if authentication is enabled.
```

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

### Configure Fail2Ban Default Settings

Source: https://docs.wildduck.email/docs/operations/operating-wildduck

Define global ignore IPs and ban parameters in the Fail2Ban custom configuration file.

```ini
[DEFAULT]  
ignoreip = 127.0.0.0/8 <your public IP> <any IP you need here>  
findtime = 1h  
bantime = 7d  
maxretry = 3  
```

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

### API Endpoint Definition

Source: https://docs.wildduck.email/docs/wildduck-api/get-user-address

The base URL and path structure for the GET request.

```text
GET 
## https://api.wildduck.email/users/:user/addresses/:address
```
Tokens:
Raw