Project

PSWriteOffice

PowerShell document automation across OfficeIMO's document, spreadsheet, presentation, PDF, Project, Access, EPUB, invoicing, and conversion engines.

View on GitHub Releases Get package
Stars 654
Forks 82
Open issues 1
Total downloads 4,320,051
Release OfficeIMO-v3.5.3
Language: C# Updated: 2026-11-03
Cmdlet

Invoke-OfficeWordMailMerge

Module
PSWriteOffice
Inputs
OfficeIMO.Word.WordDocument
Outputs
OfficeIMO.Word.WordDocument
Source
InvokeOfficeWordMailMergeCommand.cs:21 Edit on GitHub

Executes a simple mail merge against MERGEFIELD values in a Word document.

Syntax

Invoke-OfficeWordMailMerge
[-Document <WordDocument>]
[-InputObject] <Object>
[-PassThru]
[-PreserveFields]
[<CommonParameters>]
#
Parameter set: All Parameter Sets

Examples

Replace merge fields from a hashtable.

Invoke-OfficeWordMailMerge -InputObject @{ FirstName = 'John'; OrderId = 12345 }

Updates MERGEFIELD values in the active Word document.

Parameters

-Document WordDocument optionalpipeline: True (ByValue)
Document to update when provided explicitly.
-InputObject Object requiredposition: 0aliases: Data, Values
Hashtable or object whose properties map to MERGEFIELD names.
-PassThru SwitchParameter optional
Emit the updated document.
-PreserveFields SwitchParameter optional
Preserve field codes and only update displayed field text.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.