5.11 Services

Services are the actions Secure Messaging Gateway takes on a message. These are indicated by the red pin on the component.

5.11.1 Add Header Line

The Add Header service injects the specified header line or lines into messages. To add a line or lines to a new header for the message, simply specify the desired line(s) in the provided field. Messages referred to this service will have these lines added to the beginning of the message.

Options

Message header.

5.11.2 Admin Quarantine

The Admin Quarantine service sends messages into the Quarantine system under administrator rights. Mail which has been quarantined will remain in the Quarantine system for 30 days by default. Normally, users are able to release messages from their own quarantine, however, the admin quarantine only allows users with administrator rights to release these messages.

NOTE:End users do not see these Admin Quaratine messages in their own Quarantine.

Options

This item does not require configuration. Use of this service will quarantine messages that are only accessible by a quarantine administrator.

5.11.3 Block

The block service prevents delivery of a message to the intended recipient(s). A filter that has exceptions connected to it will override the block service.

Options

This item does not require configuration.

5.11.4 Carbon Copy

The Carbon Copy service creates a BCC message and sends it to the specified address. This Service will be active on any filter that it is associated with. To add addresses to the list, simply enter them into the provided area. Multiple addresses may be used, each on an individual line.

Options

Addresses to copy to (add each address on its own line).

5.11.5 DKIM Sign

The DKIM Sign allows for the signing of outgoing messages. See Enabling DKIM Signing Enabling DKIM Signingfor more information.

5.11.6 Event Writer

The Event Writer creates a file associated with each time a connected filter or service is activated. The Event Writer is a simple way to create a custom log of whenever an event occurs. When attached to any event, the writer will create the specified file with the specified text. This is in addition to any notifications. If a desired event is to be recorded, or a file is to be created whenever an event occurs, the Event Writer should be used in association with that event. Tie the event writer to the desired event in the workbench and specify the destination file name and contents. While the file name may be anything desired, the contents will be created as shown in the Event Text window. You can also write the event to the scanner log and enable meta-data tags in the event text.

Meta-data Tags

When using meta-data tags in the logs, there are three forms that can be used:

  • %meta-var% - Writes the value of the meta-data to the log. If more than one item with the name exists, this will report the first one found. Example: %Recipient email%.

  • %meta-var[n]% - Write the value of the meta-data at the given index n where n is a number, 0 or higher. If the index is not found, the result will be blank. Example: %Recipient email[3]%.

  • %meta-var[s]% - Writes all of the values of the meta-data to the log separated by s where s is a string, but not a number. Example: %Recipient email[,]%.

The default meta-data that can be written is limited to the filter that triggers the event writer service. You can access all meta-data that is gathered by adding a colon to the front of the meta-data tag after the percent symbol. This is useful if you are exporting generic data to be consumed by other programs and just want a single meta-data collection node attached to the Message Received filter.

Example event text: SURBL: %:SURBL service%/%:Site matched% RBL: %:RBL service%/%:Client address%.

Available meta-data tags are as follow (grouped by event):

Global

  • %time% - Time formatted as hh:mm:ss.

  • %date% - Date formatted as yyyy-mm-dd.

  • %epoch% - Unix epoch value (number of seconds since Jan 1, 1970).

  • %procid% - The unique identifier of the message scan session

  • Address filter:

    • %Sender email% - The envelope sender address.

    • %Recipient email% - The envelope recipient address.

Antispam Filter

  • %Spam status% - When detected, which type of detection.

  • Attachment Name filter:

    • %Filename% - The matching file name.

    • %Extracted from% - The container file that the detected file was extracted from.

  • Attachment Size filter:

    • %Filename% - The file that did not conform to the size limits.

    • %Attachment size% - The size of the file.

    • %Maximum allowable size% - The maximum size limit.

    • %Minimum allowable size% - The minimum size limit.

Antivirus Filter

  • %Virus name% - The name of the virus that was detected.

Blacklist Filter

  • %Email from/to% - The address pair that triggered the filter.

