Era.Common.NetworkMessage.ConsoleApi.Config.RpcSendEmailRequest

Description

Sends testing email. Used to verify mail server settings.

Properties

Name	JsonSchemaType	Description
authenticationType	enum of Era.Common.DataDefinition.EmailSender.AuthenticationType	SMTP Authentication type.
recipientAddress	string	Recipient address for the testing email. If not set, senderAddress is used as recipient.
securityType	enum of Era.Common.DataDefinition.EmailSender.ConnectionSecurityType	SMTP Connection type.
senderAddress	string	Sender address for the testing email.
smtpHost	string	Address of the mail server.
smtpPassword	string	Password for login to the mail server. If no password is provided, password from current server configuration is used.
smtpPort	integer	Port of the mail server.
smtpUsername	string	Username for login to the mail server.
transactionId	integer	If the UI desn't contain all necessary information (passwords are not propagated to UI when editing configuration/policy), then this is the ID of a transaction, from which the data can be retrieved.

Dual message (request/response)

Era.Common.NetworkMessage.ConsoleApi.Config.RpcSendEmailResponse

Referenced in messages

No references.

JsonSchema

{
    "title": "Era.Common.NetworkMessage.ConsoleApi.Config.RpcSendEmailRequest",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.NetworkMessage.ConsoleApi.Config.RpcSendEmailRequest"
    ],
    "properties": {
        "Era.Common.NetworkMessage.ConsoleApi.Config.RpcSendEmailRequest": {
            "$ref": "#/definitions/RpcSendEmailRequest"
        }
    },
    "definitions": {
        "RpcSendEmailRequest": {
            "additionalProperties": false,
            "required": [
                "authenticationType",
                "securityType",
                "senderAddress",
                "smtpHost",
                "smtpPort",
                "smtpUsername"
            ],
            "type": "object",
            "properties": {
                "authenticationType": {
                    "enum": [
                        1,
                        2,
                        3,
                        4,
                        5,
                        6,
                        7,
                        9,
                        10,
                        15
                    ]
                },
                "recipientAddress": {
                    "pattern": "[^\\r\\n]+@[^\\r\\n]+",
                    "type": "string"
                },
                "securityType": {
                    "enum": [
                        1,
                        2,
                        3
                    ]
                },
                "senderAddress": {
                    "pattern": "[^\\r\\n]+@[^\\r\\n]+",
                    "type": "string"
                },
                "smtpHost": {
                    "type": "string"
                },
                "smtpPassword": {
                    "type": "string"
                },
                "smtpPort": {
                    "exclusiveMaximum": false,
                    "exclusiveMinimum": false,
                    "maximum": 65535,
                    "minimum": 0,
                    "type": "integer"
                },
                "smtpUsername": {
                    "type": "string"
                },
                "transactionId": {
                    "type": "integer"
                }
            }
        }
    }
}