How to customise NoSpamProxy notifications

To customise the user notifications, you must adapt the corresponding default templates and save them in a special folder for customised templates.

Pay particular attention to the following points:

The standard templates are available as CSHTML files (with the exception of two HtmlProcessCardTemplate files) and are located in the %Program Files%\Net at Work Mail Gateway\Intranet Role\Templates directory, or in the %Program Files%\NoSpamProxy\Intranet Role\Templates directory for new installations.
Make sure that you save the customised template files under C:\ProgramData\Net at Work Mail Gateway\Templates Customizations\ to make them update-proof. The original files must remain in the default folder.
You only need to make these changes on the Intranet Role. The contents are automatically replicated to all connected Gateway Roles.

Procedure after updates

After updating NoSpamProxy, it is possible that changes have been made to one or more default templates. You can recognise this by a different version number, among other things. The version number of a template file can be found at the very beginning of the corresponding file, for example @* Version: 1 *@ or <?xml version="1.0" encoding="utf-8" ?>. In these cases, you must manually update the template files you have customised, otherwise the default template will be used again.

Proceed as follows to update the customised template files:

Copy the corresponding default templates into the folder for customised files (see above).
Match their version numbers with the version numbers of the default templates.
Make the desired changes to the files (again).

Overview of available template files

ApplySymmetricEncryptionPasswordNotice.cshtml

When a user sends an email as a PDF mail, he receives a notification about the password used, or an information that the recipient has been sent the password via SMS or that the creation of the PDF Mail failed. The text of the notification is in this file. The appearance is defined via the CommonMail template.

AttachmentManager.cshtml

When NoSpamProxy removes a file attachment from an email, a replacement file is attached to the email to notify the user that the original file has been removed. The corresponding message text can be edited in the Attachment Manager.cshtml file.

AttachmentQuarantine.cshtml

When NoSpamProxy removes an attachment from an email and quarantines it, a replacement file is attached to the email to notify the user that the original file has been removed. The user has the possibility to download the remote file directly from the quarantine via a download link. The corresponding message text can be edited in the attachment Quarantine.cshtml file.

AttachmentQuarantineApproval.cshtml

When NoSpamProxy removes an attachment from an email and quarantines it, a replacement file is attached to the email to notify the user that the original file has been removed. The user has the option to download the remote file from the quarantine via a download link after approval by the administrator. The corresponding message text can be edited in the attachment QuarantineApproval.cshtml file.

CommonMailTemplate.cshtml

This file defines the general appearance of notifications. Here, for example, the colors and the logos to be used are stored as HTML tags. All other files except the "ConvertMailContentToPdfAttachmentActionPdfHeader.cshtml" contain only the text modules.

ConvertMailContentToPdfAttachmentActionPdfHeader.cshtml

The appearance of the PDF file is defined in this file. Colors and logos must be defined here again.

ConvertMailContentToPdfAttachmentActionTeaser.cshtml

This file contains the text for the carrier email of the PDF file. The recipient of a PDF Mail is informed that the actual content of the e-mail is in the attached PDF document. The appearance is defined via the CommonMail template.

DeliveryNotificationReport.cshtml

This is the content of the transmission report if a user has requested it in Outlook. The appearance is defined via the CommonMail template.

DeMailConnectorIssueEscalationMail.cshtml

If NoSpamProxy cannot download de-mails from the DMDA for a period of time, a notification is sent to the administrative email address. The content of this notification can be edited here.

English.HtmlProcessCardTemplate

The content of the German test report can be edited in this file. Audit reports are generated at the request of the administrator if an e-mail was signed and/or encrypted, for example.

EmailHintsHTML.cshtml

The texts for the HTML versions of the email hints can be edited in this file.

EmailPlainText.cshtml

The texts for the plain text versions of the email hints can be edited in this file.

EncryptedMailNotificationTemplate.cshtml

If a user marks an email as "Encrypt automatically" and enQsig does not have a cryptographic key, the recipient will be informed. This email will tell you what options he or sh has. The content of this email is recorded in this template. The appearance is defined via the CommonMail template.

EncryptionDelayedNotificationForSender.cshtml

If a user marks an email as "Encrypt automatically" and enQsig does not have a cryptographic key, the recipient will be informed. The content of the delay message is defined here. The appearance is defined via the CommonMail template.

EncryptionFailureNotificationForSender.cshtml

If a user marks an email as "Encrypt automatically" and an error occurs during encryption, the sender will be informed. The content of this message is here. The appearance is defined via the CommonMail template.

EncryptionSucceededNotificationForSender.cshtml

If a user marks an email as "Automatically encrypt", he will receive a notification as soon as the email has been encrypted. The appearance is defined via the CommonMail template.

English.HtmlProcessCardTemplate

The content of the English test report can be edited in this file. Audit reports are generated at the request of the administrator if an e-mail was signed and/or encrypted, for example.

LargeFileDownloadNotification.cshtml

If a user sends a file via Large Files, he will receive a notification when the recipient has downloaded the file. The content of the notification can be edited here.

MailOnHoldExpired.cshtml

If a user marks an email as "Encrypt automatically" and enQsig has no cryptographic key and the recipient of the email does not deposit a cryptographic key within 5 days, the email will be discarded and the sender will be informed. The content of this message is here. The appearance is defined via the CommonMail template.

MailValidationError.cshtml

If a De-Mail cannot be sent via the De-Mail connector, the sender will be notified. The content of this message is here. The appearance is defined via the CommonMail template.

PolicyFailureNonDeliveryMessage.cshtml

If an email violates any of the guidelines in the rulebook, the sender is notified. The content of this message is here. The appearance is defined via the CommonMail template.

QualifiedSignatureIssueEscalationMail.cshtml

If the verification or creation of a qualified signature fails, a notification is sent to a specified address. The content of this message is here. The appearance is defined via the CommonMail template.

SampleAutoReply.cshtml

Since NoSpamProxy 10 it has been possible to have an automatic reply generated if, for example, a particular email address is contacted. The content of this automatic reply can be adjusted here.

You can copy this file and save it under a different name. You then specify the template file for the respective purpose in the NoSpamProxy rule set.

SymmetricPasswordUpdateNotification.cshtml

If an external recipient has stored a password for the PDF email on the Web Portal, he or she will be notified of the change. The content of this message is here. The appearance is defined via the CommonMail template.

WordFilterMatchNotification.cshtml

Since NoSpamProxy 10, it has been possible to send a notification to a specific email address as soon as certain words appear in an email. In this file you define the content of the notification.

Adaptation of the template files

Start with the file "CommonMailTemplate". Here you determine the appearance of all emails. Customise the StyleSheets in the respective files according to your needs. The integration of the corresponding logo is also done in this file. In later operation, the logo files with the correct name must also be available in the Templates folder.

All other files contain only the text modules.

After restarting the Intranet Role, the new designs are used and replicated to the Gateway Role(s).

NOTE: Note that the files may be overwritten during patching/upgrading. After a patch/upgrade, check if your customised files are still present.