ClamAV Filter

  • %ClamAv Virus name% - The name of the virus that was detected.

  • Fingerprint filter:

    • %Filename% - The matching file name.

    • %Extracted from% - The container file that the detected file was extracted from.

    • %Fingerprint% - The fingerprint that was detected.

IP Address Filter

  • %IP address% - The IP address that matched the filter.

  • IP Reputation filter:

    • %Source address detected% - The IP address that was marked as confirmed.

    • %Source address temp failed% - The IP address that was marked as suspicious.

  • Message size filter:

    • %Message size% - The size of the message.

    • %Maximum allowable size% - The maximum size limit.

    • %Minimum allowable size% - The minimum size limit.

  • RBL filter:

    • %RBL service% - The RBL server that detected the IP address.

    • %Client address% - The IP address of the connecting client used to check RBL.

    • %Header address% - The IP address from header used to check RBL.

  • SMTP filter:

    • %Envelope state% - The test that activated the filter.

  • SPF filter:

    • %IP address% - The connecting client IP address.

    • %Email address% - The envelope sender address.

  • SURBL filter:

    • %SURBL service% - The SURBL server used for detection.

    • %Site matched% - The URI that triggered the filter.

  • Text filter:

    • %Location% - The part of the message that matched the text filter.

5.11.7 Ham Reporting

Ham Reporting adds a link to a suspect message to allow the user to confirm thatit is a valid (ham) message rather then an undesired (spam) message.

Options

Message size limit: Scan messages smaller than this limit. In bytes. Default, 131073.

Storage Duration: In days, 0 or less will purge on that day's purge of data. Default, 4.

Signature template: Default, Spam Report Template (en).

Placement priority: Placement of signature priority in relation to other signatures. 0 is highest. Default, 0.

Release server URL: Does not normally need to be filled in. Default, the URL of the Report server.

Report server: Default, automatic.

Force SSL in report link: Linked to the release server URL. Default disabled.

5.11.8 Interface Control

Use this node to override actions of the interface that requested a message scan. Setting the delivery response overrides the default response sent to the connected mail system. This service is typically coupled with the block/quarantine service combination, where messages are blocked by Secure Messaging Gateway and placed in quarantine. In this situation, the sender is informed that the message was blocked, and may attempt to resend the message, even though it was in fact received - but not delivered on to the intended recipient. Overriding the response in this condition with an 'Accepted' response overrides the rejection response caused by the block service.

Options

Delivery response.

Accept (2xx).

Delay (3xx).

Reject (4xx).

5.11.9 Message Signature

The Message Signature Service appends a signature onto the end of messages. To dictate a signature to be added to messages, simply add the desired signature into the configuration field utilizing the tools provided.

Options

Signatures: Text, HTML or both.

Automatic text signature.

Placement priority.

5.11.10 Message Tag

Use the Message Tag service to replace or alter the subject line of a message.

Rule Priority

If multiple Message Tag services are applied during the scan process, the rule priority sets the order in which the rules are run. Each altered subject is fed into the next Message Tag service, starting with the highest numbered priority item and working down.

Rewrite Rule

The message subject will be replaced with the text provided here. Using the macro variables referenced, information from the original subject line can be included

Example

In this example, rather than rejecting or quarantining spam, the system will change the subject to indicate that the message is probably spam to the end user. Rewrite Rule: [possible spam] %original%

Options

Rule Priority.

Rewrite Rule.

Variable reference.

%original% - Insert the original header content.

%% - Insert a percent symbol.

5.11.11 Message Tracker

The Message Tracker service saves information about the message and results of the scanning process. The Message Tracker System contains detailed information about the message and the scanning process as well as information about the receipt and delivery of the message. Information will be recorded for all triggered filters unless you select the checkbox to only track filters that are connected to the message tracker service.

Options

Record only filters connected to this service.

5.11.12 Notify

When a filter is triggered there is the option of sending a notification. If you create a filter group and connect the Notify service only to the group then the only the group will be referenced in the message. If you connect all the filters in the group to the Notify service then they will each be referenced, if activated. This is useful if you want to hide a function such as a forward for record keeping purposes. If the forward is in a filter group then only the group will be seen.

