docx_mailmerge 1.0.3 icon indicating copy to clipboard operation
docx_mailmerge: ^1.0.3 copied to clipboard

Package for performing a mailmerge operation on merge fields within a DOCX document

pub package Build codecov License: MIT

Performs a mail merge operation on DOCX files. There are no platform dependant external dependencies which allows this package to run anywhere. Mail merge can even run in the browser!

Features #

  • Merge values with merge fields within a DOCX document
  • Get merge fields a document contains
  • Evergy merge works on a fresh copy of the document
    • Enables batch merging
  • Enable or disable proofreading on merged fields
    • Proofreading is disabled on merged fields by default to better match behavior seen in Word
  • Enable or disable the removal of merge fields that do not have a corresponding key/value to merge with

Getting started #

This package reads files as bytes through the data structure of a List<int>. For web, this project has an example in the /example/web folder for your use (JS compiled separately)

Usage #

To setup a document to be merged with, pass a List<int> of the file to the DocxMailMerge constructor.

DocxMailMerge(File('test/files/original1.docx').readAsBytesSync())

There is also a named constructor which will unzip and read the merge fields immediately rather than on demand.

DocxMailMerge.preprocess(File('test/files/original1.docx').readAsBytesSync())

The mergeFieldNames getter will return a Set<String> for the merge fields that exist in a document.

DocxMailMerge(File('test/files/original1.docx').readAsBytesSync()).mergeFieldNames

The merge operation takes a Map<String, String> for the key/values to be merged. There are also optional parameters which are documented in the code. The merge operation returns a List<int> which is the new file with the merged fields. Every merge operation reuses the original file and runs a merge on it allowing for repeat merge operations to be run on a single DocxMailMerge object without needing to create more.

DocxMailMerge(File('test/files/original1.docx').readAsBytesSync()).merge({'First_Name': 'hello world'}, removeEmpty: false)

Messages are not outputted by this package unless verbose is set to true. This can be set through the static variable verbose

DocxMailMerge.verbose = true;

Additional information #

This package comes from the issue of not having an easy cross-platform mailmerge package. This is inspired by the docx-mailmerge python package. The python package is more mature and may cover cases not yet addressed by this package, but this dart package does have an advantage. With the many different target platforms that dart can compile to, this package can be adopted easier into more ecosystems (Did i mention it can run in the browser?!).

3
likes
120
pub points
30%
popularity

Publisher

unverified uploader

Package for performing a mailmerge operation on merge fields within a DOCX document

Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (LICENSE)

Dependencies

archive, shlex, xml

More

Packages that depend on docx_mailmerge