* This Manual is a work in progress.... please check back as there will be regular updates - manuman 05/10/2006

Letterman has three extensions. The main component, a module for subscriptions and a search plugin. This manual will take you step by step through each. It is assumed that you have installed each via Joomla!'s standard installation process for extensions.

The Letterman Component

The component is the primary workhorse for Letterman. From the admin you can set up the basic configuration settings and manage both newsletters and subscribers. From the front-end users may view current and past newsletters.

Administration

From Joomla!'s administration screen click Components. Somewhere in the dropdown list you will see Letterman. By placing your mouse over the Letterman menu item you will get three more menu options appear to the left.

Configuration

The configuration screen allows you to adjust a number of Global settings. What you set here will be applied to all apsects of Letterman.

Fields

• Extended email address validation? - Only for non-windows systems. Checks to see if the domain in the email address is a valid mail exchange server and ready to receive mail.
• Embed images into the email? - "Yes" will embed local images into the mail message. This will make the message size larger. However, the recipients will definitely see the embedded images.
• Number of personalized mails to send per step? - This number defines the default number of mails per step for those mails that contain the [NAME] tag.
• Number of mails to send per step? - This number defines the default of mails per step for those mails that do NOT contain the [NAME] tag.
• File attachment directory? - The directory in your site holding files you want to use as attacments for mails.
• The CSS styles which are used to style the HTML newsletter? - This defines the 'look' your newsletters will have. It is customizable.

Subscriber Management

The Subscriber Management screen allows you to add, remove and edit all Subscribers.

Fields

• Subscriber Name - The subscriber's name.
• Subscriber Email - The subscriber's email address.
• Signup Date - Date that the subscriber confirmed his newsletter subscription
  
• Confirmed - Has the subscriber confirmed his subscription? Yes or No.

Buttons

• New Subscriber - Manually add new subscribers to your mail list.

Fields

• Signup Date: This field will be filled with the confirmation date after the subscriber is confirmed.
• Subscriber Name: This name will appear in personalized mailings when using the [NAME] tag.
• Subscriber Email: The subscriber's email address.
• Confirmed?: Yes or No drop down list
• Edit Subscriber - Select the subscriber you wish to edit and update the subscriber's name, email and confirmed status as needed.
  
• Remove - Select the subscriber(s) you wish to remove. Confirm or cancel the action in the confirmation box.
  
• Assign Users - Here you may select existing registered users of your website and add them as subscribers to your newsletter(s).
• Validate -
• Import Subscribers - Here you can import subscribers from your existing YaNC/Letterman XML file(s) or from a .csv file.
  
• Export Subscribers - Export your current subscriber list as a backup file in XML format.

Newsletter Manager

The Newsletter Manager is where you create, edit, remove and publish your newsletters.

Fields

• Subject: The title of your newsletters
• Message: A preview of the opening sentences to your newsletter
• Created: The date your newsletter was last saved
• Last Send: The date your newsletter was last sent to the subscribers.
• Send Now: This will bring up the "Send Newsletter" menu and includes the following fields;
• Send to Group: Drop down list, choices include All Subscribers, All User Groups, Registered, Authors, Editor, Publisher, Manager, Administrator, Super Administrators. Default is ‘All Subscribers’.
• Only confirmed Accounts?: Check the box to send the newsletter to only those subscribers that have confirmed their subscription.
  
• Mail From: This is the email address that subscribers will see in their inbox as the sender. The default is the Administrator's email address. This field is customizable.
• Reply to: This is the email address that will receive any replies from your newsletter. The default is the Administrator's email address. This field is customizable.
• Disable timeout: Check the box to prevent the script from generating a timeout. This will not work in "safe mode".
• How many mails to send at once?: The maximum number of emails to send at one time. This field is customizable.
• Preview: You will see a preview of your newsletter in both the HTML and Alternative Text versions.
• Published: The green check box is a published newsletter, red is unpublished. The default is unpublished.
• Checked Out: Displays the name of the editor that is currently working on the newsletter.

Buttons

• Publish - Choose the newsletter from the list that you wish to publish
• Unpublish - Choose the newsletter from the list that you wish to unpublish.
• New - Compose your newsletter. Use the [NAME] tag to personlize it.
• Compose Newsletter - Compose a newsletter from your website's existing content. Tags that you can use include [NAME], [ATTACHMENT filename=""], [CONTEND id=""].
• Edit - Choose the newsletter from the list that you wish to edit.
• Remove - Choose the newsletter from the list that you wish to delete.

The Letterman Module

From Joomla!s Administration screen choose Modules and Site Modules. Somewhere in the list you will see Letterman. Click on it to configure the module settings.

Site Module: Edit [Letterman]

Details Section:

• Title: The title you wish to name your module. (e.g. "mywebsite newsletter")
• Show Title: No/Yes radio buttons
• Position: Choose which position the Letterman Module should appear in from the drop down list.
• Module Order: Choose what order you would like the Letterman Module to appear in.
• Access Level: Public, Registered, Special
• ID: This is the ID number for the module. The ID number is assigned by Joomla!.
• Description: Describes the function of this module

Pages/Items Section:

Choose which pages of your website you wish the Letterman Subscribe Module to appear on.

Parameters Section:

The Text -before- the Subscribe Form: Optional introductory text. (e.g. "sign up for our newsletter")

Limit number of Characters for -Name- Field?: Yes/No radio buttons

Number of Chars for Character Limit: The maximum number of characters you will allow for the name.

Hide the -Name- Field?: Yes/No radio buttons.

Module Class Suffix: A suffix to be applied to the css class of the module (table.module), this allows individual module styling.

Menu Class Suffix: A suffix to be applied to the css class of menu items.