For example, if an Attachment Size filter triggered because a an attachment was too large, a notification can be sent to the sender reminding them of the attachment size limitation. A notification can also be sent to the recipient to tell them that a message was received but could not be delivered due to the attachment size limitation. Another notification can be sent to the system administrator to alert them of the issue.

Options

Notification template: To customize templates, see TemplatesTemplates.

Notify Generic (en).

Notify Recipients (en).

Notify Sender (en).

Sender address: Enter a valid email address to be used by Secure Messaging Gateway as the notification sending address. This does not have to exist in the email system, but a validly formatted email address is required by most email servers. For example, SecureGatewayNotificationSender@gwava.com.

Customization: There are a number of customizations that can be made and the text box to make them, see below for details.

Notify sender: If enabled the sender of the triggering message will be sent a notification. Default, disabled.

Notify recipients: if enabled the recipients of the triggering message will be sent a notification. Default, disabled.

Additional addresses to notify (add additional addresses on their own line).

Customization

SenderName: Sender display name.

Subject: Notification subject.

MessageText: Text message body.

MessageHTML: HTML message body.

HideFilterList: This will hide what filters were activated be the message.

IncludeRecipientDetail: This will add a list of recipients to the notification message. You may want to consider adding this if you want a notification of what triggered a filter. You may not want this if you do not want the sender or recipients to know who may have received the message.

5.11.13 Quarantine

The Quarantine service places messages into the Quarantine Management System, (QMS). The Quarantine Management System is the holding location, where messages await possible review and, or, release to mailboxes. Users may manage their own quarantine if given rights to do so. Administrators may restrict specific types or filter-flagged messages from being released from QMS. All configuration of Quarantine activity is completed with User rights and the within QMS itself. This service building block is only for placing messages in the QMS system.

Options

This item does not require configuration. Use of this service will quarantine messages for user review. Quarantining a message does not cause messages to be blocked. To block and quarantine messages, ensure that a block service is also linked to the applicable filters.

5.11.14 Quarantine Control

Quarantine control provides the ability to selectively control what actions are available to the quarantine system for individual messages based on the configured filters. To implement this service, link the quarantine control node to the event that contains the filter that determines the control point. For example, to prevent dangerous attachments from being accessed, create a fingerprint filter to detect program file types and attach it to a quarantine control node with the disable release and disable attachment download options selected. With this setup, any messages that are placed in quarantine that have dangerous attachments can be reviewed by users, but not accessed. Disable digest - Prevents the quarantine service from including messages in the digest process Disable message release - Prevents users from releasing messages from the quarantine system. Disable attachment download - Prevents users from downloading attachments from the quarantine message viewer. Disable message view - Prevents users from opening and viewing messages. Messages are still listed in the users quarantine. Disable HTML view - Prevents users from viewing the HTML portion of messages which may contain objectionable images. Where 'User' is specified, this refers to controlling the end user functionality of the quarantine system. Where 'All' is specified, this refers to controlling all users of the quarantine system, including system administrators. This option provides safety against human error only, as admins can override the setting from the quarantine.

Options

Disable digest.

Disable message release: Default, no.

Disable attachment download: Default, no.

Disable message view: Default, no.

Disable HTML view: Default, no.

5.11.15 Spam Reporting

Spam Reporting adds a link to a suspect message to allow the user to confirm thatit is an undesired (spam) message rather then a valid (ham) message.

Options

Message size limit: Scan messages smaller than this limit. In bytes. Default, 131073.

Storage Duration: In days, 0 or less will purge on that day's purge of data. Default, 4.

Signature template: Default, Spam Report Template (en).

Placement priority: Placement of signature priority in relation to other signatures. 0 is highest. Default, 0.

Release server URL: Does not normally need to be filled in. Default, the URL of the Report server.

Report server: Default, automatic.

Force SSL in report link: Linked to the release server URL. Default disabled.

5.11.16 Statistics Recorder

The statistics recorder records data on messages passing through the system where it is connected to events, exceptions, and filters. This is used with the Message Received filter. This Service requires no configuration. Simply set it in the correct listening spot in the system.

Options

This item does not require configuration.