Skip to main content
API docs by Redocly

Maildaemon API (1.2)

Download OpenAPI specification:Download

One Unity Consulting GmbH: info@one-unity.de URL: https://one-unity.de/kontakt Terms of Service

This API gives you the opportunity to read the monitoring databases and create, edit and delete mailbox configurations

Mailbox

create mailbox configuration

Authorizations:
ApiKey
header Parameters
x-api-version
string
Request Body schema:
active
boolean
mailbox
string or null <email>
host
string or null
type
string or null
port
integer <int32>
useSsl
boolean
clientId
string or null
tenantId
string or null
clientSecret
string or null
username
string or null
password
string or null
folders
Array of strings or null
deleteMailsOnServer
boolean
object (MailArchiving)

Mail archiving options

allowedEmailExtensions
Array of strings or null
exportAttachments
boolean
allowedAttachments
Array of strings or null
Array of objects or null (DestinationOptions)

Responses

Request samples

Content type
{
  • "active": true,
  • "mailbox": "user@example.com",
  • "host": "string",
  • "type": "string",
  • "port": 0,
  • "useSsl": true,
  • "clientId": "string",
  • "tenantId": "string",
  • "clientSecret": "string",
  • "username": "string",
  • "password": "string",
  • "folders": [
    ],
  • "deleteMailsOnServer": true,
  • "mailArchiving": {
    },
  • "allowedEmailExtensions": [
    ],
  • "exportAttachments": true,
  • "allowedAttachments": [
    ],
  • "destinations": [
    ]
}

Response samples

Content type
No sample

get a mailbox configuration via given uuid

Authorizations:
ApiKey
path Parameters
uuid
required
string

System.String

header Parameters
x-api-version
string

Responses

Response samples

Content type
No sample

update an existing mailbox

Authorizations:
ApiKey
path Parameters
uuid
required
string

System.String

header Parameters
x-api-version
string
Request Body schema:

maildaemon.core.models.MailboxOptions

property name*
additional property
any

Responses

Request samples

Content type
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
No sample

delete an existing mailbox

Authorizations:
ApiKey
path Parameters
uuid
required
string

System.String

header Parameters
x-api-version
string

Responses

Response samples

Content type
No sample

Validate the connection to the email and destination server

Authorizations:
ApiKey
path Parameters
uuid
required
string
header Parameters
x-api-version
string

Responses

Response samples

Content type
No sample

Monitoring

get all entries from failed processed emails

Authorizations:
ApiKey
header Parameters
x-api-version
string

Responses

Response samples

Content type
No sample

get all entries from successful processed emails

Authorizations:
ApiKey
header Parameters
x-api-version
string

Responses

Response samples

Content type
No sample

Delete monitoring entry

Authorizations:
ApiKey
path Parameters
id
required
integer <int32>

System.Int32

header Parameters
x-api-version
string

Responses

Response samples

Content type
No sample

get all entries from MailboxInfo

Authorizations:
ApiKey
header Parameters
x-api-version
string

Responses

Response samples

Content type
No sample