EmailEngine

https://learn.emailengine.app/docs
Admin
EmailEngine is a self-hosted email gateway providing a unified REST API for accessing and managing...
Tokens:975,129
Snippets:6,472
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### WireGuard VPN setup example

Source: https://learn.emailengine.app/docs/deployment/security

Commands to install WireGuard, generate keys, and a sample configuration for /etc/wireguard/wg0.conf to enable secure remote access to the admin interface.

```bash
# WireGuard example  
sudo apt install wireguard  
  
# Generate keys  
wg genkey | tee privatekey | wg pubkey > publickey  
  
# Configure /etc/wireguard/wg0.conf  
[Interface]  
Address = 10.0.0.1/24  
PrivateKey = <server-private-key>  
ListenPort = 51820  
  
[Peer]  
PublicKey = <client-public-key>  
AllowedIPs = 10.0.0.2/32  
```

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

### Install and start Redis on WSL2

Source: https://learn.emailengine.app/docs/installation/windows

Starts WSL2, installs Redis, and starts the Redis server. Connect from Windows using redis://localhost:6379.

```bash
# Start WSL2  
wsl  
  
# Install Redis in WSL2  
sudo apt update  
sudo apt install redis-server  
sudo service redis-server start  
  
# Exit WSL2  
exit  

```

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

### Install and Start Redis with Homebrew

Source: https://learn.emailengine.app/docs/installation/macos

Installs and starts Redis, which is required by EmailEngine. The final command verifies Redis is running and should return PONG.

```bash
# Install Homebrew if not already installed  
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"  
  
# Install Redis  
brew install redis  
  
# Start Redis  
brew services start redis  
  
# Verify  
redis-cli ping  # Should return: PONG  
```

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

### Quick Start: Install EmailEngine via npm, Linux binary, Docker, or source

Source: https://learn.emailengine.app/docs/installation

Quick Start block covering four installation methods: global npm install (Node.js 20+), Linux binary download, Docker container run, and source production deployment. The source tarball has no top-level directory, so create one before extracting.

```bash
# npm: Install globally (requires Node.js 20+)  
npm install -g emailengine-app  
emailengine --dbs.redis="redis://127.0.0.1:6379/8"  
  
# Linux: Download binary  
wget https://go.emailengine.app/emailengine.tar.gz  
tar xzf emailengine.tar.gz  
sudo mv emailengine /usr/local/bin/  
  
# Docker: Run container  
docker run -p 3000:3000 --env EENGINE_REDIS="redis://host.docker.internal:6379/8" postalsys/emailengine:v2  
  
# Source: Production deployment (the tarball has no top-level directory, so make one)  
wget https://go.emailengine.app/source-dist.tar.gz  
mkdir emailengine && tar xzf source-dist.tar.gz -C emailengine && cd emailengine  
node server.js  
```

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

### Start WSL2

Source: https://learn.emailengine.app/docs/installation/windows

Starts the WSL2 environment from Windows. Run this before installing EmailEngine inside WSL2.

```bash
# Start WSL2  
wsl  

```

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

### Start EmailEngine with Custom Configuration

Source: https://learn.emailengine.app/docs/configuration/cli

Starts EmailEngine with custom configuration options. This example sets Redis connection, API port and host, IMAP worker count, and log level.

```bash
emailengine \
  --dbs.redis="redis://127.0.0.1:6379/8" \
  --api.port=3000 \
  --api.host="0.0.0.0" \
  --workers.imap=8 \
  --log.level="info"  
```

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

### Shell - Test EmailEngine installation

Source: https://learn.emailengine.app/docs/installation/source

Starts the EmailEngine server from the app directory. Use Ctrl+C to stop it.

```bash
cd /opt/emailengine  
node app/server.js
```

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

### Run the EmailEngine Installer

Source: https://learn.emailengine.app/docs/installation/linux

Make the script executable and run it with the target hostname. Replace example.com with your actual domain.

```bash
chmod +x install.sh  
sudo ./install.sh example.com
```

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

### C# HttpClient GET request example

Source: https://learn.emailengine.app/docs/api/get-v-1-account-account-message-message-source

C# example using HttpClient to send a GET request to the source endpoint. Requires a bearer token and Accept header.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://emailengine.example.com/v1/account/:account/message/:message/source");  
request.Headers.Add("Accept", "message/rfc822");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  

