Managing the Email Signature Manager Transport Agent registration

Modified on: Sat, 13 Mar, 2021 at 4:53 PM

APPLIES TO

Email Signature Manager version 8.x

Email Signature Manager version 7.x

SUMMARY

This article describes how to manually manage the registration of the Email Signature Manager Transport Agent with Exchange Server.

INFORMATION

All transport agents have to be registered with Exchange Server in order to be invoked when email is processed. When the Email Signature Manager Transport Agent is installed, it is automatically registered with Exchange Server during the installation process (and unregistered when uninstalled).

If you need or wish to manually investigate or manage the registration of the Email Signature Manager Transport Agent you can do so in the Exchange Management Shell.

VERIFY THE TRANSPORT AGENT REGISTRATION

To determine if the Email Signature Manager Transport Agent is registered with Exchange Server, start an instance of Exchange Management Shell and execute the following command:

Get-TransportAgent "Symprex Email Signature Manager Agent"

If the Transport Agent is registered, its details will be listed and should appear to be similar to the following:

Identity Enabled Priority

-------- ------- --------

Symprex Email Signature Manager Agent True 4

To view the full details of the registration, execute the following command:

Get-TransportAgent "Symprex Email Signature Manager Agent" | fl

To view all of the registered transport agents, execute the following command:

Get-TransportAgent

REQUIREMENT TO RESTART THE EXCHANGE TRANSPORT SERVICE

Note that after executing any of the commands below, the Microsoft Exchange Transport Service must be restarted.

To restart the Microsoft Exchange Transport Service, execute the following command:

Restart-Service MSExchangeTransport

REGISTER THE TRANSPORT AGENT

To manually register the Email Signature Manager Transport Agent with Exchange Server, start an instance of Exchange Management Shell and execute the following command:

Exchange Server 2007 and 2010

Install-TransportAgent -Name "Symprex Email Signature Manager Agent" -AssemblyPath "C:\Program Files\Symprex\Email Signature Manager Transport Agent\signta.dll" -TransportAgentFactory "Symprex.EmailSignatureManager.TransportAgent.ESMRoutingAgentFactory"

Exchange Server 2013 and 2016

Note that the above commands assume that the Transport Agent has been installed to the default location "C:\Program Files\Symprex\Email Signature Manager Transport Agent". If this is not the case, adjust the -AssemblyPath parameter as required.

The output should be similar to the following:

Identity Enabled Priority

-------- ------- --------

Symprex Email Signature Manager Agent False 4

If an error occurs, verify that the Transport Agent is installed. If you are running Exchange Server 2013 SP1 (equivalent to CU4), upgrade to CU5 or higher.

ENABLE THE TRANSPORT AGENT

Once registered, the Transport Agent must be enabled by executing the following command:

Exchange Server 2007 and 2010

Enable-TransportAgent "Symprex Email Signature Manager Agent"

Exchange Server 2013 and 2016

Enable-TransportAgent "Symprex Email Signature Manager Agent" -TransportService Hub

There is no output from this cmdlet.

You can verify that the Transport Agent is now registered and enabled by executing the Get-TransportAgent cmdlet as detailed in the previous section.

DISABLE THE TRANSPORT AGENT

The Transport Agent can be disabled by executing the following command:

Exchange Server 2007 and 2010

Disable-TransportAgent "Symprex Email Signature Manager Agent"

Exchange Server 2013 and 2016

Disable-TransportAgent "Symprex Email Signature Manager Agent" -TransportService Hub

There is no output from this cmdlet.

You can verify that the Transport Agent has been disabled by executing the Get-TransportAgent cmdlet as detailed in the previous section.

UNREGISTER THE TRANSPORT AGENT

The Transport Agent can be unregistered by executing the following command:

Exchange Server 2007 and 2010

Uninstall-TransportAgent "Symprex Email Signature Manager Agent"

Exchange Server 2013 and 2016

Uninstall-TransportAgent "Symprex Email Signature Manager Agent" -TransportService Hub

You can verify that the Transport Agent has been unregistered by executing the Get-TransportAgent cmdlet as detailed in the previous section.

If you want to manually remove the Email Signature Manager Transport Agent, it is important to unregister it first, or the Microsoft Exchange Transport Service may fail to start.