Menu

Readme

Artifex

General

This project contains a .Net 3.5 class library (DLL) that can be plugged into an MS-Exchange 2010 Server in order to add a disclaimer, banner, signature and virtually any type of content to your emails.

I decided to build this project after I realized that by using the built-in tools of MS-Exchange 2010 I can only add content below or above the mail body (by using Transport Rules) but not to the left or to the right of the message body (I tried using transport rules to open a table before the message body by using the prepend disclaimer rule and close it with the append disclaimer rule but exchange automatically closed the table that I opened in the first rule).

This transport agent is installed on the MS-Exchange server directly and by using the Transport Rules you can set which (if any) content will be added to each mail.

You can always download the latest public version from here: https://iyuvalk@svn.code.sf.net/p/exchangedta/code-0/Public Setups/FilesToInstall.zip

Installation

To start using this transport agent you'll have to carefully follow these steps:
1. Copy the following files to a folder on your MS-Exchange 2010 Server (you can name it whatever you like)
\Public Setups\ExchangeDisclaimerHndTransportAgent.dll
\Public Setups\ExchangeDisclaimerHndTransportAgent.pdb
\Public Setups\MessagesHandlingRules.xml
2. Open a PowerShell management console and type the following command and record the results:
Get-TransportAgent
3. Type the following command into the PowerShell management console:
Install-TransportAgent -Name "ExchangeDisclaimerHandlerTransportAgent" -TransportAgentFactory "ExchangeDisclaimerHndTransportAgent.DisclaimerHandlerTransportAgentFactory" -AssemblyPath "<the full="" path="" to="" ExchangeDisclaimerHndTransportAgent.dll="">"
4. You'll be prompted to close the PowerShell window and to restart the Microsoft Exchange Transport service. Do that and continue to the next step
5. Open a PowerShell management console and type the following command and record the results (the results should include the new transport agent you've just installed and it should be disabled):
Get-TransportAgent
6. Type the following command into the PowerShell management console:
Enable-TransportAgent -Name "ExchangeDisclaimerHandlerTransportAgent"
7. You'll be prompted to restart the Microsoft Exchange Transport service. Do that and continue to the next step
8. Type the following command into the PowerShell management console (the results should include the new transport agent you've just installed and it should be enabled):
Get-TransportAgent
9. To test the newly installed transport agent you should send an email with HTML body (it doesn't matter to whom). The recipient should receive an email with the following headers:
X-DISCLAIMER_ABORTED_REASON: NO_RULES_APPLY
X-DISCLAIMER_PROCESSED_BY_TAGENT: DisclaimerHnd_v1.0.19.11454

Configuration

To configure which content will be added to each email you can use mail headers in the following way:
1. Configure the Transport Rules to add header to the mails based on any criteria you'd like. (You can also set that header in the mail client app such as Blat)
2. Use the XML configuration file (MessagesHandlingRules.xml) to specify how to handle e-mails that are tagged with that header you configured in the previous step. You can set a file that its contents will be inserted BEFORE the message body and another file that its contents will be added AFTER the message body
3. You can verify that the configuration is working properly by sending an email that should be valid according to your criteria and examine it to verify that it contains the expected header(s) and if it does (if not you should double-check the transport rules you've configured) you should see the following headers in that mail (if you don't see them try to re-install this transport agent):
X-DISCLAIMER_ENC: <some encoding="" used="" to="" process="" the="" mail="">
X-DISCLAIMER_PROCESSED_BY_RULE: DisclaimerHnd_<the rule="" ID="" as="" appeared="" in="" the="" MessagesHandlingRules.xml="">
X-DISCLAIMER_PROCESSED_BY_TAGENT: DisclaimerHnd_v1.0.19.11454

Known limitations

At this point this tool can handle only HTML based emails.


Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.