```

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

### Example .env.example file for EmailEngine

Source: https://learn.emailengine.app/docs/configuration

Commit this file to document configuration. Includes a comment on generating the hash. The EENGINE_PREPARED_PASSWORD value is a hash, not a plain password.

```bash
# .env.example (commit this)  
EENGINE_HOST=0.0.0.0  
EENGINE_PORT=3000  
EENGINE_REDIS=redis://localhost:6379  
# Generate hash: emailengine password -p "your-password" --hash  
EENGINE_PREPARED_PASSWORD=JHBia2RmMi1zaGEyNTYkaT02MDAwMDAk...  

```

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

### GET /v1/accounts

Source: https://learn.emailengine.app/docs/api-reference

Example request to retrieve accounts using the GET method.

```APIDOC
## [GET] /v1/accounts

### Description
Retrieves a list of accounts associated with the authenticated user.

### Method
GET

### Endpoint
/v1/accounts

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.

### Request Example
```
curl https://emailengine.example.com/v1/accounts \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

### Response
#### Success Response (200)
- **accounts** (array) - List of account objects.

#### Response Example
```
{
  "accounts": []
}
```
```

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

### Example response for Get Account API

Source: https://learn.emailengine.app/docs/api/get-v-1-account-account

A JSON example of the account object returned by the Get Account API. It shows the structure with fields for account identification, IMAP and SMTP configuration, OAuth2 settings, and connection status.

```json
{  
  "account": "user123",  
  "name": "My Email Account",  
  "email": "user@example.com",  
  "expectedEmail": "user@example.com",  
  "copy": true,  
  "logs": false,  
  "notifyFrom": "2021-07-08T07:06:34.336Z",  
  "path": [  
    "*"  
  ],  
  "imapIndexer": "full",  
  "authFailureDisabledAt": "2021-03-22T13:13:31.000Z",  
  "subconnections": [  
    "[Gmail]/Spam",  
    "\\Sent"  
  ],  
  "webhooks": "https://myservice.com/imap/webhooks",  
  "proxy": "socks5://proxy.example.com:1080",  
  "smtpEhloName": "relay.example.com",  
  "imap": {  
    "useAuthServer": false,  
    "auth": {  
      "user": "myuser@gmail.com",  
      "accessToken": false,  
      "pass": "verysecret"  
    },  
    "secure": true,  
    "tls": {  
      "rejectUnauthorized": true,  
      "minVersion": "TLSv1.2"  
    },  
    "disableIMAP4rev2": false,  
    "resyncDelay": 900,  
    "disabled": false,  
    "host": "imap.gmail.com",  
    "port": 993,  
    "sentMailPath": "Sent Mail",  
    "draftsMailPath": "Drafts",  
    "junkMailPath": "Junk",  
    "trashMailPath": "Trash",  
    "archiveMailPath": "Archive"  
  },  
  "smtp": {  
    "useAuthServer": false,  
    "auth": {  
      "user": "myuser@gmail.com",  
      "accessToken": false,  
      "pass": "verysecret"  
    },  
    "host": "smtp.gmail.com",  
    "port": 587,  
    "secure": false,  
    "tls": {  
      "rejectUnauthorized": true,  
      "minVersion": "TLSv1.2"  
    }  
  },  
  "oauth2": {  
    "authorize": false,  
    "redirectUrl": "https://myapp/account/settings.php",  
    "provider": "AAABhaBPHscAAAAH",  
    "auth": {  
      "user": "user@outlook.com",  
      "delegatedUser": "shared.mailbox@outlook.com",  
      "delegatedAccount": "user123"  
    },  
    "useAuthServer": false,  
    "accessToken": "ya29.a0ARrdaM8a...",  
    "refreshToken": "1//09Ie3CtORQYm...",  
    "expires": "2021-03-22T13:13:31.000Z",  
    "scope": [  
      "https://mail.google.com/"  
    ],  
    "tokenType": "Bearer",  
    "generated": "2021-03-22T13:13:31.000Z",  
    "refreshTokenGenerated": "2021-03-22T13:13:31.000Z",  
    "userFlag": {}  
  },  
  "state": "connected",  
  "smtpStatus": {  
    "created": "2021-07-08T07:06:34.336Z",  
    "status": "ok",  
    "response": "250 OK",  
    "description": "Authentication failed",  
    "responseCode": 500,  
    "code": "EAUTH",  
    "command": "AUTH PLAIN",  
    "networkRouting": {  
      "localAddress": "198.51.100.24",  
      "name": "relay.example.com"  
    }  
  },  
  "gmailWatch": {  

```

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

### Create directories and enable EmailEngine instances

Source: https://learn.emailengine.app/docs/deployment/systemd

