Channel type "Mail" (via HTTP)

Use the following file for a Mail channel.

JSON


{
"type": "MAIL",
"operation": "add",
"name": "My Mail channel",
"relation": "My partner",
"dmz": true,
"direction": "both",
"active": true,
"id": 0,
"local": {
"id": "my local id",
"password": "secret",
"server": ""
},
"remote": {
"id": "my remote id",
"password": "secret",
},
"types": {
"smtp": false,
"asmtp": true,
"pop3": false,
"imap": true
},
"logSettings": {
"retainDays": -1,
"enabled": true
},
"certificates": {
"own": {
"encryption": 0,
},
"partner": {
"encryption": 0
}
},
"sendSigned": false,
"receiveSigned": false,
"sendEncrypted": false,
"receiveEncrypted": false,
"sendCompressed": false,
"signatureAlgorithm": "",
"encryptionAlgorithm": "",
"mailServer": "",
"user": "",
"loginMethod": "",
"imapFolder": "",
"maxMailSize": 1024,
"contact": {
"language": "de",
"name": "John Doe",
"fax": "",
"email": "john.doe@example.com",
"note": ""
}
}

Parameters


Name

Description

type

Fixed value MAIL.

operation

Fixed value add.

name

Name of the channel to be added.

relation

Name of the existing partner for which the channel is to be added.

dmz

Checkbox Invisible to DMZ in the channel GUI will be set for value false.

direction

The value in sets the value incoming in field Direction in the channel GUI.

The value out sets the value outgoing in field Direction in the channel GUI.

The value both sets the value incoming and outgoing in field Direction in the channel GUI.

active

Checkbox Active in the channel GUI will be set for value true.

id

Fixed value 0.

local (id, password, server)

Fields Own ID, Own password and Partner address in tab Own ID in the channel GUI.

remote (id, password)

Fields Partner ID and Partner password in tab Partner ID in the channel GUI.

types (smtp, asmtp, pop3, imap)

Area Allowed sub types in the channel GUI.

logSettings (retainDays, enabled)

Checkboxes Retain days and Use Comm-Log in the channel GUI.

certificates

own (encryption)

partner (encryption)

Here you can specify the certificate ID (see sections Local Certificates and Partner Certificates) for the fields Local certificate (encryption) and Partner certificate (encryption) in the channel GUI.

sendSigned

Checkbox Send signed in the channel GUI.

receiveSigned

Checkbox Receive signed in the channel GUI.

sendEncrypted

Checkbox Send encrypted in the channel GUI.

receiveEncrypted

Checkbox Receive encrypted in the channel GUI.

sendCompressed

Checkbox Send compressed in the channel GUI.

signatureAlgorithm

Field Signature algorithm in the channel GUI.

encryptionAlgorithm

Field Encryption in the channel GUI.

mailServer

Field Server-URL in the channel GUI.

user

Field SMTP User in the channel GUI.

loginMethod

Field Login method in the channel GUI.

imapFolder

Field IMAP Directory in the channel GUI.

maxMailSize

Field Max. size for incoming mails in the channel GUI.

contact (language, name, fax, email, note)

See tab "Partner contact" (self-explanatory) in the channel GUI.