Feed Mailer Documentation

download Feed Mailer Documentation

of 13

Transcript of Feed Mailer Documentation

  • 8/14/2019 Feed Mailer Documentation

    1/13

    1

    FeedMailer 1.4 Documentation

  • 8/14/2019 Feed Mailer Documentation

    2/13

    2

    FeedMailer 1.4 Documentation

    Table of Contents

    Installation ......................................................................................................................................... 3DotNetNuke 4.5.1+ .................................................................................................................... 3DotNetNuke 5.1.2+ ..................................................................................................................... 3

    Settings .............................................................................................................................................. 4Include Title Only ........................................................................................................................ 4Show Ventrian News Feeds......................................................................................................... 4Show Preview .............................................................................................................................. 4Preview Cache.............................................................................................................................. 4Display .......................................................................................................................................... 5Columns........................................................................................................................................ 5Email Subject ............................................................................................................................... 5Description text editor ................................................................................................................ 5Email Header text editor ............................................................................................................. 5Email Footer text editor .............................................................................................................. 5SMTP Server ................................................................................................................................. 5SMTP Username ........................................................................................................................... 5SMTP Password............................................................................................................................ 6SMTP email address..................................................................................................................... 6Preferred Portal Alias .................................................................................................................. 6

    User List Mode .................................................................................................................................... 7Preview......................................................................................................................................... 7List Management ......................................................................................................................... 8

    Admin Feeds Mode .............................................................................................................................. 9 Manage ............................................................................................................................................ 10

    Manage Admin Feeds................................................................................................................. 10Manage Subscriptions ............................................................................................................... 11

    Schedule .......................................................................................................................................... 12

    Schedule History ........................................................................................................................ 12Support ............................................................................................................................................ 13

  • 8/14/2019 Feed Mailer Documentation

    3/13

    3

    FeedMailer 1.4 Documentation

    Installation

    DotNetNuke 4.5.1+

    To install FeedMailer, login using the host account and navigate to the Host > Module

    Definitions page. Select Upload New Module and locate the DNN4 zip file on your hard drive.Click Upload Custom Module and FeedMailer will be installed. You can now add FeedMailer to atab in the normal manner.

    DotNetNuke 5.1.2+

    To install FeedMailer, login using the host account and navigate to the Host > ModuleDefinitions page. Select Install Module and locate the DNN5 zip file on your hard drive. Click

    Nextand continue through the wizard until FeedMailer is installed. You can now addFeedMailer to a tab in the normal manner.

  • 8/14/2019 Feed Mailer Documentation

    4/13

    4

    FeedMailer 1.4 Documentation

    Settings

    FeedMailer can be set to run in 2 modes: Admin Feeds Mode or User List Mode. The mode isdetermined by the Show Admin Feeds Only checkbox in Settings.

    If checked, the module view will display a series of checkboxes for each of the feeds that theAdministrator has set up in the Manage > Manage Admin Feeds section.

    If unchecked, the module view will allow each registered member to build their own list offeeds.

    Include Title OnlyWhen checked only the title of each individual feed item will be displayed in the email that issent to subscribers

    Show Ventrian News Feeds

    When checked a list of feeds will be shown in a dropdownlist in the Manage > Manage AdminFeeds tab. This list is made up of all exposed Ventrian News RSS feeds of the local portal, if the

    Ventrian News Articles module is installed. This setting should only be used if Show AdminFeeds Only is checked.

    Show Preview

    WhenShow Admin Feeds Only is unchecked each feed in the users view can be previewed toshow the latest item.

    Preview Cache

    This setting contains the number of minutes for which the feed preview should be cached.

  • 8/14/2019 Feed Mailer Documentation

    5/13

    5

    FeedMailer 1.4 Documentation

    Display

    This setting determines the repeat direction of the users list view

    Columns

    This setting determines the number of columns of the users list view.

    Email Subject

    This value will appear on the subject line of all emails sent be FeedMailer.

    Description text editor

    This setting allows you to add some content which appears at the top of the module view.

    Email Header text editor

    This setting allows you to add content which appears at the top of the email sent byFeedMailer. Tokens include [UserName] and [Email].

    Email Footer text editor

    This setting allows you to add content which appears at the bottom of the email sent byFeedMailer. Tokens include [UserName] and [Email].

    SMTP Server

    This value is used in case you want to use a different server to send emails, other than thecurrent DotNetNuke installation.

    SMTP Username

    The Username to be used for authentication for the SMTP server.

  • 8/14/2019 Feed Mailer Documentation

    6/13

    6

    FeedMailer 1.4 Documentation

    SMTP Password

    The Password to be used for authentication for the SMTP server.

    SMTP email address

    The email address to be used for sending emails from the SMTP server.

    Preferred Portal Alias

    This setting allows you to indentify which portalalias FeedMailer should use. This is onlynecessary if you have more than one portalalias.

  • 8/14/2019 Feed Mailer Documentation

    7/13

    7

    FeedMailer 1.4 Documentation

    User List Mode

    In the User List Mode each registered member manages their own collection of RSS feeds, sothat they receive an aggregated email of the top item from each feed whenever the FeedMailer

    schedule is run.

    An example collection

    Here the Display setting has been set to Horizontal and the Columns setting has been set to

    3. The user has clicked the plus icon and entered their own feeds. Each feed can be removedfrom the list by clicking the delete icon.

    Preview

    To preview the latest item from any feed simply click the RSS icon to show the preview in amodal window.

    Click the close link in the preview window to close it.

  • 8/14/2019 Feed Mailer Documentation

    8/13

    8

    FeedMailer 1.4 Documentation

    List Management

    A registered member can manage their own feed collection by clicking on the plus icon.

    The list of current feeds is shown so that they can easily be removed from this screen. To add anew feed simply enter a title in the Title box, and a RSS feed Url in the Url box and click theplus icon.

    To return to the module view screen, click the Return tab.

  • 8/14/2019 Feed Mailer Documentation

    9/13

    9

    FeedMailer 1.4 Documentation

    Admin Feeds Mode

    In the Admin Feeds Mode the administrator can manage a centalised list of RSS feeds to whicheach registered member can subscribe.

    The module view screen displays a series of check for each Admin Feed.

    Each registered member can simply subscribe or unsubscribe to any feed.

  • 8/14/2019 Feed Mailer Documentation

    10/13

    10

    FeedMailer 1.4 Documentation

    Manage

    The Manage screen can be accessed during page edit mode and is available as a module action.On the landing page there are clear instructions regarding each tab.

    Manage Admin Feeds

    The Ventrian News Feeds are listed in a select list at the top of the screen. If one is selected itwill fill the values of the Title and Url boxes, then so click the plus icon to add. Alternatively,manually enter a Title and Url.

    Each Admin Feed can be deleted and previewed by clicking the respective icons.

  • 8/14/2019 Feed Mailer Documentation

    11/13

    11

    FeedMailer 1.4 Documentation

    When the edit pencil is clicked another section of the page displays a checkbox list of all portalroles. The Administrator can choose to automatically subscribe all members of selected roles tothe selected feed.

    Manage Subscriptions

    In this tab the Administrator can manage every subscription.

    A single subscription can be removed by clicking the delete icon. The RSS icon will open apreview modal window which will show the latest item in the feed.

    Click the Return tab to return to the module view screen.

  • 8/14/2019 Feed Mailer Documentation

    12/13

    12

    FeedMailer 1.4 Documentation

    Schedule

    FeedMailer sends out emails to subscribers via the internal DotNetNuke Scheduler. WhenFeedMailer is installed the schedule is set to run every hour. The schedule can be controlled via

    the Host account at any time.

    Schedule History

    The schedule history is retained and shows how many feeds were processed and how manyemails were sent out by FeedMailer.

  • 8/14/2019 Feed Mailer Documentation

    13/13

    13

    FeedMailer 1.4 Documentation

    Support

    FeedMailer is a fully supported DotNetNuke module. All support is handled through the supportforums on the Talwrn Technology website.