Creates the per-instance data directories, sets ownership to the emailengine user, and enables/starts the tenant-a and tenant-b instances.

```bash
sudo mkdir -p /var/lib/emailengine/tenant-a /var/lib/emailengine/tenant-b  
sudo chown emailengine:emailengine /var/lib/emailengine/tenant-*  
sudo systemctl enable --now emailengine@tenant-a emailengine@tenant-b  

```

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

### Set EENGINE_PREPARED_LICENSE and start EmailEngine

Source: https://learn.emailengine.app/docs/configuration/prepared-settings/license

Sets the prepared license key via environment variable and starts EmailEngine. At startup, EmailEngine verifies the key and stores it in Redis, logging 'License imported'. A key that does not verify or has expired is fatal: the log shows 'License import failed' and the process exits with status 13.

```bash
export EENGINE_PREPARED_LICENSE="your-license-key-here"  
emailengine  
```

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

### HttpClient GET Request

Source: https://learn.emailengine.app/docs/api/get-v-1-accounts

Example of performing a GET request to the v1 accounts endpoint using C# HttpClient.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://emailengine.example.com/v1/accounts");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### start EmailEngine with --preparedToken command-line flag

Source: https://learn.emailengine.app/docs/configuration/prepared-settings/tokens

Passes the prepared token directly as a command-line argument when starting EmailEngine.

```bash
emailengine --preparedToken="hKJpZNlAMzAxZThjNTFhZjgxM2Q3MzUxNTYzYTFlM2I1NjVkYmEzZWJjMzk4ZjI4OWZjNjgzN"
```

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

### GET /v1/blocklists with HttpClient (C#)

Source: https://learn.emailengine.app/docs/api/get-v-1-blocklists

Use this C# example to call the GET /v1/blocklists endpoint with bearer token authentication. It sends an HTTP GET request to https://emailengine.example.com/v1/blocklists, adds the Accept and Authorization headers, and prints the response body. The example uses HttpClient and awaits the response, ensuring success status before reading the content.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://emailengine.example.com/v1/blocklists");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  

```

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

### GET /v1/accounts response example

Source: https://learn.emailengine.app/docs/api/get-v-1-accounts

Example response for the GET /v1/accounts endpoint. Shows a paginated list of accounts with fields such as total, page, pages, and an accounts array. Includes a lastError object with OAuth2 token request details and error flags.

```json
{  
  "total": 120,  
  "page": 0,  
  "pages": 24,  
  "query": false,  
  "state": "*",  
  "accounts": [  
    {  
      "account": "user123",  
      "name": "My Email Account",  
      "email": "user@example.com",  
      "type": "outlook",  
      "app": "AAABhaBPHscAAAAH",  
      "state": "connected",  
      "webhooks": "https://myservice.com/imap/webhooks",  
      "proxy": "socks5://proxy.example.com:1080",  
      "smtpEhloName": "relay.example.com",  
      "counters": {  
        "events": {  
          "messageNew": 30,  
          "messageDeleted": 5  
        }  
      },  
      "syncTime": "2021-02-17T13:43:18.860Z",  
      "authFailureDisabledAt": "2021-03-22T13:13:31.000Z",  
      "lastError": {  
        "response": "Token request failed for gmail (refresh_token, HTTP 400): invalid_grant - Token has been expired or revoked.",  
        "description": "Authentication failed",  
        "serverResponseCode": "OauthRenewError",  
        "tokenRequest": {  
          "url": "https://oauth2.googleapis.com/token",  
          "method": "post",  
          "grant": "refresh_token",  
          "provider": "gmail",  
          "status": 400,  
          "clientId": "1023289917884-h3nu00e9cbh252e24c23sv24l8k19ah.apps.googleusercontent.com",  
          "clientSecret": "GOCSPX...V-Da",  
          "authority": "common",  
          "serviceClient": "113328088575530522",  
          "signer": "serviceKey",  
          "googleProjectId": "project-name-425411",  
          "serviceClientEmail": "service-account@project-name-425411.iam.gserviceaccount.com",  
          "code": "AAABhaBPHscAAAAH",  
          "flag": {  
            "message": "Please verify the OAuth2 application credentials",  
            "code": "INVALID_CLIENT_SECRET",  
            "url": "https://console.developers.google.com/"  
          },  
          "userFlag": {  
            "message": "The grant for this account has been revoked"  
          },  
          "scopes": [  
            "https://mail.google.com/"  
          ],  
          "response": {  
            "error": "invalid_grant",  
            "error_description": "Bad Request"  
          }  
        }  
      },  
      "delegationError": "Delegated account was not found"  
    }  
  ]  
}  

