Deprecation: #80420 - EmailFinisher single address options

See forge#80420

Description

The EmailFinisher of EXT:form has options to set multiple recipients for To, CC and BCC. For consistency reasons and to limit the number of choices, resulting in easier configuration, the single value configuration options have will be removed in favour for their respective multi value variants.

For this reason, the following options have been marked as deprecated and will be removed in TYPO3 11.0:

  • recipientAddress
  • recipientName
  • replyToAddress
  • carbonCopyAddress
  • blindCarbonCopyAddress

If any of these options are used, their values will be automatically migrated to their replacements.

Opening and saving a form with the form editor once also performs this migration and makes it permanent.

Impact

Any of these options will no longer work in TYPO3 11.0.

Affected Installations

All installations which use EXT:form and its EmailFinisher.

Migration

All single value options must be migrated to their list value successors.

Multiple Recipients

Change recipientAddress and recipientName to recipients.

Before:

finishers:
  -
    identifier: EmailToReceiver
    options:
      recipientAddress: to@example.org
      recipientName: 'To Example'
Copied!

After:

finishers:
  -
    identifier: EmailToReceiver
    options:
      recipients:
        to@example.org: 'To Example'
Copied!

Multiple Reply-To Recipients

Change replyToAddress to replyToRecipients. Additionally this allows for setting the name of a Reply-To recipient.

Before:

finishers:
  -
    identifier: EmailToReceiver
    options:
      replyToAddress: rt@example.org
Copied!

After:

finishers:
  -
    identifier: EmailToReceiver
    options:
      replyToRecipients:
        rt@example.org@example.org: 'Reply-To Example'
Copied!

Multiple Carbon Copy (CC) Recipients

Change carbonCopyAddress to carbonCopyRecipients. Additionally this allows for setting the name of a CC recipient.

Before:

finishers:
  -
    identifier: EmailToReceiver
    options:
      carbonCopyAddress: cc@example.org
Copied!

After:

finishers:
  -
    identifier: EmailToReceiver
    options:
      carbonCopyRecipients:
        cc@example.org: 'CC Example'
Copied!

Multiple Blind Carbon Copy (BCC) Recipients

Change blindCarbonCopyAddress to blindCarbonCopyRecipients. Additionally this allows for setting the name of a BCC recipient.

Before:

finishers:
  -
    identifier: EmailToReceiver
    options:
      blindCarbonCopyAddress: bcc@example.org
Copied!

After:

finishers:
  -
    identifier: EmailToReceiver
    options:
      blindCarbonCopyRecipients:
        bcc@example.org: 'BCC Example'
Copied!