Type Definitions
DKIM
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
domain |
String | The domain which a key should be generated for | ||
dkim_selector |
String |
<optional> |
'dkim'
|
The dkim selector |
key_size |
2048 | 1024 |
<optional> |
2048
|
The size of the key |
Object representing a DKIM Key
Type:
- Object
Example
{
"domain": "example.com",
"dkim_selector": "dkim",
"key_size": 2048
}
Domain
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
domain |
String | Name of the domain to add | ||
active |
Number |
<optional> |
1
|
Whether the domain should be active or not |
aliases |
Number |
<optional> |
400
|
Number of aliases allowed |
defquota |
Number |
<optional> |
3072
|
|
mailboxes |
Number |
<optional> |
10
|
|
maxquota |
Number |
<optional> |
10240
|
|
quota |
Number |
<optional> |
10240
|
For all options check out https://demo.mailcow.email/api/
Type:
- Object
Example
{
active: 1,
domain: "example.com",
aliases: 400, // responding "object is not numeric" if missing is this a BUG? should be "aliases missing" if cant be omited anyway
backupmx: 0,
defquota: 3072,
description: "Hello!",
lang: "en",
mailboxes: 10,
maxquota: 10240,
quota: 10240,
relay_all_recipients: 0,
rl_frame: "s",
rl_value: 10
}
DomainAdmin
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
domains |
Array | String | The domains/domain this admin should be able to access | ||
username |
String |
<optional> |
RANDOM
|
|
password |
String |
<optional> |
RANDOM
|
|
active |
0 | 1 |
<optional> |
1
|
Object representing a domain admin
Type:
- Object
Example
{
"active": 1,
"domains": "example.com",
"password": "supersecurepw",
"username": "testadmin"
}
Mailbox
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
domain |
String | domain for wich the mailbox shall be created | ||
local_part |
String |
<optional> |
"mail"
|
the local part of the mail address before the @ |
name |
String |
<optional> |
"John Doe"
|
full name of the user |
password |
String |
<optional> |
RANDOM
|
password for the user. if omitted one will be generated |
quota |
Number |
<optional> |
3072
|
maximum size of the mailbox |
active |
0 | 1 |
<optional> |
1
|
whether the mailbox is active or not |
Object representing a mailbox
Type:
- Object
Example
{
"domain": "example.com",
"local_part": "john.doe",
"name": "John Doe",
"password": "paulIstToll",
"quota": 3072,
"active": 1
}