.. include:: /Includes.rst.txt .. _quick-configuration: =================== Quick configuration =================== .. contents:: :local: :depth: 1 .. _configuration-site-sets-way: With Site Sets (recommended) ---------------------------- .. _add-new-site-root: .. rst-class:: bignums #. Add a new ROOT site in your page tree This site will be used to store the MAIL pages later. Remember the uid of this new page, you may need it in a later step. Open the settings of the new created page, go to tab :guilabel:`Behaviour` and switch on **Use as Root Page**. Additional select :guilabel:`MAIL Module` under **Contains plugin**. Also check **Hide child pages in page tree**, if you like to activate a usefull feature that helps you to keep track of an extensive page tree. .. include:: /Images/MailSiteRootBehaviour.rst.txt .. _site-configuration-mail-root: #. Open the site configuration of the just created page .. include:: /Images/MailSiteConfiguration.rst.txt .. _site-settings-mail-root-select-site-set: #. Add Site Set Under the :guilabel:`General` Tab you can find all relevant settings. First of all you have to enter a **Site Identifier** (eg. newsletter). Second, add an **Entry Point**. This **must** be a full domain! Relative domains like "/" will **not** work! Same for optionaly added **Variants**. At **Sets for this Site** add the included :guilabel:`MAIL Fluid Styled Content Elements` Set (if you like to use the included fluid styled content elements) or, if you like to use the included Content Block Elements the :guilabel:`MAIL Content Blocks` Set. There is also a :guilabel:`MAIL News Content Elements` Set available, if you like to use the News Plugin. All of them depend on the :guilabel:`MAIL Backend Layout and Settings` Set, so that these do not need to be added separately. .. include:: /Images/MailRootSiteConfigurationExample.rst.txt .. _site-settings-mail-root-select-backend-layout: #. Set Backend Layout Back in the TYPO3 :guilabel:`Page` Module, open the Settings of your MAIL Root Page. In here, click on the :guilabel:`Appearance` tab, select :guilabel:`MAIL` in both **Backend Layout** boxes and press :guilabel:`Save`. .. include:: /Images/MailBackendLayouts.rst.txt :ref:`Now you are ready to add mail pages ` .. _site-settings-mail-root-configure-style: #. Styling To change the styles of the generated mails, go to the :guilabel:`Settings` Module and click on :guilabel:`Edit Settings` of your MAIL Site. .. include:: /Images/SiteManagementSettings.rst.txt E.g. change colors under **Styles** .. include:: /Images/MailSiteSetSettings.rst.txt .. attention:: If you want to switch from the classic way to site sets way, aware that the root page of MAIL has be changed to a "real" site root. Additional do not forget to remove old TypoScript or TsConfig settings! And a classic: Clear **ALL** Caches after a change. Further reading ~~~~~~~~~~~~~~~ * :ref:`Site sets `_ * :ref:`MAIL Site Sets Settings ` .. _configuration-classic-way Classic Way ----------- .. _add-mail-sysfolder: .. rst-class:: bignums #. Add a new sys-folder inside (!) of your page tree (not on page 0!) This folder will be used to store the MAIL pages later. Remember the uid of this new sys-folder page, you may need it in a later step. Open the settings of the new created sys-folder page, go to tab :guilabel:`Behaviour` and select :guilabel:`MAIL Module` under **Contains plugin**. .. include:: /Images/MailPageModule.rst.txt .. _add-static-page-ts-config-files: #. Add Static Page TSconfig Files Switch to the :guilabel:`Resources` tab and include this **static Page TSconfig** entries: * :guilabel:`MAIL: Add simple mail backend layout` * :guilabel:`MAIL: TCEFORM settings for the mail root page` * :guilabel:`MAIL: Default settings for mail pages` If you want to use the fluid styled content elements additional: * :guilabel:`MAIL: Allow only supported fluid styled content elements` * :guilabel:`MAIL: Disable not supported fields of fluid styled content elements` If you want to use the content block elements additional: * :guilabel:`MAIL: Allow only supported content blocks` * :guilabel:`MAIL: Disable not supported fields of content blocks` If you want to use the news plugin additional: * :guilabel:`MAIL: Allow only supported news content elements` If you want to disable all category stuff: * :guilabel:`MAIL: Deactivate categories` Press the good old floppy disc icon to save. After that, a new backend layout :guilabel:`MAIL` should be available under the :guilabel:`Appearance` tab. .. _select-mail-backend-layout: #. Select MAIL backend layout Choose it for this page and also for the subpages. .. include:: /Images/MailBackendLayouts.rst.txt .. _include-typoscript-templates: #. Include TypoScript templates To use the included table based content elements, a corresponding TypoScript is provided by this extension. Go module :guilabel:`Web > Template` and chose your MAIL sys-folder. If not already done, create an extension template. Switch to view :guilabel:`Info/Modify` and click on :guilabel:`Edit the whole template record`. Switch to the :guilabel:`Advanced Options` tab and check :guilabel:`Constants` and :guilabel:`Setup` to **Clear** every TypoScript settings from TypoScript records up in root-line. Additional **Include** the following **TypoScript sets** if you want to use the fluid styles content elements: * :guilabel:`MAIL (Page)` * :guilabel:`MAIL (Styles)` If you want to use the fluid styled content elements additional: * :guilabel:`Fluid Content Elements (fluid_styled_content)` * :guilabel:`MAIL (Fluid Styled Content)` If you want to use the content block elements additional: * :guilabel:`MAIL (Content Blocks)` If you want to use the news plugin additional: * :guilabel:`MAIL (News)` Read more about possible configurations via TypoScript in the :ref:`Reference ` section. .. _import-recipient-sources: Add recipient sources --------------------- MAIL needs a yaml configuration for recipient sources. It comes with a ready configuration for frontend user groups (fe_groups), frontend user (fe_users) and addresses (tt_address). To add them all, just import the included yaml into your site configuration: .. code-block:: yaml imports: - { resource: "EXT:mail/Configuration/Site/RecipientSources.yaml" } .. note:: If no entries with the key prefix mail.recipientSources found in your site configuration, the default configuration from the upper path will be used. Read more about how to add your own recipient sources in the :ref:`Site configuration reference `. .. _configure-default-settings: Configure default settings -------------------------- MAIL brings – similar to EXT:direct_mail – an easy way to adjust some default settings, used by the mail creation wizard. You find it by clicking on the cog button (Configuration) on the upper right corner of the MAIL wizard module. .. include:: /Images/MailDefaultSettingsButton.rst.txt The input fields are divided into several groups, which can be reached by clicking on their titles. .. include:: /Images/MailDefaultSettings.rst.txt After filling all fields with your data, press SAVE to store. .. tip:: All configurations done here will be stored in the :guilabel:`Page TSconfig` field of the currently selected page. This way, it is possible to override settings in a deeper page tree level. Further reading ~~~~~~~~~~~~~~~ * :ref:`Global extension configuration ` * :ref:`Site configuration ` (Recipient sources and mail transport settings) * :ref:`TypoScript configuration ` * :ref:`Page TSconfig configuration `