git subrepo commit mailcow/src/mailcow-dockerized
subrepo: subdir: "mailcow/src/mailcow-dockerized"
merged: "308860af"
upstream: origin: "https://github.com/mailcow/mailcow-dockerized.git"
branch: "master"
commit: "3f1a5af8"
git-subrepo: version: "0.4.5"
origin: "???"
commit: "???"
Change-Id: I5d51c14b45db54fe706be40a591ddbfcea50d4b0
diff --git a/mailcow/src/mailcow-dockerized/data/web/api/openapi.yaml b/mailcow/src/mailcow-dockerized/data/web/api/openapi.yaml
index 8b6558d..6310aa5 100644
--- a/mailcow/src/mailcow-dockerized/data/web/api/openapi.yaml
+++ b/mailcow/src/mailcow-dockerized/data/web/api/openapi.yaml
@@ -209,10 +209,17 @@
- app_passwd
- add
- active: "1"
- app_name: emclient
+ username: info@domain.tld
+ app_name: wordpress
app_passwd: keyleudecticidechothistishownsan31
app_passwd2: keyleudecticidechothistishownsan31
- username: hello@mailcow.email
+ protocols:
+ - imap_access
+ - dav_access
+ - smtp_access
+ - eas_access
+ - pop3_access
+ - sieve_access
msg: app_passwd_added
type: success
schema:
@@ -249,6 +256,13 @@
app_name: wordpress
app_passwd: keyleudecticidechothistishownsan31
app_passwd2: keyleudecticidechothistishownsan31
+ protocols:
+ - imap_access
+ - dav_access
+ - smtp_access
+ - eas_access
+ - pop3_access
+ - sieve_access
properties:
active:
description: is alias active or not
@@ -497,27 +511,30 @@
relay_all_recipients: "0"
rl_frame: s
rl_value: "10"
+ tags: ["tag1", "tag2"]
- null
msg:
- domain_added
- domain.tld
type: success
schema:
- properties:
- log:
- description: contains request object
- items: {}
- type: array
- msg:
- items: {}
- type: array
- type:
- enum:
- - success
- - danger
- - error
- type: string
- type: object
+ type: array
+ items:
+ type: object
+ properties:
+ log:
+ description: contains request object
+ items: {}
+ type: array
+ msg:
+ items: {}
+ type: array
+ type:
+ enum:
+ - success
+ - danger
+ - error
+ type: string
description: OK
headers: {}
tags:
@@ -544,6 +561,7 @@
rl_frame: s
rl_value: "10"
restart_sogo: "10"
+ tags: ["tag1", "tag2"]
properties:
active:
description: is domain active or not
@@ -563,6 +581,11 @@
domain:
description: Fully qualified domain name
type: string
+ gal:
+ description: >-
+ is domain global address list active or not, it enables
+ shared contacts accross domain in SOGo webmail
+ type: boolean
mailboxes:
description: limit count of mailboxes associated with this domain
type: number
@@ -580,6 +603,9 @@
if not, them you have to create "dummy" mailbox for each
address to relay
type: boolean
+ relay_unknown_only:
+ description: Relay non-existing mailboxes only. Existing mailboxes will be delivered locally.
+ type: boolean
rl_frame:
enum:
- s
@@ -590,6 +616,11 @@
rl_value:
description: rate limit value
type: number
+ tags:
+ description: tags for this Domain
+ type: array
+ items:
+ type: string
type: object
summary: Create domain
/api/v1/add/domain-admin:
@@ -1010,6 +1041,7 @@
force_pw_update: "1"
tls_enforce_in: "1"
tls_enforce_out: "1"
+ tags: ["tag1", "tag2"]
- null
msg:
- mailbox_added
@@ -1054,6 +1086,7 @@
force_pw_update: "1"
tls_enforce_in: "1"
tls_enforce_out: "1"
+ tags: ["tag1", "tag2"]
properties:
active:
description: is mailbox active or not
@@ -1934,21 +1967,23 @@
- domain2.tld
type: success
schema:
- properties:
- log:
- description: contains request object
- items: {}
- type: array
- msg:
- items: {}
- type: array
- type:
- enum:
- - success
- - danger
- - error
- type: string
- type: object
+ type: array
+ items:
+ type: object
+ properties:
+ log:
+ description: contains request object
+ items: {}
+ type: array
+ msg:
+ items: {}
+ type: array
+ type:
+ enum:
+ - success
+ - danger
+ - error
+ type: string
description: OK
headers: {}
tags:
@@ -1959,14 +1994,15 @@
content:
application/json:
schema:
+ type: object
example:
- domain.tld
- domain2.tld
properties:
- items:
- description: contains list of domains you want to delete
- type: object
- type: object
+ items:
+ type: array
+ items:
+ type: string
summary: Delete domain
/api/v1/delete/domain-admin:
post:
@@ -2716,6 +2752,140 @@
type: object
type: object
summary: Delete Transport Maps
+ "/api/v1/delete/mailbox/tag/{mailbox}":
+ post:
+ parameters:
+ - description: name of mailbox
+ in: path
+ name: mailbox
+ example: info@domain.tld
+ required: true
+ schema:
+ type: string
+ responses:
+ "401":
+ $ref: "#/components/responses/Unauthorized"
+ "200":
+ content:
+ application/json:
+ examples:
+ response:
+ value:
+ - log:
+ - mailbox
+ - delete
+ - tags_mailbox
+ - tags:
+ - tag1
+ - tag2
+ mailbox: info@domain.tld
+ - null
+ msg:
+ - mailbox_modified
+ - info@domain.tld
+ type: success
+ schema:
+ properties:
+ log:
+ description: contains request object
+ items: {}
+ type: array
+ msg:
+ items: {}
+ type: array
+ type:
+ enum:
+ - success
+ - danger
+ - error
+ type: string
+ type: object
+ description: OK
+ headers: {}
+ tags:
+ - Mailboxes
+ description: You can delete one or more mailbox tags.
+ operationId: Delete mailbox tags
+ requestBody:
+ content:
+ application/json:
+ schema:
+ example:
+ - tag1
+ - tag2
+ properties:
+ items:
+ description: contains list of mailboxes you want to delete
+ type: object
+ type: object
+ summary: Delete mailbox tags
+ "/api/v1/delete/domain/tag/{domain}":
+ post:
+ parameters:
+ - description: name of domain
+ in: path
+ name: domain
+ example: domain.tld
+ required: true
+ schema:
+ type: string
+ responses:
+ "401":
+ $ref: "#/components/responses/Unauthorized"
+ "200":
+ content:
+ application/json:
+ examples:
+ response:
+ value:
+ - log:
+ - mailbox
+ - delete
+ - tags_domain
+ - tags:
+ - tag1
+ - tag2
+ domain: domain.tld
+ - null
+ msg:
+ - domain_modified
+ - domain.tld
+ type: success
+ schema:
+ properties:
+ log:
+ description: contains request object
+ items: {}
+ type: array
+ msg:
+ items: {}
+ type: array
+ type:
+ enum:
+ - success
+ - danger
+ - error
+ type: string
+ type: object
+ description: OK
+ headers: {}
+ tags:
+ - Domains
+ description: You can delete one or more domain tags.
+ operationId: Delete domain tags
+ requestBody:
+ content:
+ application/json:
+ schema:
+ example:
+ - tag1
+ - tag2
+ properties:
+ items:
+ description: contains list of domains you want to delete
+ type: object
+ type: object
+ summary: Delete domain tags
/api/v1/edit/alias:
post:
responses:
@@ -2820,23 +2990,25 @@
$ref: "#/components/responses/Unauthorized"
"200":
content:
- "*/*":
+ application/json:
schema:
- properties:
- log:
- description: contains request object
- items: {}
- type: array
- msg:
- items: {}
- type: array
- type:
- enum:
- - success
- - danger
- - error
- type: string
- type: object
+ type: array
+ items:
+ type: object
+ properties:
+ log:
+ type: array
+ description: contains request object
+ items: {}
+ msg:
+ type: array
+ items: {}
+ type:
+ enum:
+ - success
+ - danger
+ - error
+ type: string
description: OK
headers: {}
tags:
@@ -2865,6 +3037,7 @@
quota: "10240"
relay_all_recipients: "0"
relayhost: "2"
+ tags: ["tag3", "tag4"]
items: domain.tld
properties:
attr:
@@ -2903,13 +3076,33 @@
if not, them you have to create "dummy" mailbox for each
address to relay
type: boolean
+ relay_unknown_only:
+ description: Relay non-existing mailboxes only. Existing mailboxes will be delivered locally.
+ type: boolean
relayhost:
description: id of relayhost
type: number
+ rl_frame:
+ enum:
+ - s
+ - m
+ - h
+ - d
+ type: string
+ rl_value:
+ description: rate limit value
+ type: number
+ tags:
+ description: tags for this Domain
+ type: array
+ items:
+ type: string
type: object
items:
description: contains list of domain names you want update
- type: object
+ type: array
+ items:
+ type: string
type: object
summary: Update domain
/api/v1/edit/fail2ban:
@@ -3019,6 +3212,7 @@
sogo_access: "1"
username:
- info@domain.tld
+ tags: ["tag3", "tag4"]
- null
msg:
- mailbox_modified
@@ -3066,6 +3260,7 @@
- domain3.tld
- "*"
sogo_access: "1"
+ tags: ["tag3", "tag4"]
items:
- info@domain.tld
properties:
@@ -3154,6 +3349,7 @@
evaluate_x_prio: "0"
key: 21e8918e1jksdjcpis712
only_x_prio: "0"
+ sound: "pushover"
senders: ""
senders_regex: ""
text: ""
@@ -3197,6 +3393,7 @@
evaluate_x_prio: "0"
key: 21e8918e1jksdjcpis712
only_x_prio: "0"
+ sound: "pushover"
senders: ""
senders_regex: ""
text: ""
@@ -3218,6 +3415,9 @@
only_x_prio:
description: Only send push for prio mails
type: number
+ sound:
+ description: Set notification sound
+ type: string
senders:
description: Only send push for emails from these senders
type: string
@@ -3793,6 +3993,13 @@
- all
- mailcow.tld
type: string
+ - description: comma seperated list of tags to filter by
+ example: "tag1,tag2"
+ in: query
+ name: tags
+ required: false
+ schema:
+ type: string
- description: e.g. api-key-string
example: api-key-string
in: header
@@ -3831,6 +4038,7 @@
relay_all_recipients: "0"
relayhost: "0"
rl: false
+ tags: ["tag1", "tag2"]
- active: "1"
aliases_in_domain: 0
aliases_left: 400
@@ -3853,6 +4061,7 @@
relay_all_recipients: "0"
relayhost: "0"
rl: false
+ tags: ["tag3", "tag4"]
description: OK
headers: {}
tags:
@@ -4345,6 +4554,13 @@
- all
- user@domain.tld
type: string
+ - description: comma seperated list of tags to filter by
+ example: "tag1,tag2"
+ in: query
+ name: tags
+ required: false
+ schema:
+ type: string
- description: e.g. api-key-string
example: api-key-string
in: header
@@ -4382,6 +4598,7 @@
rl: false
spam_aliases: 0
username: info@doman3.tld
+ tags: ["tag1", "tag2"]
description: OK
headers: {}
tags:
@@ -4805,7 +5022,7 @@
schema:
example:
attr:
- rl_vlaue: "10"
+ rl_value: "10"
rl_frame: "h"
items:
- info@domain.tld
@@ -4815,7 +5032,7 @@
rl_frame:
description: contains the frame for the ratelimit h,s,m
type: string
- rl_vlaue:
+ rl_value:
description: contains the rate for the ratelimit 10,20,50,1
type: number
type: object
@@ -4876,7 +5093,7 @@
schema:
example:
attr:
- rl_vlaue: "10"
+ rl_value: "10"
rl_frame: "h"
items:
- domain.tld
@@ -4886,7 +5103,7 @@
rl_frame:
description: contains the frame for the ratelimit h,s,m
type: string
- rl_vlaue:
+ rl_value:
description: contains the rate for the ratelimit 10,20,50,1
type: number
type: object
@@ -5072,6 +5289,27 @@
of used storage.
operationId: Get vmail status
summary: Get vmail status
+ /api/v1/get/status/version:
+ get:
+ responses:
+ "401":
+ $ref: "#/components/responses/Unauthorized"
+ "200":
+ content:
+ application/json:
+ examples:
+ response:
+ value:
+ version: "2022-04"
+ description: OK
+ headers: {}
+ tags:
+ - Status
+ description: >-
+ Using this endpoint you can get the current running release of this
+ instance.
+ operationId: Get version status
+ summary: Get version status
/api/v1/get/syncjobs/all/no_log:
get:
responses:
@@ -5268,6 +5506,60 @@
attr:
spam_score: "8,15"
summary: Edit mailbox spam filter score
+ "/api/v1/get/mailbox/all/{domain}":
+ get:
+ parameters:
+ - description: name of domain
+ in: path
+ name: domain
+ required: false
+ schema:
+ type: string
+ - description: e.g. api-key-string
+ example: api-key-string
+ in: header
+ name: X-API-Key
+ required: false
+ schema:
+ type: string
+ responses:
+ "401":
+ $ref: "#/components/responses/Unauthorized"
+ "200":
+ content:
+ application/json:
+ examples:
+ response:
+ value:
+ - active: "1"
+ attributes:
+ force_pw_update: "0"
+ mailbox_format: "maildir:"
+ quarantine_notification: never
+ sogo_access: "1"
+ tls_enforce_in: "0"
+ tls_enforce_out: "0"
+ domain: domain3.tld
+ is_relayed: 0
+ local_part: info
+ max_new_quota: 10737418240
+ messages: 0
+ name: Full name
+ percent_class: success
+ percent_in_use: 0
+ quota: 3221225472
+ quota_used: 0
+ rl: false
+ spam_aliases: 0
+ username: info@domain3.tld
+ tags: ["tag1", "tag2"]
+ description: OK
+ headers: {}
+ tags:
+ - Mailboxes
+ description: You can list all mailboxes existing in system for a specific domain.
+ operationId: Get mailboxes of a domain
+ summary: Get mailboxes of a domain
tags:
- name: Domains