public
nobgit
read
NobMail
Based on mailcow: dockerized
Languages
Repository composition by tracked source files.
PHP
49%
JavaScript
35%
HTML
9%
CSS
4%
Shell
2%
Python
1%
Lua
0%
Perl
0%
Ruby
0%
SCSS
0%
Create file
Wiki Documentation
Clone
https://nobgit.com/orgs/nobgit/nobmail.git
ssh://[email protected]:2222/orgs/nobgit/nobmail.git
Commit
Add missing API endpoint to openapi.yaml
842cc429
data/web/api/openapi.yaml | 149 +++++++++++++++++++++++++++++++++-------------
1 file changed, 106 insertions(+), 43 deletions(-)Diff
diff --git a/data/web/api/openapi.yaml b/data/web/api/openapi.yaml
index e1ef65bb..9d34e442 100644
--- a/data/web/api/openapi.yaml
+++ b/data/web/api/openapi.yaml
@@ -131,6 +131,69 @@ paths:
type: boolean
type: object
summary: Create alias
+ /api/v1/add/time_limited_alias:
+ post:
+ responses:
+ "401":
+ $ref: "#/components/responses/Unauthorized"
+ "200":
+ content:
+ application/json:
+ examples:
+ response:
+ value:
+ - log:
+ - mailbox
+ - add
+ - time_limited_alias
+ - address: [email protected]
+ domain: domain.tld
+ - null
+ msg:
+ - mailbox_modified
+ - [email protected]
+ 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:
+ - Aliases
+ description: >-
+ You may create a time limited alias using this action. It takes a JSON
+ object containing a domain and mailbox informations.
+ Mailcow will generate a random alias.
+ operationId: Create time limited alias
+ requestBody:
+ content:
+ application/json:
+ schema:
+ example:
+ username: [email protected]
+ domain: domain.tld
+ properties:
+ username:
+ description: 'the mailbox an alias should be created for'
+ type: string
+ domain:
+ description: "the domain"
+ type: string
+ type: object
+ summary: Create time limited alias
/api/v1/add/app-passwd:
post:
responses:
@@ -618,31 +681,31 @@ paths:
value:
- type: success
log:
- - acl
- - edit
- - testadmin
- - username:
+ - acl
+ - edit
- testadmin
- da_acl:
- - syncjobs
- - quarantine
- - login_as
- - sogo_access
- - app_passwds
- - bcc_maps
- - pushover
- - filters
- - ratelimit
- - spam_policy
- - extend_sender_acl
- - unlimited_quota
- - protocol_access
- - smtp_ip_access
- - alias_domains
- - domain_desc
+ - username:
+ - testadmin
+ da_acl:
+ - syncjobs
+ - quarantine
+ - login_as
+ - sogo_access
+ - app_passwds
+ - bcc_maps
+ - pushover
+ - filters
+ - ratelimit
+ - spam_policy
+ - extend_sender_acl
+ - unlimited_quota
+ - protocol_access
+ - smtp_ip_access
+ - alias_domains
+ - domain_desc
msg:
- - acl_saved
- - testadmin
+ - acl_saved
+ - testadmin
schema:
properties:
log:
@@ -674,25 +737,25 @@ paths:
schema:
example:
items:
- - testadmin
+ - testadmin
attr:
da_acl:
- - syncjobs
- - quarantine
- - login_as
- - sogo_access
- - app_passwds
- - bcc_maps
- - pushover
- - filters
- - ratelimit
- - spam_policy
- - extend_sender_acl
- - unlimited_quota
- - protocol_access
- - smtp_ip_access
- - alias_domains
- - domain_desc
+ - syncjobs
+ - quarantine
+ - login_as
+ - sogo_access
+ - app_passwds
+ - bcc_maps
+ - pushover
+ - filters
+ - ratelimit
+ - spam_policy
+ - extend_sender_acl
+ - unlimited_quota
+ - protocol_access
+ - smtp_ip_access
+ - alias_domains
+ - domain_desc
properties:
items:
description: contains the domain admin username you want to edit
@@ -759,11 +822,11 @@ paths:
schema:
example:
items:
- - testadmin
+ - testadmin
attr:
active:
- - '0'
- - '1'
+ - '0'
+ - '1'
username_new: testadmin
domains: ["domain.tld"]
password: supersecurepassword