MailMerge 2.3.0

.NET Core 2.0
There is a newer version of this package available.
See the version list below for details. 
dotnet add package MailMerge --version 2.3.0
NuGet\Install-Package MailMerge -Version 2.3.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="MailMerge" Version="2.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add MailMerge --version 2.3.0
#r "nuget: MailMerge, 2.3.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install MailMerge as a Cake Addin
#addin nuget:?package=MailMerge&version=2.3.0

// Install MailMerge as a Cake Tool
#tool nuget:?package=MailMerge&version=2.3.0

MailMerge for docx Documents

MailMerge replaces simple and complex merge fields in WordProcessingML .docx files and helps you apply .Net's Xml & XPath tooling to Word documents.

Component Usage

For Streams:
var (outputStream, errors) = new MailMerger().Merge(inputStream, Dictionary);
For Files:
var (ok,errors) = new MailMerger().Merge(inputFileName, Dictionary, outputFileName);

To specify current DateTime : new MailMerger{DateTime=...}.Merge( ... )

Extension Methods & Helpers

stream.AsWordprocessingDocument(isEditable)
stream.AsXPathDocOfWordprocessingMainDocument(isEditable)
stream.AsXElementOfWordprocessingMainDocument(isEditable)

stream.GetXmlDocumentOfWordprocessingMainDocument()
fileInfo.GetXElementOfWordprocessingMainDocument()
fileInfo.GetXmlDocumentOfWordprocessingMainDocument()

A NamespaceManager, NameTable & Uri which you need when creating an XmlDocument and/or XElements:

var xdoc = new XmlDocument(OoXmlNamespaces.Manager.NameTable)
var xelement= mainDocumentPart.CreateElement("w", "t", OoXmlNamespaces.WpML2006MainUri)

CommandLine Usage

Perform a merge, or show a document's Xml

dotnet MailMerge.dll inputFile1 outputFile1 [inputFileN [...outputFileN]] [ key=value [...] ]
dotnet MailMerge.dll  --showxml file [fileN ...]

Example

dotnet MailMerge.dll input1.docx output1Bill.docx  FirstName=Bill  "LastName=O Reilly"

Settings

None really, but see https://github.com/chrisfcarroll/MailMerge/blob/master/MailMerge/appsettings.json for settable limits.

Doesn't do

  • Anything except Merge fields and Dates
  • Date formatting codes except a b B d D M y & h m s
  • Style/Formatting codes in the merge fields except these Date/Time formats
  • Multi-row datasources, just does 1 row at a time

Gotchas

  • Interprets .Net DateTime formatting codes that aren't in the WordProcessingML spec.

NuGet

https://www.nuget.org/packages/MailMerge/

How do I create a Word document with merge fields without attaching a datasource?

https://www.cafe-encounter.net/p2247/add-merge-fields-to-a-word-document-before-adding-a-datasource

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 is compatible.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.5.1 34,678 6/9/2023
2.5.0 153 6/9/2023
2.4.0 78,510 11/24/2020
2.3.0 645 7/20/2020
2.2.1 1,384 6/9/2019
2.2.0 1,265 11/24/2018
2.1.0 1,241 3/31/2018
2.0.0 1,133 3/23/2018
1.0.1 1,057 2/27/2018

2.3.0 Merges multi-line (\n or \n\r) input fields into a single <w:r>
           Breaking Change: Moved namespace MailMerge.Helpers -> MailMerge
     2.2.1 Should not require the existence of appsettings.json
     2.2.0 Handle more variations of w:instrText sequence.
     2.1.0 Added support for Complex Field Character sequences.
     2.0.0 Renamed component MailMerge.MailMerge to MailMerge.MailMerger