Articles in this section

See more

Managing Exclaimer Cloud Signatures for Exchange settings using PowerShell

Avatar
Exclaimer Support
  • Updated
Follow

Relevant Products: Exclaimer Cloud - Signatures for Exchange

Scenario

There can be a number of reasons why you would want to manage your Exclaimer Cloud Signatures for Exchange settings.

For example, since the initial installation of Exclaimer Cloud - Signatures for Exchange you notice that your requirements have changed. You now want to:

  • Change which users' emails are routed to Exclaimer Cloud, or 

  • Generate a new API key from the Exclaimer Cloud portal, or

  • View the current settings for troubleshooting or documentation purposes, or

  • Update the settings on multiple Exchange servers at a time and so on.

Resolution

To view or update the Exclaimer Cloud Signatures for Exchange settings using PowerShell:

  1. Open Windows PowerShell.

To view Exclaimer Cloud Signatures for Exchange (current) settings:

  • Get the current list of accepted groups:

    Get-ExclaimerServiceAcceptedGroups

  • Get the current API key:

    Get-ExclaimerServiceApiKey

  • Get the service URI:

    Get-ExclaimerServiceUri

  • Get the current list of accepted senders:

    Get-ExclaimerServiceAcceptedSenders

To update Exclaimer Cloud Signatures for Exchange settings:

Caution: Using these commands will replace your current settings, please ensure you include the original users or groups in addition to any new users or groups.

You will need to restart the Exchange Transport Service for any changes to take effect.

  • Update the list of accepted senders:

    Set-ExclaimerServiceAcceptedSenders -AcceptedSenders "<first user's email address>","<second user's email address>"

  • Clear the list of accepted senders:

    Set-ExclaimerServiceAcceptedSenders -ClearList

  • Set the list of accepted groups:

    Set-ExclaimerServiceAcceptedGroups -AcceptedGroups "<first group's display name>","<second group's display name>"

  • Clear the list of accepted groups:

    Set-ExclaimerServiceAcceptedGroups -ClearList

  • Set the API key:

    Set-ExclaimerServiceApiKey -ApiKey "<your api key from the cloud portal>"

  • Set the service URI:

    Set-ExclaimerServiceUri -Uri "<your service uri from the cloud portal>"

Additional information:

  • The commands can also be run remotely to view or update the settings using the following command:

    Invoke-Command -ComputerName <server name> {<command>}

    For example:
    Invoke-Command -ComputerName Server01 {Get-ExclaimerServiceUri}

    Invoke-Command -ComputerName Server01,Server02,Server03 {Get-ExclaimerServiceUri}

  • To view cmdlet help:

    Get-Help <command>

    For example:
    Get-Help Set-ExclaimerServiceAcceptedGroups

Related articles