```
```

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

### C# HttpClient example

Source: https://learn.emailengine.app/docs/api/get-v-1-account-account-export-exportid-download

Example using HttpClient in C# to download the export. Sends a GET request with Accept and Authorization headers.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://emailengine.example.com/v1/account/:account/export/:exportId/download");  
request.Headers.Add("Accept", "application/gzip");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

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

### EmailEngine configuration priority order example

Source: https://learn.emailengine.app/docs/reference/configuration-options

Illustrates the priority order for startup keys: environment variable wins, then command line, then configuration file. The example shows that with api.port set to 3000 in the config file, 4000 on the command line, and EENGINE_PORT=5000 in the environment, the effective port is 5000. Runtime settings stored in Redis are not part of this order and only affect the first start.

```text
# Config file: api.port = 3000  
# Command line: --api.port=4000  
# Environment: EENGINE_PORT=5000  
  
# Result: port 5000, because the environment wins  

```

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

### C# HttpClient Request to GET /v1/tokens

Source: https://learn.emailengine.app/docs/api/get-v-1-tokens

C# example using HttpClient to send a GET request to the tokens endpoint with bearer authentication.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://emailengine.example.com/v1/tokens");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

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

### Create .env file and start EmailEngine

Source: https://learn.emailengine.app/docs/configuration/environment-variables

Creates a .env file with Redis and secret values, then starts EmailEngine, which loads the .env file automatically.

```bash
# Create .env file  
echo "EENGINE_REDIS=redis://localhost:6379" > .env  
echo "EENGINE_SECRET=$(openssl rand -hex 32)" >> .env  
  
# Start EmailEngine (will load .env automatically)  
emailengine  

```

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

### C# HttpClient GET /v1/gateways

Source: https://learn.emailengine.app/docs/api/get-v-1-gateways

C# example using HttpClient to send a GET request to the /v1/gateways endpoint with Bearer token authentication.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://emailengine.example.com/v1/gateways");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Load configuration with --config flag

Source: https://learn.emailengine.app/docs/configuration/cli

Command to start EmailEngine with a specified TOML configuration file.

```bash
emailengine --config=/etc/emailengine/config.toml  

```

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

### C# HttpClient GET Request

Source: https://learn.emailengine.app/docs/api/get-v-1-outbox

C# example using HttpClient to send a GET request to the outbox endpoint with bearer token authorization.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://emailengine.example.com/v1/outbox");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Start EmailEngine

Source: https://learn.emailengine.app/docs/advanced/encryption

Start EmailEngine after setting EENGINE_SECRET. All credentials stored from now on are encrypted.

```bash
emailengine  

```

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

### start EmailEngine with EENGINE_PREPARED_TOKEN environment variable

Source: https://learn.emailengine.app/docs/configuration/prepared-settings/tokens

Sets the prepared token as an environment variable and starts EmailEngine. The token must be a valid exported record; otherwise the process exits with status 1.

```bash
export EENGINE_PREPARED_TOKEN=hKJpZNlAMzAxZThjNTFhZjgxM2Q3MzUxNTYzYTFlM2I1NjVkYmEzZWJjMzk4ZjI4OWZjNjgzN
emailengine
```

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

### C# HttpClient request example

Source: https://learn.emailengine.app/docs/api/get-v-1-changes

C# example using HttpClient to make a GET request to the /v1/changes endpoint with bearer token authentication.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://emailengine.example.com/v1/changes");  
request.Headers.Add("Accept", "text/event-stream");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  

```

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

### Minimal production configuration with command-line arguments

Source: https://learn.emailengine.app/docs/configuration/environment-variables

Minimal production configuration using command-line arguments.

```bash
emailengine \  
  --dbs.redis="redis://localhost:6379" \  
  --api.host="0.0.0.0" \  
  --api.port=3000  

