Return to Home Return to Portal

Install Exclaimer Exchange Transport Agent (on Windows Server Core)

Payal Arya
  • Updated
    • NOTE: This option is not available in the new UI for this release.

    This page describes the steps to install the Exclaimer Exchange Transport Agent (on Windows Server Core) as available in the old UI. 

    To use the Exchange On-Premises feature, you need to install the Exclaimer Exchange Transport Agent. If you want to install it on Windows Server Desktop Experience - see Installing Exclaimer Exchange Transport Agent (on Windows Server Desktop Experience).

    This page consists of the following sections:

    Pre-requisites you need to know before you start installing the Exclaimer Exchange Transport Agent.

    Steps to retrieve the Exclaimer Exchange Transport Agent.

    Steps to install the Exclaimer Exchange Transport Agent.

    Additional Install options.

    Pre-requisites

    Before you install the Exclaimer Exchange Transport Agent, please ensure you have: 

    • Windows Server 2019 Server Core 
    • Exchange 2019 
    • A configured Exclaimer Cloud: Signatures for Microsoft 365 Subscription
    • Azure AD Connect configured and synchronizing
    • A Domain Administrator account
    • PowerShell 4 and .Net Framework 4.7.2 installed

    NOTE: Exclaimer Support is only provided for the versions listed here.

    Retrieving Exclaimer Exchange Transport Agent

    To retrieve the Exclaimer Transport Agent:

    1. Click the Download link highlighted below (Exclaimer Exchange Transport Agent) to download the latest version of the Exclaimer Exchange Transport Agent onto your computer, then copy the downloaded files to each of your mailbox servers.



    2. Click New Key to create a new API Key.



      The Add API Key window is displayed.

    3. Enter a descriptive name for the new API Key.



    4. Click OK to create the key, else click Cancel to close the window without creating the new key.

      The new API Key is displayed in the API Keys list.



      This concludes the steps you need to do on the portal. 
    TIP!
    At this stage, you copy the API key to a Notepad as the API Key is displayed in full. Once you exit from this window, the API key is encrypted, and you cannot copy it. And once it is encrypted, the only solution to proceed with the installation is to create a new API key. You will need the API key when you enter the parameter details for installation.

    You can also copy the Service Uri to a Notepad, making it easy to copy the path when you enter the parameter details for the installation.

    Installing the Exclaimer Transport Agent

    To install the Exclaimer Exchange Transport Agent on Windows Server Core:

    1. Once the files have been successfully downloaded, open the Exchange Management Shell.

    2. Enter the command to the folder path where the file has been downloaded.
      cd 'C:\Users\<username>\Downloads'
      NOTE: In most cases, Windows stores the Downloads folder under your user profile. To navigate to the Downloads folder quickly, type in the following PowerShell command:

      cd $env:userprofile\downloads




    3. Enter the following command to run the installer:
      msiexec /i "\<full path to MSI>"
      For example: msiexec /i “C:\Temp\ExclaimerCloudForExchange.msi”

    4. Follow the steps onscreen to complete the installation.

    Additional Install options

    As it is a Microsoft Installer (MSI), there are a number of values you can pass to the MSI when installing it via msiexec to allow for an installation that requires little graphical interaction.

    The different parameters you can pass in the MSI are listed below with examples:

    Name

    Required

    Description
    IMPRINTFRONTEND_URL Yes The URL is given in the Portal - this is the address of the imprint server your emails will pass through in order to receive a signature.
    Example: 

    msiexec /i “C:\Temp\ExclaimerCloudForExchange.msi” IMPRINTFRONTEND_URL="https://us.imprint.exclaimer.net" API_KEY="*****************************************************" /q

     


    For more information, see Service Uri in Exclaimer Cloud Signatures for Exchange.
    API_KEY Yes The API Key you created within the Portal -this needs to be validated in order to route an email to the Exclaimer service.

    For more information, see Service Uri in Exclaimer Cloud Signatures for Exchange.
    INSTALLFOLDER No The location where the routing agent will be installed.

    We recommend it to be on the root drive of the server, that is C:\Program Files\
    ACCEPTED_SENDERS No This is a comma-separated array of SMTP email addresses. It is used to limit the routing agent to a specific list of sender addresses that will be processed.
    ACCEPTED_GROUPS No

    This is a comma-separated array of distribution groups. It is used to limit the routing agent to a specific list of distribution groups whose members will be processed.

     

    Next Steps: Once you have completed your configuration, you can start creating your first signature.