Gateways
The Gateways section lets you create gateways for your notification system. Gateways are used when setting up a subscription and determine in what way users will be contacted: via email or internal notifications in CP. You can create multiple gateways to verify without any limitation.
To view your gateways:
- Go to your Control Panel > Admin > Gateways menu.
- The following page shows your gateways with their names and the types:
- SMTP
- SENDMAIL
- INTERNAL
Configure Gateways
To add a new gateway:
- Go to your Control Panel > Admin > Gateways menu.
- Click the New gateway or + button.
- On the page that appears, select the delivery method for the gateway:
- SMTP or SENDMAIL for email notifications
- INTERNAL for internal notifications in the CP
- Click Select to proceed to the next gateway creation step.
Depending on the selected delivery method, fill in the following details:
For the Transaction Approvals functionality, you need to add a SENDMAIL gateway with the System SENDMAIL Gateway label or/and an SMTP gateway with the System SMTP Gateway label.
For the SENDMAIL delivery method:
- Name - the name for your new gateway. The name of the gateway should not contain any special characters
- Primary - move the slider to the right to mark current gateway as primary to be used to receive the notifications on set/reset/forgot password/unlock a user. The previous primary gateway will be unmarked
- From - the email address from which emails will be sent
- Host - the server IP or URL
For the INTERNAL delivery method:
- Name - the name for your new gateway. The name of the gateway should not contain any special characters
For the SMTP delivery method:
- Name - the name for your new gateway. The name of the gateway should not contain any special characters
- Primary - move the slider to the right to mark current gateway as primary to be used to receive the notifications on set/reset/forgot password/unlock a user. The previous primary gateway will be unmarked
- Enable SMTP authentication - move the slider to the right to create the gateway that requires authentication to send notifications
SMTP authentication - select an authentication mechanism from the drop-down list: plain, login, or cram_md5
SMTP authentication mechanismSMTP authentication mechanisms
- After the client has sent the plain command to the server, the server responds with a reply code. Then the username and password are sent from the client to the server. The username and password are combined to one string and encoded.
- After that the login command has been sent to the server, the server asks for username and password by sending encoded text to the client.
- cram_md5 combines a challenge-response authentication mechanism to exchange information and a cryptographic Message Digest 5 algorithm to encrypt important information.
- SMTP user name - user name to login into SMTP server
- SMTP password - password to login into SMTP server
- From - the email address from which emails will be sent
- Host - the OnApp Control Panel server IP or hostname
- SMTP address - hostname or IP of the SMTP server
- SMTP port - port of the SMTP server
- SMTP domain - the SMTP server associated domain
SMTP enable starttls auto - enable the StartTLS extension
- Verify certificate (if tls enabled) - select the checkbox to verify the certificate
- Click Save to finish the creation process.
(SMTP delivery method)
Manage Gateways
Gateways are used when setting up a subscription and determine in what way users will be contacted: via email or internal notifications in CP.
To view your gateways:
- Go to your Control Panel > Admin > Gateways menu.
- The following page shows your gateways with their names and the types:
- SMTP
- SENDMAIL
- INTERNAL
Edit Gateway
To edit a gateway:
- Go to your Control Panel > Admin > Gateways menu.
- Click the Actions button next to the required gateway and select Edit.
- Depending on the gateway's delivery method, edit the following details:
For the SENDMAIL delivery method:
- Name - the name for your new gateway. The name of the gateway should not contain any special characters
- From - the email address from which emails will be sent
- Host - the server IP or URL
For the INTERNAL delivery method:
- Name - the name for your new gateway. The name of the gateway should not contain any special characters
For the SMTP delivery method:
- Name - the name for your new gateway. The name of the gateway should not contain any special characters
- Primary - move the slider to the right to mark current gateway as primary to be used to receive the notifications on set/reset/forgot password/unlock a user. The previous primary gateway will be unmarked
- Enable SMTP authentication - move the slider to the right to create the gateway that requires authentication to send notifications
- SMTP authentication - select an authentication mechanism from the drop-down list: plain, login, or cram_md5
- SMTP user name - user name to login into SMTP server
- SMTP password - password to login into SMTP server
- From - the email address from which emails will be sent
- Host - the OnApp Control Panel server IP or hostname
- SMTP address - hostname or IP of the SMTP server
- SMTP port - port of the SMTP server
- SMTP domain - the SMTP server associated domain
- SMTP enable starttls auto - enable the STARTTLS extension
- Verify certificate (if tls enabled) - select the checkbox to verify the certificate
- Click Save to apply the changes.
Delete Gateway
To delete a gateway:
- Go to your Control Panel > Admin > Gateways menu.
- Click the Actions button next to the gateway you want to delete and select Delete.
A gateway that is associated with at least one subscription cannot be deleted.