```

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

### GET /v1/tokens Response Example

Source: https://learn.emailengine.app/docs/api/get-v-1-tokens

Example response body for the GET /v1/tokens endpoint. Shows a paginated list of tokens with fields such as account, total, page, pages, and a tokens array containing token details like scopes, restrictions, permissions, and access information.

```json
{
  "account": "user123",
  "total": 12,
  "page": 0,
  "pages": 1,
  "tokens": [
    {
      "account": "user123",
      "description": "Token description",
      "metadata": "{\"example\": \"value\"}",
      "ip": "127.0.0.1",
      "remoteAddress": "127.0.0.1",
          "scopes": [
        "api"
      ],
      "restrictions": {
        "referrers": [
          "*web.domain.org/*",
          "*.domain.org/*",
          "https://domain.org/*"
        ],
        "addresses": [
          "1.2.3.4",
          "5.6.7.8",
          "127.0.0.0/8"
        ],
        "rateLimit": {
          "maxRequests": 20,
          "timeWindow": 2
        }
      },
      "permissions": {
        "actions": [
          "read"
        ],
        "groups": [
          "message",
          "mailbox"
        ]
      },
      "created": "2021-02-17T13:43:18.860Z",
      "expires": "2021-02-17T14:43:18.860Z",
      "access": {
        "time": "2021-02-17T13:43:18.860Z",
        "ip": "127.0.0.1"
      },
      "id": "1bc12baf7f0d5e51fe0a4e0eda06e1be5b8d6cc2c66b95dc0fbe4d2e9f5d5e1a"
    }
  ]
}
```

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

### Access EmailEngine general help

Source: https://learn.emailengine.app/docs/configuration/cli

Display all available commands using the help flags or command.

```bash
# Show all available commands
emailengine --help
emailengine -h
emailengine help
```

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

### C# GET Request with HttpClient

Source: https://learn.emailengine.app/docs/api/get-v-1-oauth-2

C# example using HttpClient to send a GET request to the OAuth2 endpoint with bearer token authentication and print the response.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://emailengine.example.com/v1/oauth2");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Download the EmailEngine Installer

Source: https://learn.emailengine.app/docs/installation/linux

Download the installation script using either wget or curl.

```bash
wget https://go.emailengine.app -O install.sh  
# or  
curl -L https://go.emailengine.app -o install.sh
```

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

### GET /v1/outbox/{queueId} - Success Response

Source: https://learn.emailengine.app/docs/api/get-v-1-outbox-queueid

Example response body for a successful GET request to /v1/outbox/{queueId}. Contains queue metadata, envelope, progress, and error details.

```json
{  
  "queueId": "1869c5692565f756b33",  
  "account": "user123",  
  "source": "smtp",  
  "messageId": "<test123@example.com>",  
  "envelope": {  
    "from": "sender@example.com",  
    "to": [  
      "recipient@example.com"  
    ]  
  },  
  "subject": "What a wonderful message",  
  "gateway": "example",  
  "proxy": "socks5://proxy.example.com:1080",  
  "localAddress": "198.51.100.24",  
  "idempotencyKey": "submit-12345",  
  "useStructuredFormat": true,  
  "created": "2021-02-17T13:43:18.860Z",  
  "scheduled": "2021-02-17T13:43:18.860Z",  
  "nextAttempt": "2021-02-17T13:43:18.860Z",  
  "attemptsMade": 3,  
  "attempts": 3,  
  "progress": {  
    "status": "queued",  
    "response": "250 Message Accepted",  
    "messageId": "<test123@example.com>",  
    "originalMessageId": "<test123@example.com>",  
    "error": {  
      "message": "Authentication failed",  
      "code": "EAUTH",  
      "statusCode": 502,  
      "networkRouting": {  
        "localAddress": "198.51.100.24",  
        "name": "relay.example.com"  
      }  
    }  
  }  
}  
```

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

### C# HttpClient GET Request to Queue Settings

Source: https://learn.emailengine.app/docs/api/get-v-1-settings-queue-queue

C# example using HttpClient to send a GET request to the queue settings endpoint. Requires a bearer token for authorization.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://emailengine.example.com/v1/settings/queue/:queue");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Connection Options as Query Parameters

Source: https://learn.emailengine.app/docs/configuration/redis

Examples of using query parameters for TLS, IP family, and password/database options.

```bash
# Connect with TLS  
EENGINE_REDIS="rediss://redis.example.com:6380"  
  
# Specify IPv4 or IPv6  
EENGINE_REDIS="redis://redis.example.com:6379?family=4"  # Force IPv4  
EENGINE_REDIS="redis://redis.example.com:6379?family=6"  # Force IPv6  
  
# Password and database as parameters instead of URL parts  
EENGINE_REDIS="redis://redis.example.com:6379?password=secret&db=8"  
```

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

### Load and Start EmailEngine Launch Agent

Source: https://learn.emailengine.app/docs/installation/macos

Loads and starts the EmailEngine launch agent. Run these commands after creating the plist file.

```bash
launchctl load ~/Library/LaunchAgents/com.emailengine.plist  
launchctl start com.emailengine  
```
Tokens:
Raw