Article Index
BwPostman provides following modules:
- BwPostman Module
- BwPostman Overview Module
BwPostman Module
This module displays a registration form for the mailing lists of BwPostman. Basically this module doesn't anything else as the registration form of the component nut at a module position. With this module it is possible to display a registration form for newsletters at all desired pages.
The tabs Module, Menu Assignment, Advanced and Permissions are known from Joomla!®. But the registration module also offers further settings:
Mailing list selection
At mailing list selection all mailing lists are displayed, which are accessible at front end. If You don't select something, all here displayed mailing lists are accessible for selection at the module. Certainly the access level is considered. If a visitor is not logged in, only the publicly accessible mailng lists are offered.
With this option You have the possibility to offer registration forms for different mailing lists at various pages.
Also You can set, if the description of the mailing list is displayed at the module. If You want to conform to the GDPR, You should activate this setting. Below You can set the number of characters, after which the description is shortened. After this number of characters there are displayed three dots. But to fulfil the GDPR anyway, a tooltip with the complete description is displayed while hovering the shortened description with the mouse.
Settings for the registration form
These settings are identically to the Options of the component at Registration and are not described here.
The special feature here is, that You are able to select different settings for component and each module. With this You may only ask for the mail address for a general, public accessible newsletter as example. For a newsletter, which is only accessible for a specific user group, You can set first name, last name and gender obligatory to be able to personalize the newsletter widely.
Tab Advanced
For the normal display of the module You choose the preset layout default.
Since version 3.1.0 of BwPostman there are also the layouts modal, modal-big, bootstrap2 and bootstrap4.
With both modal layouts only a button for registration to the newsletter is displayed. With a click to this button a pop up with the registration form appears.
The label of the button is specified at the field Button text below. For multi-language sites You can use a language string. If nothing is entered then the language string MOD_BWPOSTMAN_MODAL_BUTTON is used.
You were always been able to load the module at an article (loadposition, loadmodule, loadmoduleid). But with the modal layouts Your design possibilities are nearly unlimited. If You don't display the title of the module, You only have a Button at the article, not more.
An additional possibility You get, if You write a button at the article, which opens the pop up. Vital is that the button gets the id id=”bwp_reg_custom_open”. Additional in this case means: The module must be published and displayed, because only then the needed javascript will be loaded. Then the button can be displayed at continuous text. If You don't display the module, You get a link but this link does nothing.
BwPostman Overview Module
With this module You are able to display a list of calendar month, which contains published newsletters, at a module position. The number of sent and published newsletters of the month is displayed afterwards in parenthesis. You can set, to which recipients and campaigns the newsletters are sent. Also the selection of newsletters are widely configurable.
The tabs Menu assignment, Advanced and Permissions are known from Joomla!®.
The settings for Newsletter Selection, Mailing list selection and Campaign selection are the same as at menu entry Published newsletters (overview). If a menu entry is selected, the settings for recipient lists, campaigns and newsletter selection of the menu entry are used and the settings at the module are ignored.
The only difference, which is specific for this module, is # of months. Here You set the number of months, which are displayed at the module, if they correspond to the selection criteria, beginning with the current month the set number of months backwards. If it is now June 2021 and You set 4 months, You get the number of sent newsletters for June 2021, May 2021, April 2021 and March 2021 at the list. If there is no published newsletter for a month, which meets the other necessary criteria, if required, then this month don't appear at the list.
The entries of the list are linked. If You click to a month at the list, the list view of BwPostman opens at the main view of the page with a list of published newsletters of this month. These entries also are linked and with a click to this newsletter entry the detail view for this newsletter opens. Since version 3.1.5 of BwPostman the layout of list view and detail view is selectable at the options of the component.
At the list view for this month there are filters for month and year and also the list length. Beneath these filters there also are filters for mailing lists and campaigns available. The filters for mailing lists and campaigns are provided by the settings of the module, not from the settings of the list view of the component!