Skip to content

Latest commit

 

History

History
896 lines (742 loc) · 84.2 KB

CHANGELOG.md

File metadata and controls

896 lines (742 loc) · 84.2 KB
Raw

Set-OutlookSignatures
Email signatures and out-of-office replies for Exchange and all of Outlook: Classic and New, local and roaming, Windows, Web, Mac, Linux, Android, iOS

License latest release open issues add features with Benefactor Circle get commercial support from ExplicIT Consulting

Changelog

v4.14.1 - 2024-08-29

Attention, Exchange Online admins
See What about the roaming signatures feature in Exchange Online? in .\docs\README for details on how this feature works.
Set-OutlookSignatures supports cloud roaming signatures - see MirrorCloudSignatures in .\docs\README.

Add features with the Benefactor Circle add-on and get commercial support from ExplicIT Consulting
See .\docs\Benefactor Circle or https://explicitonsulting.at for details about these features and how you can benefit from them with a Benefactor Circle license.

Tagline
Starting with this release, a tagline is added to each signature deployed for mailboxes without a Benefactor Circle license. See FAQ How to disable the tagline in signatures? in .\docs\README for details.

Fixed

  • Provide a workaround to avoid problems loading DLL dependencies on some systems with certain .Net patch levels.

v4.14.0 - 2024-08-28

Attention, Exchange Online admins
See What about the roaming signatures feature in Exchange Online? in .\docs\README for details on how this feature works.
Set-OutlookSignatures supports cloud roaming signatures - see MirrorCloudSignatures in .\docs\README.

Add features with the Benefactor Circle add-on and get commercial support from ExplicIT Consulting
See .\docs\Benefactor Circle or https://explicitonsulting.at for details about these features and how you can benefit from them with a Benefactor Circle license.

Tagline
Starting with this release, a tagline is added to each signature deployed for mailboxes without a Benefactor Circle license. See FAQ How to disable the tagline in signatures? in .\docs\README for details.

Changed

Added

  • Add an Outlook add-in that can:

    • Automatically add signatures to new emails and reply emails (including Outlook on iOS and Outlook on Android)
    • Automatically add signatures to new appointment invites

    See The Outlook add-in in .\docs\README for details about features, usage, configuration, deployment and remarks.
    The Outlook add-in is available as part of the Benefactor Circle license.

  • Detect if a template or configuration file path is hosted on SharePoint Online and use Microsoft Graph to access it. This enables SharePoint Online access on Linux and macOS.
    To use this, you need to update your Entra ID app with the delegated (not application) permission Files.Read.All (Files.SelectedOperations.Selected also works but requires additional configuration). You also need to set the new parameter GraphClientID, which is described below.
    Access to SharePoint on-prem is still limited to Windows and WebDAV with an authentication cookie created in Internet Explorer.

  • Add new parameter GraphClientID. Must be set when GraphConfigFile is hosted on SharePoint Online. See .\docs\README for details.

  • Show local and UTC time for SimulateTime parameter when in simulation mode.

  • Add a tagline to each signature deployed for mailboxes without a Benefactor Circle license. See FAQ How to disable the tagline in signatures? in .\docs\README for details.

  • Remove trailing null character from file names being enumerated in SharePoint folders. .Net and the WebDAV client sometimes add a null character, which is not allowed in file and path names.

  • Detect corrupted Outlook on Windows installations by comparing the major part of the Outlook version information from the registry and from outlook.exe.

  • Add Which group naming format should I choose? recommendation to .\docs\README and INI files.

  • Add FAQ Why is the out-of-office assistant not activated automatically? to .\docs\README.

Fixed

  • Do not allow parameter SignatureCollectionInDrafts in simulation mode unless SimulateAndDeploy is enabled.
  • Fix a potential problem with paged Microsoft Graph queries which could lead to an infinite loop.
  • Fix search for Entra ID groups by their display name. (Thanks @CoreyS222!)
  • Fix on-prem group membership search not including non-security enabled distribution groups due to a regression.

v4.13.0 - 2024-06-27

Attention, Exchange Online admins
See What about the roaming signatures feature in Exchange Online? in .\docs\README for details on how this feature works. Set-OutlookSignatures supports cloud roaming signatures - see MirrorCloudSignatures in .\docs\README for details.

Add features with the Benefactor Circle add-on and get commercial support from ExplicIT Consulting
See .\docs\Benefactor Circle or https://explicitonsulting.at for details about these features and how you can benefit from them with a Benefactor Circle license.

Changed

  • Update dependency MSAL.Net to v4.61.3.
  • Update code in MSAL.PS used to detect active window handle, required for interactive login to Graph.
  • Do not add DOCX templates to the list of recent files in Word, and do not route the document to the next recipient if the document has a routing slip.

