Migrate SmartFormat.NET v2.7.3 to v3.2.1

Heads up

This version is API and source compatible with prior 5.x versions.

In v5.11 the referenced package for SmartFormat.NET is updated from v2.7.3 to v3.2.1. This new major version of SmartFormat.NET incurs breaking changes. MailMergeLib manages breaking API changes under the hood. Other breaking changes are related to using SmartFormat formatter extensions in placeholders:

1. If you're only using plain placeholders like "{Email}" or even "{Today:yyyy-MM-dd}" there's no need for updating the format strings, and you're fine.
2. If you're using formatters like "{Fruit:cond:Apple|Pie|Orange|Banana|No fruit}", where the rendered string depends on the Fruit variable, urgently have a look at https://github.com/axuno/SmartFormat/wiki/Migration#2-formatter-differences-from-v2-to-v3 .Required modifications are not extensive, but unavoidable.
3. On the other side SmartFormat v3 has many advantages:
   • Parsing is 10% faster with 50-80% less GC and memory allocation
   • Formatting is up to 40% faster with 50% less GC and memory allocation
   • Nullable notation inside placeholders
   • much more

See more details here: https://github.com/axuno/SmartFormat/wiki/Why-Migrate

Details

• Update of SmartFormat.NET to v3.2.1 with at least the same extensions enabled as in prior MailMergeLib 5.x versions
• Add NET 6.0 as a target framework, reducing the number of dependencies
• After installation is completed, the above "Heads up" message is displayed
• Add Sandcastle Help File Builder project folder
• Resolves #23

Full Changelog: https://github.com/axuno/MailMergeLib/compare/v5.10.0...v5.11.1

Migrate SmartFormat.NET v2.7.3 to v3.2.1

Full Changelog: https://github.com/axuno/MailMergeLib/compare/v5.10.0...v5.11.0

What's Changed

• Update referenced packages in https://github.com/axuno/MailMergeLib/pull/37
• Resolves: Timing based private key exposure in Bouncy Castle

Full Changelog: https://github.com/axuno/MailMergeLib/compare/v5.9.1.0...v5.10.0

What's Changed

This is a maintenance release

• Change to file-scoped namespaces in solution https://github.com/axuno/MailMergeLib/pull/29

Update dependencies https://github.com/axuno/MailMergeLib/pull/34:

MailMergLib:

• Minimum .Net Framework version is 4.6.2
• Update package references
  • AngleSharp 1.0.0
  • MailKit 3.4.3
  • MimeKit 3.4.3
  • YAXLib 4.0.0
  • SmartFormat.NET >= 2.7.3 && < 3.0
• Disable warnings CA5350, CA5351, CA5401

MailMergLib.Tests:

• Update package references
• Remove obsolete SmartObject unit tests

Full Changelog: https://github.com/axuno/MailMergeLib/compare/v5.8.2.0...v5.9.1.0

Updated version of package references: Set highest major version of compatible dependencies for MailKit, MimeKit, SmartFormat.NET, YAXLib

Fixes

• Fixed: Large embedded images could throw UriFormatException
• Package references: Set version range of compatible dependencies for MailKit, MimeKit, SmartFormat.NET, YAXLib

Maintenance release

• Updated dependencies to latest versions
  • Fixed compatibility issues with updated dependencies (specifically MailKit, MimeKit and YAXLib with new major versions).
  • Now referencing updated SmartFormat.Net v2.7.2 for formatting.
  • No impact on MailMergeLib public API.
• Supported frameworks
  • .Net Framework: 4.6.1 and later
  • NetStandard: 2.1 and later

Maintenance release

• Added support for NET5.0
• MailMergeLib.Tests is now NetCoreApp3.1
• Formatting (parse and format variables) can be switched off with MailMergeLib.EnableFormatter = false . Default is true
• Fixed file related tests for AppVeyor and Travis
• Enabled SourceLink

Note: New release, because v5.7.0.0 referenced MailKit/MimeKit 2.4.0 assemblies, which were not strongly signed for .NetFramework 4.6 in the NuGet packages

• Encryption of Credential in Settings can now be disabled. Breaking change: disabled is the default. To enable, set Settings.CryptoEnabled = true.
• SMTP settings can now be read from web.config as well as app.config
• Path checks (e.g. inline images, attachments) now respect Linux and MacOsX platform rules beside Windows. Linux tests run on Ubuntu.
• Classes in namespace 'MailMergLib.SmartFormatMail' were obsolete and are now removed.
• Updated string parser/formatter to SmartFormat.Net v2.5
  • Data Sources
    • New: Added ValueTupleSource for ValueTuples
    • Changed: SmartObjects and SmartObjectsSource are depreciated in favor of ValueTupleSource
  • Settings
    • Breaking Change: Internal string comparisons (i.e. for placeholder names) are no more culture-specific, but Ordinal or OrdinalIgnoreCase respectively. See discussion under this issue.
    • Breaking Change: Default ErrorAction is now ThrowError for parser and formatter, instead of Ignore
  • Other
    • Changed: Removed all members which were flagged obsolete since more than a year.
• Updated versions of other dependencies
• Dropped support of .NetFramework 4.5 (because of dependency to AngleSharp package). Minimum now is 4.6.
• Dropped support of NetStandard1.6 (as announced)

• Encryption of Credential in Settings can now be disabled. Breaking change: disabled is the default. To enable, set Settings.CryptoEnabled = true.
• SMTP settings can now be read from web.config as well as app.config
• Path checks (e.g. inline images, attachments) now respect Linux and MacOsX platform rules beside Windows. Linux tests run on Ubuntu.
• Classes in namespace 'MailMergLib.SmartFormatMail' were obsolete and are now removed.
• Updated string parser/formatter to SmartFormat.Net v2.5
  • Data Sources
    • New: Added ValueTupleSource for ValueTuples
    • Changed: SmartObjects and SmartObjectsSource are depreciated in favor of ValueTupleSource
  • Settings
    • Breaking Change: Internal string comparisons (i.e. for placeholder names) are no more culture-specific, but Ordinal or OrdinalIgnoreCase respectively. See discussion under this issue.
    • Breaking Change: Default ErrorAction is now ThrowError for parser and formatter, instead of Ignore
  • Other
    • Changed: Removed all members which were flagged obsolete since more than a year.
• Updated versions of other dependencies
• Dropped support of .NetFramework 4.5 (same as with MailKit/MimeKit packages). Minimum now is 4.6.
• Dropped support of NetStandard1.6 (as announced)