JBoss.orgCommunity Documentation

NewsletterInitializationService

The NewsletterInitializationService component is used to initiate some data for the newsletter portlet. The configuration of this component is found in packaging/ecmdemo/webapp/src/main/webapp/WEB-INF/conf/sample-portal/wcm/newsletter-configuration.xml.

Note

The Newsletter portlet and its services are deprecated. It remains fully supported for eXo customers, however it will not receive any enhancement and will be removed from the product scope in the future.



<component>
    <type>org.exoplatform.services.wcm.newsletter.NewsletterInitializationService</type>
    <init-params>
        <values-param>
            <name>portalNames</name>
            <value>classic</value>
            <value>acme</value>
        </values-param>
        <values-param>
            <name>administrators</name>
            <value>root</value>
            <value>john</value>
        </values-param>
        <object-param>
            <name>marketing</name>
            <description>marketing</description>
            <object type="org.exoplatform.services.wcm.newsletter.NewsletterCategoryConfig">
                <field name="name">
                    <string>marketing</string>
                </field>
                <field name="title">
                    <string>Marketing</string>
                </field>
                <field name="description">
                    <string>You want to know where we are, where we go ?</string>
                </field>
                <field name="moderator">
                    <string>*:/platform/web-contributors</string>
                </field>
            </object>
        </object-param>
        <object-param>
            <name>general</name>
            <description>general</description>
            <object type="org.exoplatform.services.wcm.newsletter.NewsletterCategoryConfig">
                <field name="name">
                    <string>general</string>
                </field>
                <field name="title">
                    <string>General</string>
                </field>
                <field name="description">
                    <string>General information about us</string>
                </field>
                <field name="moderator">
                    <string>*:/platform/web-contributors</string>
                </field>
            </object>
        </object-param>
        <object-param>
            <name>subscription2</name>
            <description>subscription2</description>
            <object type="org.exoplatform.services.wcm.newsletter.NewsletterSubscriptionConfig">
                <field name="name">
                    <string>results</string>
                </field>
                <field name="title">
                    <string>Results</string>
                </field>
                <field name="description">
                    <string>Monthly newsletter about our results and forecasts</string>
                </field>
                <field name="categoryName">
                    <string>general</string>
                </field>
                <field name="redactor">
                    <string>*:/platform/web-contributors</string>
                </field>
            </object>
        </object-param>
        <object-param>
            <name>subscription1</name>
            <description>subscription1</description>
            <object type="org.exoplatform.services.wcm.newsletter.NewsletterSubscriptionConfig">
                <field name="name">
                    <string>checklist</string>
                </field>
                <field name="title">
                    <string>Check-List</string>
                </field>
                <field name="description">
                    <string>Weekly newsletter with general topics</string>
                </field>
                <field name="categoryName">
                    <string>general</string>
                </field>
                <field name="redactor">
                    <string>*:/platform/web-contributors</string>
                </field>
            </object>
        </object-param>
        <object-param>
            <name>subscription3</name>
            <description>subscription3</description>
            <object type="org.exoplatform.services.wcm.newsletter.NewsletterSubscriptionConfig">
                <field name="name">
                    <string>market</string>
                </field>
                <field name="title">
                    <string>The market</string>
                </field>
                <field name="description">
                    <string>What's on the market today ?</string>
                </field>
                <field name="categoryName">
                    <string>marketing</string>
                </field>
                <field name="redactor">
                    <string>*:/platform/web-contributors</string>
                </field>
            </object>
        </object-param>
        <object-param>
            <name>user1@gmail.com</name>
            <description>user1@gmail.com</description>
            <object type="org.exoplatform.services.wcm.newsletter.config.NewsletterUserConfig">
                <field name="mail">
                    <string>user1@gmail.com</string>
                </field>
            </object>
        </object-param>
        <object-param>
            <name>user2@gmail.com</name>
            <description>user2@gmail.com</description>
            <object type="org.exoplatform.services.wcm.newsletter.config.NewsletterUserConfig">
                <field name="mail">
                    <string>user2@gmail.com</string>
                </field>
            </object>
        </object-param>
    </init-params>
</component>

Details:

Name Type Value Description
portalNames string classic, acme The portal names.
administrators string root The administrator who manages the newsletter portlet.
Field Type Description
name string The name of categories or subscriptions.
title string The title of categories or subscriptions.
description string The description of categories or subscriptions.
moderator string The users or groups that can moderate the newsletter portlet.
categoryName string The categories name.
redactor string The users or groups that are newsletter redactor.
mail string The email that user uses to subscribe.