MxmsSettings.json

An example mxmsSettings.json file open in Visual Studio

To provide a flexible and scalable environment, we use JSON (JavaScript Object Notation) for all system settings and user preferences which change from instance to instance. JSON is a lightweight, text-based data format that is easy for humans to read and write, and easy for machines to parse and generate. By modifying the configuration file, you can customize the behavior of the application without needing to touch the underlying source code.

Example configuration

{
  "MailServer": {
    "Server": "my.smtp-server",
    "From": "my@default_fromaddress.com",
    "To": "my@default_toaddress.com",
    "Port": 587,
    "EnableSsl": true,
    "Username": "username@my.smtpserver",
    "Password": "password@my.smtpserver"
  },
  "ConnectionString": "server=localhost;database=my-database.mxms;user id=username;password=password"
}

Mail server settings

MXMS requires a valid SMTP server to send various system mails, e.g. password reset mails or welcome mails and to send mails using the built-in mail sender system. Currently only a standard SMTP mailserver is supported.

Server

Provide a valid DNS name or IP address of the SMTP server to be used.

Port

If the SMTP server uses a port other than the default port a port can be provided

Username

If your SMTP server requires authentication provide a valid username here. If you don't need authentication this parameter can be left blank or be omitted.

Password

If your SMTP server requires authentication please provide a valid password here. If you don't need authentication this parameter can be left blank or be omitted.

From address

This is the default from address for outgoing mails if a from address is not supplied or cannot be supplied.

To address

The To address is a development / debugging function which overrides the To address to the address set in this field. All mails will be sent to this address regardless of the actual To address.