Added

  • Add a hint in INI files stating to not modify them directly but a copy of them, and to follow the README FAQ What is the recommended folder structure for script, license, template and config files?.
  • Add a fallback mechanism for detecting the User Principal Name of the currently logged-in user on Windows. This solves the rare case with unknown root cause where this information is not available in the registry. (#116) (Thanks @CarlInLV!)
  • Add new parameter SignatureCollectionInDrafts. Enabled per default, this creates and updates an email message with the subject 'My signatures, powered by Set-OutlookSignatures Benefactor Circle' in the drafts folder of the current user, containing all available signatures in HTML and plain text for easy access in mail clients that do not have a signatures API. See .\docs\README for details.

Removed

  • Remove dependency to System.Web.dll for URL encode and decode operations.

Fixed

  • Truncate text signature for SignatureTextOnMobile when setting Outlook Web signature if it is longer than 512 characters, and show a warning message. SignatureTextOnMobile is only used when browsing Outlook Web on a mobile device. (Thanks @bmartins-EMCDDA!)

v4.12.2 - 2024-05-27

Attention, Exchange Online admins
See What about the roaming signatures feature in Exchange Online? in .\docs\README for details on how this feature works. Set-OutlookSignatures supports cloud roaming signatures - see MirrorCloudSignatures in .\docs\README for details.

Add features with the Benefactor Circle add-on and get commercial support from ExplicIT Consulting
See .\docs\Benefactor Circle or https://explicitonsulting.at for details about these features and how you can benefit from them with a Benefactor Circle license.

Fixed

  • Convert account pictures from Active Directory for use in signatures without byte array conversion error.

v4.12.1 - 2024-05-24

Attention, Exchange Online admins
See What about the roaming signatures feature in Exchange Online? in .\docs\README for details on how this feature works. Set-OutlookSignatures supports cloud roaming signatures - see MirrorCloudSignatures in .\docs\README for details.

Add features with the Benefactor Circle add-on and get commercial support from ExplicIT Consulting
See .\docs\Benefactor Circle or https://explicitonsulting.at for details about these features and how you can benefit from them with a Benefactor Circle license.

Changed

  • Update dependency MSAL.Net to v4.61.1.
  • Use pure .Net methods to create Windows shortcut files in sample code and in Set-OutlookSignatures, as Microsoft marked VBS (Visual Basic Script) as deprecated and will remove it in future versions of Windows.

Fixed

  • Name temporary file names correctly when the MailboxSpecificSignatureNames parameter is enabled, so that out-of-office replies can be set in this mode.
  • Show the 'MSAL.PS Graph token cache info' when run in Windows PowerShell (PowerShell 5.x).
  • Fix simulation mode wrongly deleting all '___Mailbox *' folders in the output directory, but the last one.
  • Benefactor Circle only: Search for license groups in Entra ID via on-prem SIDs may fail because of a regression in checking the SID format.

v4.12.0 - 2024-05-07

Add features with the Benefactor Circle add-on and get commercial support from ExplicIT Consulting
See .\docs\Benefactor Circle or https://explicitonsulting.at for details about these features and how you can benefit from them with a Benefactor Circle license.

Attention, Exchange Online admins
See What about the roaming signatures feature in Exchange Online? in .\docs\README for details on how this feature works. Set-OutlookSignatures supports cloud roaming signatures - see MirrorCloudSignatures in .\docs\README for details.

Changed

  • Graph connectivity: Update dependency MSAL.Net to v4.60.3.
  • The Quick Start Guide is now easier to follow and clearer on requirements.
  • Updated sample templates (full barrier-free design, and other smaller changes).
  • Updated Authentication chapter in .\docs\README.
  • The API for saving photos and user-defined images has been changed, which significantly speeds up the creation of temporary files.

Added

  • Support for Linux and macOS. Some restrictions apply to Non-Windows platforms, see Linux and macOS in the Requirements chapter of .\docs\README for details.
  • Custom image replacement variables that you can fill yourself with a byte array: $CurrentUserCustomImage[1..10]$, $CurrentUserManagerCustomImage[1..10]$, $CurrentMailboxCustomImage[1..10]$, $CurrentMailboxManagerCustomImage[1..10]$. Usecases: Account pictures from a share, QR code vCard/URL/text/Twitter/X/Facebook/App stores/geo location/e-mail, etc.
    • QR code vCard (MeCard) in custom image replacement variable $Current[..]CustomImage1$. See file .\config\default replacement variables.ps1 for the easily customizable code used to create it. Also see .\docs\README for details.
  • Support for maximum barrier-free accessibility with screen readers and comparable tools. Use Word ScreenTips and HTML titles for hyperlinks, and alt text for images, replacement variables are supported. All sample templates have been updated accordingly. Just hover your mouse pointer over a hyperlink or image to see additional information.
  • Show a warning when authentication to Outlook Web (no matter if on-prem or in the cloud) is not possible via Autodiscover, as this means that Autodiscover is not configured correctly.
  • The MirrorLocalSignaturesToCloud parameter is now also available under the name MirrorCloudSignatures. The old name may be removed with the next major release (v5.0.0).

Fixed

  • When using HTM templates, image paths were not correctly modified when containing one of the reserved characters defined in RFC3986 (:/?#[]@!$&'()*+,;=, Uri.EscapeUriString vs. Uri.EscapeDataString).

v4.11.0 - 2024-03-26

Add features with the Benefactor Circle add-on and get commercial support from ExplicIT Consulting
See .\docs\Benefactor Circle or https://explicitonsulting.at for details about these features and how you can benefit from them with a Benefactor Circle license.

Attention, Exchange Online admins
See What about the roaming signatures feature in Exchange Online? in .\docs\README for details on how this feature works. Set-OutlookSignatures supports cloud roaming signatures - see MirrorLocalSignaturesToCloud in .\docs\README for details.

Changed

  • Updated sample templates
  • Authentication against SharePoint document libraries containing templates or INI files has been adapted to Microsoft API changes not yet documented

Added

  • New parameter MailboxSpecificSignatureNames. By setting the MailboxSpecificSignatureNames parameter to true, the e-mail address of the current mailbox is added to the name of the signature - instead of a single Signature A file, Set-OutlookSignatures can create a separate signature file for each mailbox: Signature A (user.a@example.com), Signature A (mailbox.b@example.net), etc. See.\docs\README for details.
  • When MirrorLocalSignaturesToCloud is enabled,
    • download signatures not only from the current user's mailbox, but from all mailboxes where possible (full access with current user's credentials, due to Microsoft restrictions)
    • upload personal signatures to Exchange Online mailbox of logged-on user right after they have been created and before they are even copied to a local signature path, avoiding a race condition with the internal download schedule of Outlook
  • Always use the most recent TLS version available and supported for communication with Microsoft services

Fixed

  • DeleteUserCreatedSignatures, DeleteScriptCreatedSignaturesWithoutTemplate and AdditionalSignaturePath now handle folder and file names with special characters ($'‘’‚‛) correctly
  • Check for PowerShell Full Language mode before checking for new versions to avoid an error message without a hint to the root cause
  • When an Outlook profile is available, set default signatures no matter if current mailbox is a dummy mailbox or not
  • Correctly handle INI files not containing SortOrder or SortCulture information

v4.10.1 - 2024-02-06

Add features with the Benefactor Circle add-on and get commercial support from ExplicIT Consulting
See .\docs\Benefactor Circle or https://explicitonsulting.at for details about these features and how you can benefit from them with a Benefactor Circle license.

Attention, Exchange Online admins
See What about the roaming signatures feature in Exchange Online? in .\docs\README for details on how this feature works. Set-OutlookSignatures supports cloud roaming signatures - see MirrorLocalSignaturesToCloud in .\docs\README for details.

Changed

  • Graph connectivity: Update dependency MSAL.Net to v4.59.0
  • Updated FAQ How can I deploy and run Set-OutlookSignatures using Microsoft Intune? in .\docs\README, and moved sample code from FAQ to .\sample code directory
  • Active Directory attribute names are no longer case sensitive, making it easier creating own replacement variables and adding custom schema extensions
  • Only use Integrated Windows Authentication for connection to Outlook Web when no cloud token is available
  • If the variable replacement in Word fails, an additional note is displayed about the possible mandatory use of Microsoft Purview Information Protection.
  • Updated sample templates

Added

  • New FAQs Keep users from adding, editing and removing signatures and What is the recommended folder structure for script, license, template and config files? in .\docs\README.

Fixed

  • Workaround for a Microsoft Graph API problem, which returns a HTTP 403 error when querying the settings of some mailboxes. This query now only happens when absolutely necessary. When this query fails, SetCurrentUserOutlookWebSignature and SetCurrentUserOOFMessage are disabled. Only Microsoft can fix the root cause of this problem.
  • More workarounds for timing problems with file operations in folders used by OneDrive
  • Verbose output no longer logs Graph tokens, only their properties (header and payload data only, no digital signature)
  • When an existing signature is overwritten by a new signature and the two signature names only differ in upper and lower case ("signature a" and "Signature A", for example), always use the casing of the new signature
  • Correctly detect automapped mailboxes in Outlook Web when New Outlook is not used
  • Add scope 'Application.ReadWrite.All' to sample script .\sample code\Create-EntraApp.ps1

v4.10.0 - 2024-01-05

Add features with the Benefactor Circle add-on and get commercial support from ExplicIT Consulting
See .\docs\Benefactor Circle or https://explicitonsulting.at for details about these features and how you can benefit from them with a Benefactor Circle license.

Attention, Exchange Online admins
See What about the roaming signatures feature in Exchange Online? in .\docs\README for details on how this feature works. Set-OutlookSignatures supports cloud roaming signatures - see MirrorLocalSignaturesToCloud in .\docs\README for details.

Changed

  • Graph connectivity: Update dependency MSAL.Net to v4.58.1

Added

  • Added to the description of each parameter in the script itself and the .\docs\README file:
    • Allowed values
    • Usage examples (PowerShell and Non-PowerShell)
    • Information when a feature requires a Benefactor Circle license
  • Additional descriptions in template INI files
  • A specific warning when the template INI file contains references to templates with a wrong file extension (for example, .html instead of .htm)
  • New FAQs, see .\docs\README for details:
    • How can I deploy and run Set-OutlookSignatures using Microsoft Intune?
    • Why does Set-OutlookSignatures run slower sometimes?

Fixed

  • Correctly handle empty Outlook profiles and a no longer existing default profile
  • Graph authentication: Workaround for MSAL.Net "connection reset error" in browser. See $GraphHtmlMessageSuccess and $GraphHtmlMessageError in .\config\default graph config.ps1 for details.
  • Graph authentication: Workaround for MSAL.Net returning the access token in a different format in interactive and silent authentication

v4.9.0 - 2023-12-02

Add features with the Benefactor Circle add-on and get commercial support from ExplicIT Consulting
See .\docs\Benefactor Circle or https://explicitonsulting.at for details about these features and how you can benefit from them with a Benefactor Circle license.

Attention, Exchange Online admins
See What about the roaming signatures feature in Exchange Online? in .\docs\README for details on how this feature works. Set-OutlookSignatures supports cloud roaming signatures - see MirrorLocalSignaturesToCloud in .\docs\README for details.

Changed

  • Word is no longer required to convert signatures to TXT format, which reduces resource consumption and execution time
  • MoveCssInline: Update dependency PreMailer.Net to v2.5.0
  • Graph connectivity: Update dependency MSAL.Net to v4.58.0

Added

  • Check for valid Windows/Outlook/Outlook Web signature names when using the MirrorLocalSignaturesToCloud parameter or the OutlookSignatureName INI parameter
  • MirrorLocalSignaturesToCloud: Only download a roaming signature from Exchange Online when its local version is older or does not exist
  • Sample code SimulateAndDeploy.ps1
    • Display info when a specific job ends, in addition to when there is an error
    • Display info at least once a minute, and make this update interval configurable
    • Separate logs for sample code output, successful jobs, jobs with errors and details of each job
  • New parameter ScriptProcessPriority: Define the script process priority. With lower values, Set-OutlookSignatures runs longer but minimizes possible performance impact. See README for details.

Fixed

  • DeleteScriptCreatedSignaturesWithoutTemplate and DeleteUserCreatedSignatures did not remove all subfolders belonging to a signature
  • When using HTM templates with images in a connected folder, the folder name was not corrected reliably, which resulted in missing images (as they pointed to a wrong path)

v4.8.1 - 2023-11-24

Add features with the Benefactor Circle add-on and get commercial support from ExplicIT Consulting
See .\docs\Benefactor Circle or https://explicitonsulting.at for details about these features and how you can benefit from them with a Benefactor Circle license.

Attention, Exchange Online admins
See What about the roaming signatures feature in Exchange Online? in .\docs\README for details on how this feature works. Set-OutlookSignatures supports cloud roaming signatures - see MirrorLocalSignaturesToCloud in .\docs\README for details.

Fixed

  • Embedding images and loading the Graph config file is now much faster because of switching from PowerShell cmdlets to .Net system calls for conversions to Base64 (#95)
  • The manager of the current user was not correctly detected in certain hybrid scenarios (Thanks Thomas Müllerchen and Tommy Malodisdach!)
  • The message informing the user before a new browser tab is opened for authentication now does not steal the focus in all combinations of PowerShell Core/Desktop and Windows Terminal/Classic Console Host

v4.8.0 - 2023-11-20

Add features with the Benefactor Circle add-on and get commercial support from ExplicIT Consulting
See .\docs\Benefactor Circle or https://explicitonsulting.at for details about these features and how you can benefit from them with a Benefactor Circle license.

Attention, Exchange Online admins
See What about the roaming signatures feature in Exchange Online? in .\docs\README for details on how this feature works. Set-OutlookSignatures supports cloud roaming signatures - see MirrorLocalSignaturesToCloud in .\docs\README for details.

Changed

  • Updated dependency MSAL.Net to v4.57.0
  • Allow more alternate names for cloud environments. See .\docs\README for details about the CloudEnvironment parameter.

Added

  • Graph token cache now not only works in Windows PowerShell 5.1, but also in PowerShell 7.
  • A message box now informs the user before a new browser tab is opened for authentication, as Microsoft still does not show the Entra ID app name in the authentication prompt. The message text can be customized or disabled with the $GraphHtmlMessageboxText parameter in .\config\default graph config.ps1. See that file for details.
  • The HTML message after a successful browser authentication can be customized with the $GraphHtmlMessageSuccess parameter in .\config\default graph config.ps1. See that file for details, and also consider $GraphBrowserRedirectSuccess for a redirection alternative.
  • The HTML message after an unsuccessful browser authentication can be customized with the $GraphHtmlMessageError parameter in .\config\default graph config.ps1. See that file for details, and also consider $GraphBrowserRedirectError for a redirection alternative.
  • New sample code .\sample code\Create-EntraApp.ps1 automates the creation of the Entra app required to access Microsoft Graph.
  • New FAQ How do I alternate banners and other images in signatures?. See .\docs\README for details.

Fixed

  • MirrorLocalSignaturesToCloud now correctly detects cloud mailboxes in hybrid environments when a connection to the on-prem Active Directory is used
  • Setting Word process priority no longer leads to an error in PowerShell 7
  • Fix a regression introduced with the option to set the Word process priority. This fix avoids a rare problem where a manually started Word instance connects to the Word background process created by the software.

v4.7.0 - 2023-10-29

Add features with the Benefactor Circle add-on and get commercial support from ExplicIT Consulting
See .\docs\Benefactor Circle or https://explicitonsulting.at for details about these features and how you can benefit from them with a Benefactor Circle license.

Attention, Exchange Online admins
See What about the roaming signatures feature in Exchange Online? in .\docs\README for details on how this feature works. Set-OutlookSignatures supports cloud roaming signatures - see MirrorLocalSignaturesToCloud in .\docs\README for details.

Changed

  • Reduced minimum required Graph permissions: GroupMember.Read.All is now used instead of Group.Read.All, which reduces delegated app permissions.
    To compare the two permissions, see their description at Microsoft Graph permission reference.
    • If you use an Entra ID app defined in your own tenant
      • If you want to use GroupMember.Read.All instead of Group.Read.All, you have to use at least v4.6.0 of Set-OutlookSignatures.
        Remove admin consent for the Group.Read.All permission and remove it from the app, then add the delegated GroupMember.Read.All permission and grant admin consent for it.
      • If you do not want to use GroupMember.Read.All instead of Group.Read.All, there is nothing to do: v4.6.0 and up just request all permissions defined in the Entra ID app, versions before v4.6.0 explicitly request Group.Read.All.
    • If you use the Entra ID app provided by the developers (app ID 'beea8249-8c98-4c76-92f6-ce3c468a61e6')
      • If you want to use GroupMember.Read.All instead of Group.Read.All, you have to use at least v4.6.0 of Set-OutlookSignatures, and renew your admin consent for the new reduced permissions:
        1. Open a browser, preferably in a private window
        2. Open the URL 'https://login.microsoftonline.com/organizations/adminconsent?client_id=beea8249-8c98-4c76-92f6-ce3c468a61e6'
        3. Log on with a user that has Global Admin or Client Application Administrator rights in your tenant
        4. Accept the required permissions on behalf of your tenant. You can safely ignore the error message that the URL 'http://localhost/?admin_consent=True&tenant=[…]' could not be found or accessed.
      • If you want to use a version older than v4.6.0, you need to create your own app in your own Entra ID tenant as detailed in .\config\default graph config.ps1.
      • For security and maintenance reasons, it is recommended to create you own app in your own tenant.

Added

  • Support for all cloud environments via new parameter CloudEnvironment: Public (AzurePublic), US Government L4 (AzureUSGovernment), US Government L5 (AzureUSGovernment DoD), China (AzureChinaCloud operated by 21Vianet). See .\docs\README for details.
  • The software now shows a hint at startup when a newer release is available on GitHub.

Fixed

  • Implementation approach: Translated a sentence to English, which was only available in German (#89) (Thanks @JeroenOortwijn!)
  • Update dependency MSAL.PS so that process ID is correctly determined when run in Windows Terminal (#88) (Thanks @Ben-munich!)

v4.6.1 - 2023-10-27

Add features with the Benefactor Circle add-on and get commercial support from ExplicIT Consulting
See .\docs\Benefactor Circle or https://explicitonsulting.at for details about these features and how you can benefit from them with a Benefactor Circle license.

Attention, Exchange Online admins
See What about the roaming signatures feature in Exchange Online? in .\docs\README for details on how this feature works. Set-OutlookSignatures supports cloud roaming signatures - see MirrorLocalSignaturesToCloud in .\docs\README for details.

Fixed

  • Correctly detect and restore Word registry key 'DisableWarningOnIncludeFieldsUpdate'
  • Simulation mode: Show images in out-of-office replies, even though Exchange does not support them yet
  • SimulateAndDeploy.ps1: Advanced error handling
  • Implementation approach: Translated a sentence to English, which was only available in German (#89) (Thanks @JeroenOortwijn!)

v4.6.0 - 2023-10-23

Add features with the Benefactor Circle add-on and get commercial support from ExplicIT Consulting
See .\docs\Benefactor Circle or https://explicitonsulting.at for details about these features and how you can benefit from them with a Benefactor Circle license.

Attention, Exchange Online admins
See What about the roaming signatures feature in Exchange Online? in .\docs\README for details on how this feature works. Set-OutlookSignatures supports cloud roaming signatures - see MirrorLocalSignaturesToCloud in .\docs\README for details.

Added

  • 'default graph config.ps1' now includes a description for each permission required by the Entra ID application for Graph access
  • Additional documentation: Implementation approach
    • The content is based on real-life experiences implementing the software in multi-client environments with a five-digit number of mailboxes.
    • Proven procedures and recommendations for product managers, architects, operations managers, account managers, mail and client administrators. Suited for service providers as well as for clients.
    • It covers several general overview topics, administration, support, training across the whole lifecycle from counselling to tests, pilot operation and rollout up to daily business.
    • Available in English and German.
  • New and improved sample code
    • SimulateAndDeploy.ps1: Deploy signatures without end user interaction, running Set-OutlookSignatures on a server - including support for roaming signatures
    • Test-ADTrust.ps1: Detect why a client cannot query Active Directory information
    • SimulationModeHelper.ps1: Makes using simulation mode easier. An admin sets the parameters in the software, the content creators execute it and just have to enter the values required for simulation:
      • The user to simulate (mandatory)
      • The mailbox(es) to simulate (optional)
      • The time to simulate (optional)
      • The output path (optional)
  • A basic configuration user interface with grouped parameter sets, just run Show-Command .\Set-OutlookSignatures.ps1 in PowerShell.
  • New parameter WordProcessPriority: Define the Word process priority. With lower values, Set-OutlookSignatures runs longer but minimizes possible performance impact. See README for details.

Fixed

  • On-prem only: Make sure that Active Directory attributes of the current user, the current mailbox and their managers are available in environments where not every domain controller is also a global catalog server
  • Always connect to Entra ID/Graph when New Outlook is used

v4.5.0 - 2023-09-29

Add features with the Benefactor Circle add-on and get commercial support from ExplicIT Consulting
See .\docs\Benefactor Circle or https://explicitonsulting.at for details about these features and how you can benefit from them with a Benefactor Circle license.

Attention, Exchange Online admins
Microsoft actively enables roaming signatures in Exchange Online. See What about the roaming signatures feature in Exchange Online? in .\docs\README for details, known problems and workarounds.
Set-OutlookSignatures can experimentally handle cloud roaming signatures since v4.0.0. See MirrorLocalSignaturesToCloud in .\docs\README for details.

Changed

  • Adapt program logic to cloud roaming signatures API changes introduced by Microsoft
  • Updated FAQ How can I log the software output?. See README for details.

Added

  • New parameter EmbedImagesInHtmlAdditionalSignaturePath. See README for details.
  • New FAQ How can I start the software only when there is a connection to the Active Directory on-prem?. See README for details.

Fixed

  • Variables in HTM templates have not been replaced with actual values because of a wrong RegEx syntax
  • Content of path defined in AdditionalSignaturePath was not deleted before copy operations.

v4.4.0 - 2023-09-20

Add features with the Benefactor Circle add-on and get commercial support from ExplicIT Consulting
See .\docs\Benefactor Circle or https://explicitonsulting.at for details about these features and how you can benefit from them with a Benefactor Circle license.

Attention, Exchange Online admins
Microsoft actively enables roaming signatures in Exchange Online. See What about the roaming signatures feature in Exchange Online? in .\docs\README for details, known problems and workarounds.
Set-OutlookSignatures can experimentally handle cloud roaming signatures since v4.0.0. See MirrorLocalSignaturesToCloud in .\docs\README for details.

Added

  • Support for New Outlook. Mailboxes are taken from the first matching source:
    1. Simulation mode is enabled: Mailboxes defined in SimulateMailboxes
    2. Outlook is installed and has profiles, and New Outlook is not set as default: Mailboxes from Outlook profiles
    3. New Outlook is installed: Mailboxes from New Outlook (including manually added and automapped mailboxes for the currently logged-in user)
    4. If none of the above matches: Mailboxes from Outlook Web (including manually added mailboxes, automapped mailboxes follow when Microsoft updates Outlook Web to match the New Outlook experience)

Fixed

  • Correctly handly write protected files when copying to AdditionalSignaturePath

v4.3.0 - 2023-09-08

Some features are exclusive to the commercial Benefactor Circle add-on.

  • See .\docs\Benefactor Circle for details about these features and how you can benefit from them with a Benefactor Circle license.

Attention, cloud mailbox users:

  • Microsoft actively enables roaming signatures in Exchange Online. See What about the roaming signatures feature in Exchange Online? in .\docs\README for details, known problems and workarounds.
  • Set-OutlookSignatures can experimentally handle roaming signatures since v4.0.0. See MirrorLocalSignaturesToCloud in .\docs\README for details.

Added

  • When no mailboxes are configured in Outlook, additional mailboxes configured in Outlook Web are used. Thanks to our partner ExplicIT Consulting for donating this code, enabling another world-first feature and bringing us even closer to supporting the "new Outlook" client (codename "Monarch") in the future!
  • Add hint to TLS 1.2 when Entra ID/Graph authentication is not successful (#85) (Thanks @halatovic!)
  • Update 'Quick Start Guide' in 'README' file with clearer instructions on how to register the Entra ID app required for hybrid and cloud-only environments

v4.2.1 - 2023-08-16

Some features are exclusive to the commercial Benefactor Circle add-on. See .\docs\Benefactor Circle for details about these features and how you can benefit from them with a Benefactor Circle license.

Attention, cloud mailbox users:

  • Set-OutlookSignatures can now experimentally handle roaming signatures! See MirrorLocalSignaturesToCloud in .\docs\README for details.
  • Microsoft actively enables roaming signatures in Exchange Online. See What about the roaming signatures feature in Exchange Online? in .\docs\README for details, known problems and workarounds.

Fixed

  • MoveCSSInline may not find a dependent DLL on some systems (#84) (Thanks @panki27!)
  • An error occurred when a trust of the forest root domain of an on-prem Active Directory to itself was detected (#83) (Thanks @panki27!)

v4.2.0 - 2023-08-10

Some features are exclusive to the commercial Benefactor Circle add-on. See .\docs\Benefactor Circle for details about these features and how you can benefit from them with a Benefactor Circle license.

Attention, cloud mailbox users:

  • Set-OutlookSignatures can now experimentally handle roaming signatures! See MirrorLocalSignaturesToCloud in .\docs\README for details.
  • Microsoft actively enables roaming signatures in Exchange Online. See What about the roaming signatures feature in Exchange Online? in .\docs\README for details, known problems and workarounds.

Added

  • New parameter MoveCSSInline to move CSS to inline style attributes, for maximum email client compatibility. This parameter is enabled per default, as a workaround to Microsoft's problem with formatting in Outlook Web (M365 roaming signatures and font sizes, especially).

Fixed

  • Set Word WebOptions in correct order, so that they do not overwrite each other

v4.1.0 - 2023-07-28

Some features are exclusive to the commercial Benefactor Circle add-on. See .\docs\Benefactor Circle for details about these features and how you can benefit from them with a Benefactor Circle license.

Attention, cloud mailbox users:

  • Set-OutlookSignatures can now experimentally handle roaming signatures! See MirrorLocalSignaturesToCloud in .\docs\README for details.
  • Microsoft actively enables roaming signatures in Exchange Online. See What about the roaming signatures feature in Exchange Online? in .\docs\README for details, known problems and workarounds.

Added

  • Templates can now be assigned to or excluded for specific replacement variables of the current user or the current mailbox. Thanks to ExplicIT Consulting for donating this code!
    See Template tags and ini files in README for details and examples.
    Use cases:
    • Assign template to a specific mailbox or user, but only if user or mailbox is member in multiple groups at the same time.
    • Assign template to users or mailboxes which have or have not a value in a replacement variable.
    • Every replacement variable can be used: Current user and current mailbox, their managers, or tailored replacement variables defined in a custom replacement variable config file.
  • Templates can now be assigned to or excluded for specific email addresses or groups SIDs of the mailbox of the current user. Thanks to ExplicIT Consulting for donating this code!
    See Template tags and ini files in README for details and examples.
    Use cases:
    • Assign template to a specific mailbox, but not if the mailbox of the current user has a specific email address or is member of a specific group. It does not matter if this personal mailbox is added in Outlook or not.
      This is useful for delegate and boss-secretary scenarios - secretaries get specific delegate template for boss's mailbox, but the boss not. Combine this with the feature that one template can be used multiple times in the ini file, and you basically only need one template file for all delegate combinations in the company!
    • Assign a template to the mailbox of a specific logged-in user or deny a template for the mailbox of a specific user, no matter which mailboxes the user has added in Outlook.
  • The attribute 'GroupsSIDs' is now also available in the $AdPropsCurrentUser replacement variable. It contains all the SIDs of the groups the mailbox of the current user is a member of, which allows for replacement variable content based on group membership, as well as assigning or denying templates for specific users. See Delete images when attribute is empty, variable content based on group membership in README for details and examples.
  • Replacement variables are no longer case sensitive. This eliminates a common error source and makes replacement variables in template files easier to read.
  • New chapter Proposed template and signature naming convention in README file. Thanks to ExplicIT Consulting for donating this piece of documentation!

Fixed

  • The attribute 'GroupsSIDs' is now reliably available in the $AdPropsCurrentMailbox replacement variable.
  • Correctly log group and email address specific exclusions (only an optical issue, no technical one)

v4.0.0 - 2023-07-12

Some features are exclusive to the commercial Benefactor Circle add-on. See .\docs\Benefactor Circle for details about these features and how you can benefit from them with a Benefactor Circle license.

Attention, cloud mailbox users:

  • Set-OutlookSignatures can now experimentally handle roaming signatures! See MirrorLocalSignaturesToCloud in .\docs\README for details.
  • Microsoft actively enables roaming signatures in Exchange Online. See What about the roaming signatures feature in Exchange Online? in .\docs\README for details, known problems and workarounds.

Changed

  • Breaking: Benefactor Circle members have exclusive access to the following features:
    • Prioritized support and feature requests
      • Issues are handled with priority via a Benefactor Circle exclusive email address and a callback option.
      • Requests for new features are checked for feasability with priority.
      • All release upgrades during the license period are for free, no matter if it is a patch, feature or major release.
    • Script features
      • Time-based campaigns by assigning time range constraints to templates
      • Signatures for automapped and additional mailboxes
      • Set current user Outlook Web signature (classic Outlook Web signature and roaming signature)
      • Download and upload roaming signatures
      • Set current user out-of-office replies
      • Delete signatures created by the software, for which the templates no longer exist or apply
      • Delete user-created signatures
      • Additional signature path (when used outside of simulation mode)
      • High resolution images from DOCX templates
  • Breaking: The CreateRTFSignatures parameter now defaults to false, because the RTF format for emails is hardly used nowadays.
  • Breaking: The EmbedImagesInHtml parameter now defaults to false because certain recent versions of Word (which Outlook uses as HTML renderer) incorrectly hande embedded images. See Images in signatures have a different size than in templates, or a black background in README for details. When EmbedimagesInHtml is enabled, it now automatically enables the "Send pictures with document" Outlook registry key.
  • Breaking: New parameter DisableRoamingSignatures defaults to true. See README for details.
  • Updated FAQ Images in signatures have a different size than in templates. See README for details.

Added

  • Quick Start Guide. See README for details.
  • New parameter MirrorLocalSignaturesToCloud for experimentally handling roaming signatures. Disabled by default. See README for details.
  • Thanks to our partnership with ExplicIT Consulting, Set-OutlookSignatures and its components are digitally signed with an Extended Validation (EV) Code Signing Certificate (which is the highest code signing standard available).
    This is not only available for Benefactor Circle members, but also the Free and Open Source core version is code signed. Code signing makes it much easier to implement Set-OutlookSignatures in environments being locked down with AppLocker or comparable tools.
  • All replacement variables now have the 'DELETEEMPTY' option, which allows for images to be kept only when an attribute has a value. See Delete images when attribute is empty, variable content based on group membership in README for details and examples.
  • The attribute 'GroupsSIDs' is now available in the $CurrentMailbox…] variable for use with replacement variables. It contains all the SIDs of the groups the current mailbox is a member of, which allows for replacement variable content based on group membership. See Delete images when attribute is empty, variable content based on group membership in README for details and examples.
  • A basic configuration user interface with grouped parameter sets, just run Show-Command .\Set-OutlookSignatures.ps1 in PowerShell.
  • The new template tag WriteProtect write protects individual signature files. See README for details and restrictions.
  • The new script parameter SimulateTime allows to use a specific time when running simulation mode, which is handy for testing time-based templates.
  • New parameter DisableRoamingSignatures. See README for details.
  • New FAQ Start Set-OutlookSignatures in hidden/invisible mode. See README for details.
  • Show a warning message when setting the Outlook Web signature is not possible because Outlook Web has not been initialized yet, making it impossible to set signature options in Outlook Web without breaking the first log in experience for this mailbox (getting asked for language, timezone, etc.)
  • Copy HTM image width and height attributes to style attribute
  • Show a warning when a template contains images formatted as non-inline shapes, as these image formatting options may not be supported by Outlook (e.g., behind the text)
  • Support for mailboxes in the user's Entra ID tenant with different UPN/user ID and primary SMTP address
  • The Word registry key DontUseScreenDpiOnOpen is set to 1 automatically, according to Microsoft documentation (see README for details). This helps avoid image sizing problems on devices with non-standard DPI settings.

Fixed

  • Simulation mode
    • Simulation mode partly returned data of the currently logged on user instead of data of the simulated user
    • Simulation mode did not prioritize mailbox list correctly
    • When SimulateUser is not defined, but other simulation parameters, the software exits
    • When multiple mailboxes to simulate were passed, only the first one was considered
  • Graph queries did not correctly handle paged results
  • Restoring the Word setting 'ShowFieldCodes' now works correctly in more error scenarios
  • Benefactor Circle members only: Additional and automapped mailboxes have not been detected reliably
  • Categorizing template files is now much faster than before (two seconds instead of two minutes for 250 templates)
  • Replacing variables in DOCX templates is now faster than before, as only variables actually being used in the document are replaced
  • Realiably remove '$Current[…]Photo$' string from image alt text
  • SimulateAndDeploy.ps1: Correctly convert HTML image tags with embedded images and additional options
  • Display sort order for was not handled correctly when primary smtp address of a mailboxes has been changed after it was already added to Outlook

v3.6.1 - 2023-05-22

Attention cloud mailbox users: Microsoft actively enables roaming signatures in Exchange Online. See What about the roaming signatures feature in Exchange Online? in .\docs\README for details, known problems and workarounds.

Fixed

  • Signatures created with DocxHighResImageConversion true in combination with EmbedImagesInHtml false include high resolution image files, but these images could not be displayed because a wrong path was set in the HTM file

v3.6.0 - 2023-01-24

Attention cloud mailbox users: Microsoft actively enables roaming signatures in Exchange Online. See What about the roaming signatures feature in Exchange Online? in .\docs\README for details, known problems and workarounds.

Changed

  • Microsoft Information Protection sensitivity labels are now supported when using DOCX templates. See How to make Set-OutlookSignatures work with Microsoft Information Protection? in .\docs\README for details.
  • Shrinking RTF files is now compatible with Microsoft Information Protection sensitivity labels
  • Updated chapter in .\docs\README: Photos from Active Directory

Added

  • New FAQ in .\docs\README: How to make Set-OutlookSignatures work with Microsoft Information Protection?
  • New parameter DocxHighResImageConversion. Enabled by default, this parameter creates HTM signatures with high resolution images from DOCX templates. See .\docs\README for details.

Fixed

  • User photo placeholders were not replaced when using HTM templates with images stored in connected sub-folders
  • Sample template files Test all default replacement variables.docx and Test all default replacement variables.htm did not contain all default replacement variables
  • Correctly handle empty AdditionalSignaturePath parameter

v3.5.1 - 2022-12-20

Attention cloud mailbox users: Microsoft actively enables roaming signatures in Exchange Online. See What about the roaming signatures feature in Exchange Online? in README for details, known problems and workarounds.

Fixed

  • Use different code to determine Outlook and Word executable file bitness, as the .Net APIs used before seem to fail randomly with the latest Windows and .Net updates (especially when using 32-bit PowerShell on 64-bit Windows)
  • Do not stop the software when SignaturesForAutomappedAndAdditionalMailboxes is enabled and the Outlook file path can not be determined

v3.5.0 - 2022-12-19

Attention cloud mailbox users: Microsoft actively enables roaming signatures in Exchange Online. See What about the roaming signatures feature in Exchange Online? in README for details, known problems and workarounds.

Changed

  • Mailbox prioritization: Within an Outlook profile, mailbox priority is now determined by the sort order shown in Outlook, no longer by the time a mailbox has been added to the profile. See Signature and OOF application order in README for more details about mailbox prioritization.
  • README: Update FAQ What about the roaming signatures feature in Exchange Online?

Fixed

  • Mailbox priority list: Don't add automapped or additional mailboxes to the end of the mailbox priority list, but to the end of each Outlook profile in the mailbox priority list
  • Mailbox priority list: When duplicates exist, only show the mail address with the highest priority. Verbose output contains additional information for each occurrence (Outlook profile name, registry path, legacyExchangeDN)
  • Setting default signature: Show Outlook profile name, so that mailboxes that exist in multiple Outlook profiles can be distinguished
  • When the logged in user's personal mailbox exists in multiple profiles, set the Outlook Web signature and OOF message for this mailbox only once
  • When a mailbox exists in multiple Outlook profiles, only query AD/Graph at the first occurrence and use cached data on remaining occurrences

v3.4.1 - 2022-11-25

Attention cloud mailbox users: Microsoft will make roaming signatures available in late 2022. See 'What about the roaming signatures feature announced by Microsoft?' in README for details and recommended preparation steps.

Fixed

  • Correctly handle logged in user with empty mail attribute
  • Correctly enumerate SID and SidHistory when connected to a local Active Directory user with a mailbox in Exchange Online (#59) (Thanks @AnotherFranck!)
  • Correctly handle empty templates, signatures and OOF messages

v3.4.0 - 2022-11-02

Attention cloud mailbox users: Microsoft will make roaming signatures available in late 2022. See 'What about the roaming signatures feature announced by Microsoft?' in README for details and recommended preparation steps.

Added

  • New parameter IncludeMailboxForestDomainLocalGroups, see README for details
  • LDAP and Global Catalog connectivity is now additionally checked for every child domain of the current user's Active Directory forest and every child domain of cross-forest trusts
  • Consider SID history of groups in trusted domains/forests
  • New FAQs in .\docs\README: What if Outlook is not installed at all? and What if a user has no Outlook profile or is prohibited from starting Outlook?

Fixed

  • Correctly calculate mailbox priority when simulation mode is enabled and/or the email address is a secondary address
  • On-prem: Membership in domain local groups is now recognized if the group is in a child domain of a forest connected with a cross-forest trust
  • Only consider mailboxes as additional mailboxes when they appear in Outlook's list in the email navigation pane. This avoids falsely adding shared calendars as additional mailboxes.

v3.3.0 - 2022-09-05

Attention cloud mailbox users: Microsoft will make roaming signatures available in late 2022. See 'What about the roaming signatures feature announced by Microsoft?' in README for details and recommended preparation steps.

Changed

  • Use different method to delete files to avoid occassional OneDrive error "access to the cloud file is denied"
  • Update logo and icon

Added

  • the software now detects not only primary mailboxes configured in Outlook, but also automapped and additional mailboxes. This behavior can be disabled with the new parameter SignaturesForAutomappedAndAdditionalMailboxes. See README for details.

v3.2.2 - 2022-08-12

Attention cloud mailbox users: Microsoft will make roaming signatures available in late 2022. See 'What about the roaming signatures feature announced by Microsoft?' in README for details and recommended preparation steps.

Fixed

  • When the EmbedImagesInHtml parameter is set to false, correctly handle a certain file system condition instead of stopping processing the current template after the 'Embed local files in HTM format and add marker' step

v3.2.1 - 2022-08-04

Attention cloud mailbox users: Microsoft will make roaming signatures available in late 2022. See 'What about the roaming signatures feature announced by Microsoft?' in README for details and recommended preparation steps.

Added

  • New FAQ: Why does the text color of my signature change sometimes?

Fixed

  • The permission check no longer takes more time than necessary by showing all allow or deny reasons, only the first match. Denies are only evaluated when an allow match has been found before.
  • Template file categorization time no longer grows exponentially with each template appearing multiple times in an ini file
  • Handle nested attribute names in graph config file correctly ('onPremisesExtensionAttributes.extensionAttribute1' et al.) (#41) (Thanks @dakolta!)
  • Handle ini files with only one section correctly (#42) (Thanks @dakolta!)
  • Include 'state' in list of default replacement variables (#44) (Thanks @dakolta!)
  • The code detecting Outlook and Word registry version, file version and bitness has been corrected

v3.2.0 - 2022-07-19

Attention cloud mailbox users: Microsoft will make roaming signatures available in late 2022. See 'What about the roaming signatures feature announced by Microsoft?' in README for details and recommended preparation steps.

Added

  • Workaround for Word ignoring manual line breaks (`n) and paragraph marks (`r`n) in replacement variables when converting a template to a signature in RTF format (signatures in HTM and TXT formats are not affected).
  • Sample script Test-ADTrust.ps1 to test the connection to all Domain Controllers and Global Catalog server of a trusted domain

v3.1.0 - 2022-06-26

Attention cloud mailbox users: Microsoft will make roaming signatures available in late 2022. See 'What about the roaming signatures feature announced by Microsoft?' in README for details and recommended preparation steps.

Changed

  • Each template reference in an INI file is now considered individually, not just the last entry. See 'How to work with ini files' in README for a usecase example.
  • Additional output is now fully available in the verbose stream, and no longer scattered around the debug and the verbose streams
  • Rewrite FAQ "Why is dynamic group membership not considered on premises?" to reflect recent substantial changes in Microsoft Graph, which make Set-OutlookSignatures automatically support dynamic groups in the cloud. See the FAQ in README for more details and the reason why dynamic groups are not supported on premises.
  • Extend FAQ "How to avoid blank lines when replacement variables return an empty string?" with new examples and sample code that automatically differentiates between DOCX and HTM templates
  • Optimized format of 'hashes.txt'

Fixed

  • Convert SharePoint document library paths to a PowerShell compatible format before accessing them. (#38) (Thanks @Johan-Claesson!)

v3.0.0 - 2022-04-20

This major release brings several changes which can make it incompatible with previous versions. Pay special attention to the changes marked 'Breaking:' to find out if your environment is affected and what to do.

Added

  • New FAQ: How can I get more script output for troubleshooting?

Changed

  • Breaking: All input files of type .htm, .ini and .ps1 are now expected to be UTF8 encoded.
    If you copied and/or modified the sample files delivered with earlier versions of Set-OutlookSignatures, no changes should be necessary as these were delivered in UTF8 already. Please check the encoding anyway.
  • The following data of the currently processed mailbox is no longer displayed in the standard output stream but in the verbose output stream:
    • List of group membership security identifiers (SIDs)
    • List of SMTP addresses
    • Final data of replacement variables
  • Update documentation to make clear that 'NetBiosDomain' and 'Example' are just examples which need to be replaced with actual NetBIOS domain names, but 'EntraID' and 'AzureAD' are not examples

Removed

  • Breaking: File name based tags are no longer supported. Use ini files instead.
    This change has been announced with the release of v2.5.0 on 2022-01-14.
  • Breaking: Parameter AdditionalSignaturePathFolder is no longer supported. Just append the folder to the AdditionalSignaturePath parameter.
  • All sample files with tags based on file names have been removed

v2.5.2 - 2022-02-09

Fixed

  • Use another Windows API to get the Active Directory object of the logged in user. This API also works when 'CN=Computers,DC=[…]' does not exist or the logged in user does not have read access to it. (Thanks Marián Daníšek!)
  • Correct handle objectSid and SidHistory returned from Graph. The format is no longer a byte array as from on-prem Active Directory, but a list of clear text strings ('S-1-[…]').
  • Validate SimulateUser and SimulateMailboxes input

v2.5.1 - 2022-01-20

Fixed

  • Fix search for mailbox user object across trusts

v2.5.0 - 2022-01-14

Added

  • New parameter DeleteScriptCreatedSignaturesWithoutTemplate, see README for details
  • New parameter EmbedImagesInHtml, see README for details
  • Tags can now not only be used to allow access to a template, but also to deny access. Denies are available for time, group and email based tags. See README for details.
  • Consider distribution group membership in addition to security group membership
  • Consider sIDHistory in searches across trusts and when comparing msExchMasterAccountSid, which adds support for scenarios in which a mailbox or a linked account has been migrated between Active Directory domains/forests
  • Show matching allow and deny tags for each mailbox-template-combination. This makes it easy to find out why a certain template is applied for a certain mailbox and why not.
  • Show which tags lead to a classification as time based, common, group based or email address specific template
  • New FAQ: Why is membership in dynamic distribution groups and dynamic security groups not considered?
  • New FAQ: Why is no admin or user GUI available?

Fixed

  • Don't throw an error when UseHtmTemplates is set to true and OOFIniFile is used, but there is no *.htm file in OOFTemplatePath
  • Correct mapping of Graph businessPhones attribute, so the replacement variable $Current[…]Telephone$ is populated (#26) (Thanks @vitorpereira!)
  • Fix Outlook 2013 registry key handling and temporary folder handling in environments without Outlook or Outlook profile (#27) (Thanks @Imaginos!)

Changed

  • Cache group SIDs across all types of templates to reduce network load and increase script speed
  • Deprecate file name based tags. They work as-is, no new features will be added and support for file name based tags will be removed completely in the next months. Please switch to ini files, see README for details.
  • Update usage examples in script

v2.4.0 - 2021-12-10

Changed

  • Documentation updates
  • Updated FAQ: What about the new signature roaming feature Microsoft announced?
  • When connecting to Microsoft Graph, the TenantID is no longer set to 'organizations', but extracted from the logged in or simulated user name
  • Reduce number of required Graph authentication prompts by using a token cache file
  • Switching to the EWS Managed API .Net Standard port from https://github.com/ststeiger/RedmineMailService (the official Microsoft DLL is used with Windows PowerShell, ststeiger's port when run in PowerShell 7+) (Thanks @ststeiger!)
  • When saving a document in Word fails, wait for two seconds and retry saving to avoid problems with virus scanners

Added

  • Added sample code files ('.\sample code'), including a wrapper script for central creation and deployment of signatures and OOF messages without end user or client involvement
  • New default replacement variables for displayName and mailNickname (a.k.a. alias)
  • New parameter GraphOnly: Try to connect to Microsoft Graph only, ignoring any local Active Directory. The default behavior without GraphOnly is unchanged (try Active Directory first, fall back to Graph).
  • New parameters CreateRtfSignatures and CreateTxtSignatures allow to disable RTF/TXT signature creation
  • New parameter SimulateAndDeployGraphCredentialFile
  • New FAQ: How to deploy signatures for "Send As", "Send On Behalf" etc.?
  • New FAQ: Can I centrally manage and deploy Outook stationery with this script?
  • Report templates that are mentioned in the ini file but do not exist in the file system, and vice versa

Fixed

  • Do not ignore remote mailboxes when searching mailboxes in Active Directory (Thanks Lars Würtz Hammer!)
  • Correctly handle hybrid scenarios with basic auth disabled in the cloud (Thanks Lars Würtz Hammer!)
  • Correctly handle time based tags, so they are not checked twice (the first check is positive, the second one returns 'unknown tag')

v2.3.1 - 2021-11-05

Fixed

  • Ignore mail-enabled users an mailbox search to avoid binding to the wrong Exchange object in migration scenarios (which would lead to wrong replacement variable data and group membership)
  • When connecting to Exchange Online, check for valid mailbox in addition to valid credentials
  • Clarify port requirements and group membership evaluation in documentation

v2.3.0 - 2021-10-08

Changed

  • The parameter TrustsToCheckForGroups is also available under the more descriptive name TrustsToCheckForGroups. Both names can be used, functionality is unchanged.
  • Contribution opportunities in '.\docs\CONTRIBUTING.html'

Added

  • Support for mailboxes in Microsoft 365, including hybrid and cloud only scenarios (see '.\docs\README.html' and '.\config\default graph config.ps1' for details)
  • Possibility to use ini files instead of file name tags, including settings for template sort order, sort culture, and custom Outlook signature names (see parameters 'SignatureIniPath' and 'OOFIniPath' for details)
  • New default replacement variables $Current[…]Office$ and $Current[…]Company$, including updated templates
  • Enterprise ready workaround for Word security warning when converting documents with linked images
  • FAQ: the software hangs at HTM/RTF export, Word shows a security warning!?
  • FAQ: Isn't a plural noun in the software name against PowerShell best practices?
  • FAQ: How to avoid empty lines when replacement variables return an empty string?
  • FAQ: Is there a roadmap for future versions?
  • Code of Conduct (see '.\docs\CODE_OF_CONDUCT.html' for details)

Fixed

  • User could connect to hidden Word instance used for conversion of DOCX templates
  • Do no classify templates with unknown tags as common templates
  • Word settings temporarily changed by the software are now also restored to their original values when the software ends due to an unexpected error
  • Do not try to change read-only Word attributes <image>.hyperlink.name and <image>.hyperlink.addressold (regression bug)

v2.2.1 - 2021-09-15

Fixed

  • Allow multi-relative paths (Example: 'c:\a\b\x\..\c\y\z\..\..\d' -> 'c:\a\b\c\d')

v2.2.0 - 2021-09-15

Changed

  • Make script compatible with PowerShell Core 7.x on Windows (Linux and MacOS are not supported yet)
  • Reduce and speed up Active Directory queries by only accepting input in the 'Domain\User' or UPN (User Principal Name) format for the 'SimulateUser' parameter
  • Reduce and speed up Active Directory queries by only accepting email addresses as input for the 'SimulateMailboxes' parameter
  • Revise repository structure, as well as the process for development, build and release

Added

  • Full support for Exchange mailboxes added in Outlook as POP3 or IMAP4 accounts
  • Add FAQs: "Where can I find the changelog?", "How can I contribute, propose a new feature or file a bug?", "What is the recommended approach for custom configuration files?"
  • Add file hash of build artifacts to release information and hashes.txt
  • Add dark mode support and badges to documentation files

Fixed

  • Do not show an error message when no default Outlook profile is configured
  • Avoid additional blank lines at the end of TXT signature files when DOCX templates are used (#13)
  • Detect user's domain correctly when user and computer belong to different AD forests
  • Do not show an error message when only external or interal OOF message is set
  • Set current user's OWA signature even when mailbox is in another Outlook profile than the default one

v2.1.2 - 2021-09-03

Fixed

  • Correct extension attributes being shown as empty in replacement variables (#11) (Thanks @goranko73!)

v2.1.1 - 2021-08-26

Changed

  • Disable positional binding of passed arguments for easier debugging.
  • Rename '\bin\licenses.txt' to '\bin\LICENSE.txt'

Added

  • "implementation approach.html" describes the recommended approach for implementing the software, based on real-life experience implementing the software in multi-client environments with a five-digit number of mailboxes.
  • New FAQ "How to create a shortcut to the software with parameters?"
  • New FAQ "What is the recommended approach for implementing the software?"
  • Add multi-client capability hint to script description and readme file

v2.1.0 - 2021-08-13

Changed

  • Enhance long file path handling
  • Enhance FullLanguage mode detection

Added

  • FAQ: How do I start the software from the command line or a scheduled task?
  • Added command line and task scheduler example to script
  • Logo and icon files are now part of the download package

v2.0.2 - 2021-07-23

Changed

  • Inform the user when an Active Directory search returns less or more than one result
  • Readme chapter "Simulation mode" updated

Added

  • Readme FAQ "Can multiple script instances run in parallel?"

Fixed

  • Readme link about MS Word ExportPictureWithMetafile registry key to avoid huge RTF files supplemented by alternate link to Internet Archive Wayback Machine (#9) (Thanks @nitishkanu820!)

v2.0.1 - 2021-07-22

Do not use this release. It was withdrawn due to a severe problem.

v2.0.0 - 2021-07-21

Changed

  • Breaking: The configuration file is no longer a plain text file, but a full PowerShell script. This allows for complex replacement variable handling (complex string transformations, retrieving information from web services and databases, etc.).
  • When enumerating and categoring templates, category defining information is logged (assigned mail address, group name including SID)
  • Advanced primary mailbox detection and sorting
  • Easier readable output (s cript start and end times are shown, logical grouping of tasks (Outlook tasks first, basic AD tasks second, template enumeration third, then signature handling tasks), vertical whitespace between main tasks makes output easier consumable visually)

Added

  • Simulation mode
  • Major script steps now show a timestamp
  • Readme for "Simulation mode" and FAQ "How can I log the software output?"

Fixed

  • Templates with multiple groups or multiple mail addresses were not applied correctly and led to redundant Active Directory queries

v1.6.1 - 2021-06-30

Fixed

  • Empty AdditionalSignaturePath leads to error (#8)

v1.6.0 - 2021-06-26

Changed

  • Change template path structure
  • Update readme
  • Update templates

Added

  • Add support for HTML template files (.htm)
  • Add parameter UseHtmlTemplates to switch from DOCX to HTML template handling
  • Consider images in .docx templates with different text wrapping setting (Shapes for "in line with text" and InlineShapes for all other text wrapping settings)

Fixed

  • Check existence of signature file before trying to set Outlook web signature

v1.5.4 - 2021-06-24

Added

  • New FAQ: Why DOCX as template format and not HTML? Signatures in Outlook sometimes look different than my DOCX templates.

Fixed

  • Fix: Consider images with different text wrapping setting (Shapes for "in line with text" and InlineShapes for all other text wrapping settings).

v1.5.3 - 2021-06-23

Fixed

  • Fix problem connecting to SharePoint document libraries.
  • Fix readme file to reflect enhanced SharePoint document library possibilities in path parameters.

v1.5.2 - 2021-06-21

Fixed

  • Fix handling of Outlook Web connection error.
  • Fix readme: OOF templates are not applied when currently active or scheduled.

v1.5.1 - 2021-06-20

Fixed

  • Provide readme.html in releases, not markdown file
  • Update link formatting in readme files
  • Add attribution for logo source
  • Update logo path and dependencies

v1.5.0 - 2021-06-18

Added

  • Add support for out-of-office replies
  • New parameter SetCurrentUserOOFMessage
  • New parameter OOFTemplatePath
  • Add sample files for OOF templates '.\OOF templates'

v1.4.0 - 2021-06-17

Added

  • New parameter AdditionalSignaturePath

v1.3.0 - 2021-06-16

Added

  • New parameter DeleteUserCreatedSignatures
  • New parameter SetCurrentUserOutlookWebSignature

v1.2.1 2021-06-14

Fixed

  • Fix signature group name to SID mapping
  • Make logo work with every background (transparency, white glow)

v1.2.0 - 2021-06-11

Changed

  • Reduce LDAP queries by getting replacement variable data per mailbox, not per signature file and mailbox
  • Speed up variable replacement in image metadata

Added

  • Show replacement variable values in output
  • Show variables and script root in output
  • Show warning when replacement variable config file can not be accessed
  • Update signature template file 'Test all signature replacement variables.docx'
  • Include info about case sensitivity in file 'default replacement variables.txt'

v1.1.0 - 2021-06-10

Changed

-Move all replacement variable definitions to './config/default replacement variables.txt' -Update README: Add logo, modify chapter ordering, document parameter ReplacementVariableConfigFile

Added

  • Add Exchange Extension variables 1..15 to './config/default replacement variables.txt' and 'Test all signature replacement variables.docx'
  • Create subdirectories for binaries and configurations, adapt script to work with new subdirectories
  • Add a logo
  • Adapt script to include script information (version and others) in code and output

Fixed

  • Modify license.txt to that GitHub recognizes the license type
  • Add '.gitattributes' file to ignore '.git*' folders and README in relase
  • Add 'readme.txt', a plain text version of README, which can be read on all systems with on-board tools.

v1.0.0 - 2021-06-01

Initial release.

v0.1.0 - 2021-04-21

First lines of code were written as proof of concept, but never published.