Form finisher configuration¶

The consent finisher can be configured with the following options:

subject¶

Required: true
Type: string or LLL reference
Default: LLL:EXT:warming/Resources/Private/Language/locallang.xlf:consentMail.subject

Mail subject of the consent mail sent to the form submitter.

recipientAddress¶

Required: true
Type: string

Email address of the consent mail recipient. Can be a placeholder to an existing form element.

recipientName¶

Required: false
Type: string

Name of the consent mail recipient. May contain placeholders to one or more existing form elements.

senderAddress¶

Required: false
Type: string
Default: System default sender e-mail address

Email address of the consent mail sender. Can be a placeholder to an existing form element.

senderName¶

Required: false
Type: string
Default: System default sender name

Name of the consent mail sender. May contain placeholders to one or more existing form elements.

replyToAddress¶

Required: false
Type: string

New in version 2.2.0: Feature #221 – Allow configuration of Reply-To recipients in consent mail

Email address of the Reply-To mail recipient. Can be a placeholder to an existing form element.

replyToName¶

Required: false
Type: string

New in version 2.2.0: Feature #221 – Allow configuration of Reply-To recipients in consent mail

Name of the Reply-To mail recipient. May contain placeholders to one or more existing form elements.

approvalPeriod¶

Required: false
Type: integer
Default: 86400 (= 1 day)

Duration in seconds where consent mails can be approved. In fact, this results in a concrete datetime value for the valid_until database field of the current consent.

Note

Set to 0 to disable the approval period. A consent will then be approvable forever.

showDismissLink¶

Required: false
Type: boolean
Default: false

Enable or disable a link in the consent mail that allows to dismiss a consent. If this link is clicked, the consent is deleted.

confirmationPid¶

Required: true
Type: integer

ID of the page where consent confirmation is validated. This page should contain the validation plugin that handles consent approval and dismissal. The appropriate links in the consent mail are generated for this page.

storagePid¶

Required: false
Type: integer
Default: 0 (falls back to plugin.tx_formconsent.persistence.storagePid)

Page ID where to store new consents. This is typically a folder in the page tree that exclusively contains form consents.

Note

Set to 0 to use the default storage PID configured in site set setting plugin.tx_formconsent.persistence.storagePid or TypoScript configuration plugin.tx_formconsent.persistence.storagePid. See SiteSet configuration and TypoScript configuration for more information.

requireApproveVerification¶

Required: false
Type: boolean
Default: false

New in version 2.3.0: Feature #272 – Provide possibility for an additional verification step

Enable or disable an additional required verification step for consent approval. If enabled, users must verify their consent approval by additionally clicking on a link on the consent validation page. This is especially useful to avoid that automatic mail link scanners accidentally approving a consent.

requireDismissVerification¶

Required: false
Type: boolean
Default: false

New in version 2.3.0: Feature #272 – Provide possibility for an additional verification step

Enable or disable an additional required verification step for consent dismissal. If enabled, users must verify their consent dismissal by additionally clicking on a link on the consent validation page. This is especially useful to avoid that automatic mail link scanners accidentally approving a consent.

templateRootPaths¶

Required: false
Type: array

Additional paths to template roots used to render Fluid templates for the consent mail.

Note

Template root paths configured in form finishers take precedence over the ones configured within site settings and TypoScript.

partialRootPaths¶

Required: false
Type: array

Additional paths to template partials used to render Fluid partials for the consent mail.

Note

Partial root paths configured in form finishers take precedence over the ones configured within site settings and TypoScript.

layoutRootPaths¶

Required: false
Type: array

Additional paths to template layouts used to render Fluid layouts for the consent mail.

Note

Layout root paths configured in form finishers take precedence over the ones configured within site settings and TypoScript.