HeaderAgent
This sample implements a RoutingAgent. This code executes when the message has been received from the Transport Front-End, put into the queue and is in the process of being categorized by the Hub Transport service.
This agent was written to intercept messages and insert a custom header. Custom headers have usually a name that starts by "X-", in this sample "X-TOTONI". This code sample could be leveraged to manipulate headers such as:
- Adding new headers to mark specific messages with a customer header, for further processing actions (i.e. via Transport Rules)
- Removing headers, for purposes such as header firewalling
- Editing headers, such as to substitute or sanitize certain header values.
This Transport Agent implements Event Logging for its operation. This has been chosen at it diminishes the chances of crashing the transport service in scenarios such as when a log file (if logging to text) could be locked by another process (i.e. anti-virus) or not accessible (i.e. missing permissions or non-existing path).
Event Logs would be recorded in the Application Event Log on the server; the agent would try to register a Source matching its name (HeaderAgent), if this is not possible it will try to fall back on the DLL name (TransportAgents) and, in case that is not possible as only applications running elevated has the privilege to do so, will fall back to logging entries as "Application" which should be already present and registered.
If you want to make sure the Transport Agent is capable or logging events under its own, separate, source for a quicker identification of the relevant events, please create the source manually on an elevated PowerShell prompt.
This can be done with the following command.
New-EventLog -LogName Application -Source HeaderAgent
Alternatively, if you want all different agents to log theri events on a single source, you can create the TransportAgents one as follows.
New-EventLog -LogName Application -Source TransportAgents
- Copy the DLL to the server (i.e. F:\Transport Agents); Make sure the Exchange accounts have access to the folder
- Install the transport agent
Install-TransportAgent -Name HeaderAgent -TransportAgentFactory "TransportAgents.HeaderAgent" -AssemblyPath "F:\Transport Agents\TransportAgents.dll"
- Enable the chosen Transport Agent
Enable-TransportAgent HeaderAgent
- Exit from Exchange Management Shell
- Restart the MSExchangeTransport service
Restart-Service MSExchangeTransport
- Disable the agent
Disable-TransportAgent HeaderAgent
- Remove the agent
Uninstall-TransportAgent HeaderAgent
- Exit from Exchange Management Shell
- Restart the MSExchangeTransport service
Restart-Service MSExchangeTransport