Extension Configuration 

Some general settings can be configured in the Extension Configuration.

  1. Go to Admin Tools > Settings > Extension Configuration
  2. Choose mail

The settings are divided into several tabs and described here in detail:

Mail 

mailFields
type

string

Default

subject, fromEmail, fromName, replyToEmail, replyToName, organisation

Comma separated list of mail fields. Will be available by markers in a mail message. e.g. replyToEmail as ###MAIL_replyToEmail### or ###USER_REPLYTOEMAIL### filled with (uppercase) value of the mail.

defaultRecipientFields
type

string

Default

uid, salutation, name, title, email, phone, www, address, company, city, zip, country, fax, firstname, first_name, last_name

Comma separated list of default recipient fields. Will be available by markers in a mail message. e.g. name as ###USER_name### or ###USER_NAME### filled with (uppercase) value of the user.

additionalRecipientFields
type

string

Default
 

Comma separated list of additional fields that may be substituted in the mail messages.

allowedFetchHosts
type

string

Default
 

Comma separated list of trusted hosts, e.g. intranet.example.org,*.example.org (*. matches all sub domains).

To protect against server side request forgery (SSRF), the server only fetches urls (content of external url mails, their stylesheets and images to embed) whose host resolves to public ip addresses. Hosts of the TYPO3 sites are always trusted. Add hosts here, which resolve to an internal network address but may be fetched nevertheless.

Credentials for password secured pages (httpUsername, httpPassword) are only sent to the site hosts and the hosts configured here.

mailPageTypeNumber
type

int

Default

24

MAIL page type number. Change this number only if another extension use the same.

mailModulePosition
type

string

Default

after:web

MAIL modules position in the side navigation. If set to empty, the module will move to the end of all other modules

mailModulePageId
type

int

Default
 

MAIL module page id. If set, page tree navigation will be hidden in MAIL module. Here you can add the uid of the MAIL sys-folder if you only have one.

mailModulePageIds
type

string

Default

auto

MAIL module page id. Reduces the page tree of the mail modules to a comma separated list of page uids. If set to "auto" (default), the list will be automatically taken from the pages database table, based on the selected module. This value can be overwritten via userTS.

Feature 

hideNavigation
type

bool

Default
 

Hide navigation: If set, page tree navigation will be hidden in mail module. User tsconfig parameter tx_mail.mailModulePageId has to be set!

deleteUnusedMarkers
type

bool

Default

1

Delete unused markers in personalized mails. All markers/placeholder without corresponding recipient data will remove from personalized mails.

notificationJob
type

bool

Default

1

Enable notification mail. Allow MAIL to send notification about start and end of a mailing job.

deactivateCategories
type

bool

Default

Deactivate categories. Attention: If set, ALL category fields inside tt_content,fe_users,tt_address,tx_mail_domain_model_group will be disabled!

useHttpToFetch
type

bool

Default

Use http connection for fetching Newsletter-Content. Even if your TYPO3 Backend is in SSL-Mode, the URL for fetching the newsletter contents will be http

specifyFinalRecipientsInWizard
type

bool

Default

Prior v4, the final recipients were determined after clicking the “Finish” button in the wizard. Now they are recalculated at the time of delivery once again. Check this option to keep the old behaviour.

ignoreBackendUserPermissionsForRecipientsFromPages
type

bool

Default

Ignore backend user permissions for recipients from pages.

enableEmailCorrection
type

bool

Default

0 (disabled)

Enables the correction of the email address of a failed or waiting delivery in the queue module. If checked, the column "Recipient" of the list of failed deliveries is an input field, and the corrected address is used when the mail is sent again.

The function is disabled by default. Then the address is shown as text, the buttons "Send again" and delete are still available, and requests that try to change the address are refused.

The correction only applies to this delivery. The recipient record (tt_address, fe_users and so on) is not changed. Use the RecipientEmailCorrectedEvent to do that.

The extension configuration of mail, tab feature, with the unchecked setting Enable correction of email addresses in the queue module

Direct Mail Migration 

directMailCategorySysCategoryMapping
type

string

Default
 

Mapping sys_dmail_category -> sys_category. Used by update wizard to migrate Direct Mail records to MAIL records. Format: 1:2,2:3,3:4 maps Direct mail category 1 to sys_category 2 and Direct mail category 2 to sys_category 3 and so on. If categories not found or set, new categories will be added.

directMailCategorySysCategoryParentCategory
type

int

Default
 

Parent sys_category used by sys_dmail_category -> sys_category migration. If the migrated categories should be attached to a parent sys_category.

Queue 

Settings of the send queue, which retries failed deliveries.

The extension configuration of mail, tab queue, with the settings of the send queue
maxAttempts
type

int

Default

20

Number of delivery attempts, including the first one, before a recipient is marked as failed for good. With the default, a recipient is tried for about 61 hours. See the retry schedule.

opsNotificationEmail
type

string

Default
 

Email address that is notified when a recipient is finally marked as failed. One email is sent per recipient. Leave empty to disable the notification.

alertWebhookUrl
type

string

Default
 

HTTPS address that is called (JSON POST) when the send queue turns unhealthy and, if notifyOnRecovery is active, when it is healthy again. Addresses that do not start with https:// are ignored. Leave empty to disable the webhook.

The address of a Slack incoming webhook can be used as it is. It is a secret, so do not commit it to a public repository. Set it in a context specific settings file of your project instead.

alertThresholdMinutes
type

int

Default

30

Age in minutes of the oldest recipient that is waiting for a retry or has failed, after which the queue counts as unhealthy and the webhook is called. The minimum is 1.

notifyOnRecovery
type

bool

Default

1

Also call the webhook when the queue is healthy again.

sentRetentionDays
type

int

Default

30

Number of days after which entries of delivered recipients are removed by the command mail:queue-cleanup.

failedRetentionDays
type

int

Default

90

Number of days after which entries of failed recipients are removed by the command mail:queue-cleanup. The age is counted from the last change of the entry.