Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Updated for v4.16

Overview

The nFORM system provides integration with messaging systems to provide a means for communicating with external entities.

...

The following configuration settings are available when configuring emails:

Setting

Definition

email.isSendEnabled

Master switch" for email - turn it on or off by toggling this value.

email.support.address

Support Email Address – listed as the email contact on the site.  This can be an individual or email group. 

email.admin.address

All security and system emails will be sent to this address.

email.fromAddress

Address used to send notifications to users. 

email.fromAddressDisplayName

Display name show on emails to users. 

email.templateBasePath

Path to the base template files.  

email.templateOverridePath

Path to the active set of email templates.

email.smtpServerHost

IP address or DNS of the SMTP server. 

email.smtpServerPort

Port used by SMPT mail. Default is 25. 

email.useSsl

Determines whether SSL is used to encrypt emails.  Your SMTP server must support this feature. 

email.smtpServerUsername

Username for sending email if required.  Leave blank if it is not going to be used. 

email.smtpServerPassword

Password for sending email if required.  Leave blank if it is not going to be used.

email.genericName

Generic Name for addressing emails if user name is not available. 

In addition to specifying the settings used for identifying and authenticating sending messages with the email server, any emails sent out from by the system can be configured to have a custom email subject by overriding the default value. 

An example of the configuration settings are below:

<add key="email.smtpServerHost" value="smtp.windsor.com"/>

<add key="email.smtpServerPort" value="25"/>

<add key="email.useSsl" value="false"/>

<add key="email.admin.address" value="admin@windsorsolutions.com" />

<add key="email.smtpServerUsername" value="XXXXXXXX"/>

<add key="email.smtpServerPassword" value="XXXXXXXX"/>

<add key="email.isSendEnabled" value="true"/>

Info

A common third-party email service used by nFORM is SendGrid.  SendGrid has stopped support for standard username/password integration.  The replacement is to use the word ‘apikey’ in the username field and in the password field enter a key generated on the SendGrid website.

...