Overview

This guide includes a step by step tutorial describing the installation of eBirdMail.  It is addressed to users installing and configuring the application.  eBirdMail is a console application and it only interacts with the user while it is being configured. Once configured and tested, it can run unattended as described in the Scheduling section. For a more general description on what eBirdMail is visit the product information website.

Note that sections of this guide also include advanced user topics that go beyond the installation of the product.


Prerequisites

eBirdMail runs and is supported under the following Operating Systems:

  • Windows XP
  • Windows Vista
  • Windows 7
  • Windows Server 2003 and 2008

Sending Email requires at least one of the following to be available:

  • MS Oulook (2000, 2003, 2007) Client
  • SMTP server connection

Installation

eBirdMail is distributed as zip file and uses a Windows installer.  Just unzip the package wherever you want it,  change to that directory and run setup.exe to install eBirdMail on a local drive.

Notes for Vista and later versions of Windows

When installing eBirdMail on a Windows Vista or later OS, DO NOT install into the C:\Program Files folder. Install instead in a folder like C:\Applications\eBirdMail. By default Vista and later versions do not allow programs installed in the C:\Program Files folder to save data anywhere under that folder, which is what eBirdMail needs to be able to do.


Getting Started

Configuration of eBirdMail starts automatically.  A wizard interface will walk you through the configuration process. Once configured, eBirdMail can be setup to run automatically and unattended as a console application.


Configuration Wizard

The wizard walks you through the configuration process and provides a real-time feedback to you. It verifies the entered parameters at each step and flags those in error. All configuration parameters are saved after the Finish step of the wizard. All data sensitive configuration parameters are automatically secured and encrypted.

eBirdMail is designed to support multiple configurations and allow for composing email based on different data sources,  email templates and delivery ways. The Free edition supports only spreadsheets and csv files as data sources.

It can run with a configuration of your choice, and often scheduled according to the day of the week or type of application.


The Data Connection

Connection types are based on the system where eBirdMail is installed. Below is the list of data connection choices for the Free edition:

  • OLE DB - (Provider is the Microsoft.Jet engine for Excel and text data)

The Data Source

Selection of the data source is dependent on the chosen connection type and it can be a database table or a file. In case of a database source, both server and database name are required, as well as login information.

If the data source is a file, selecting a new file is done by clicking on the folder icon.

Next, select a worksheet from the drop down below the Data Source.

Clicking the Rebuild button creates a new connection string.

The Test Connection button verifies that you can connect to the selected data source.


Data Preview

 

Data preview is automatic, after a Data Source is selected and accessible.

The preview also provides filters to select and limit the data input to the email generation steps. Either And or Or type filtering can be applied to any date, numeric and character fields.

In this example <>Empty is entered to process only records with non-blank email addresses. Alternatively, entering =Empty in a character field will select records with blank or null values in that field.

Field names for merging into a Template can include only alphanumeric characters, spaces and underscores (_).


Data Filters

Data filters are static in the Free edition and are defined in Data Preview.



Email Content

Email Content is generated by merging data from the Data Source field names into predefined Email Body Templates and into Email Headers.

Click on the folder icon to select a template file, which can be either text or html formatted.  A pair of unique Delimiters is required, as template tags for data content to be merged. These can be brackets [],{} or any combination of characters, as in the example here.

If Attachments are to be sent, including reports, check the Include box at this time. Details about the attachments will be collected in a later step by the wizard.

Email Headers entries can be fixed or include content from the data source fields. Select a field from the list, then drag or paste it into an email header entry.

The To, From and Subject Email Headers entries above are required - the rest are optional.


Template Design

Email Templates are used for merging data from the Data Source to generate the content of the email body.  Templates can be created and edited using the build-in editor, as shown here, or any external text or HTML editor of your choice.

Click on the New or Save buttons to create or save a template file.  The file can be either plain text (with .txt file name extension) or HTML formatted (.html file extension.)

The Editor button lets you select an external text or HTML editor or your choice.

Select a field from the data fields list, then drag or paste it into the template body.

You can also enter your own delimited tags and use custom scripts to provide the data for them.

Embeding image files from local resources into HTML content can produce mixed results, depending on the email delivery methods and servers. For more consistent results use web hosted image files.

The are many sources for good text and HTML editors and many editors are free, both for online and local system use.


Email Preview

 

Previews show the results from merging the filtered source data with the template and email headers.

Click the Preview button to view the text of the next email,  keeping in mind any the filters you may have applied.

To preview the associated Email Header information mouse over the Details box.

Use wizard's Back button to make changes to the email template and headers, as well as any of the data filters.


Email Attachments

  This feature is not available in the Free edition.



Reports Setup

This feature is not available in the Free edition.


Email Delivery

Email Delivery requires a server type selection and requires a server type selection and a server setup.  However, unlike the Data Connection setup steps, the configuration wizard does not attempt to validate the email server setup parameters.    Users should examine eBirdMail's log file for success or failure messages associated with the actual delivery of the email to the configured server.

Click the ose from one of the six server types:

  • SMTP - built-in Email 
  • MS Outlook - 2000, 2003, 2007 (Requires an Outlook Client install)

The form fields for setup change according to the selected type of server. 

SMTP server setup


 

The MS Outlook setup requires an Outlook client installation on the same system where eBirdMail is installed. eBirdMail will use the configured Outlook account for sending emails.

Check the Send to Draft Folder box to allow for preview of the email in Outlook.

In order to avoid the impact of any Outlook security alerts during unattended runs of eBirdMail, we recommend you obtain and install a copy of the Advanced Security for Outlook utility from MAPILab Ltd.

 


Logging

eBirdMail produces a log with informational, warning and error data when it runs. 

The log is a text file named eBirdMail.log and is located in the install directory.  It can also be viewed by clicking the View Log button shown in the Finish step of the wizard below. 

  The eBirdMail.log file can be exported in XML format and it should be emptied periodically.


Scheduling

eBirdMail is a console application and it only interacts with the user while being configured.  Before creating a schedule check the eBirdMail.log file and the Windows Application Event log for any errors.


An quick way to schedule emailBird to run automatically is to set it up as a Scheduled Tasks from Windows's Control Panel.

emailBird can run with a configuration of your choice, by providing the configuration name as a parameter: eBirdMail.exe -c:name

 


Product Registration

This License Agreement window will appear until the product is registered and you select the Accept option and click on the Finish button to continue.

 

 


License

infoSpectrum Software License Agreement.

This document is a legal agreement between you and infoSpectrum Inc., (infoSpectrum). Please read this Agreement carefully. By installing, copying, or otherwise using the Software Program, you agree to be bound by the terms of this license agreement.

1. Copyright

The Software Program (the "Program") is owned by infoSpectrum , and is protected by the applicable laws in the country 
where you are resided and international treaties and conventions on copyright matters.

2. License

A. Under this license, you may: 
        (1) use the Program on only one machine and a single operating system at one time, 
            unless this Agreement specifies otherwise; 
        (2) copy the Program for backup. 
    B. You may not: 
        (1) use, copy, modify, merge, or transfer copies of the Program except as provided in this license; 
        (2) reverse assemble or reverse compile the Program; or 
        (3) sublicense, rent, lease, or assign the Program.

3. Limited Warranty

A. infoSpectrum warrant that the distributed software is free from defects in material and workmanship, assuming normal use,
        for a period of two(2) months from the date of original purchase. 
    B. Except for the express limited warranty set forth above, infoSpectrum grants no other warranties,  express or implied, 
        regarding the distributed materials, their fitness for a particular purpose, their quality or their  merchantability. 
        No oral or written information or advice given by infoSpectrum, its resellers, agents, or employees shall create a warranty.

4. Limitation of Liability

A. infoSpectrum's entire liability and your exclusive remedy shall be, at infoSpectrum's option, either 
           (1) return of the  price paid or
           (2) repair or replacement of the Program that does not meet infoSpectrum's limited warranty and that is returned 
                to infoSpectrum or its authorized representative with a copy of your receipt.
    B. infoSpectrum shall not  be liable for any lost profits, lost savings, or any incidental damages or other consequential 
        economic damages arising out of your use or inability to use such Program, even if infoSpectrum, 
        or its authorized representative, has been advised of the possibility of such damages. 
        infoSpectrum shall not be liable for any damages claimed by you based on any third party claim.

5. General

A. infoSpectrum may terminate your license if you fail to comply with the terms and conditions of this Agreement.
        In either event, you must destroy all your copies of the Program.
    B. This Agreement is governed by U.S. federal law or the laws of the State of Maine, without regard to the conflicts of law
        provisions, and you hereby consent to the exclusive jurisdiction of the state and federal courts sitting in the State of Maine.
    C. If you have any questions regarding this Agreement, you may contact infoSpectrum at the address below: 
         www.infospectruminc.com

6. Other Licensing Terms

A. Some of the tools deployed in the Program are public domain, others are covered by the following license terms:                   
              (1) The Code Project Open License (CPOL 1.02) published by The Code Project.  Its main points subject  to the terms of
                    the license are: 
                       - Executable Files can be used in commercial applications; 
                       - Executable Files can be redistributed and Source Code can be modified to create derivative works.                     
                       - No claim of suitability, guarantee, or any warranty whatsoever is provided. The software is provided "as-is".                           
               (2) BSD License - Terms at http://www.opensource.org/licenses/bsd-license.php 
               (3) GNU GPL - Terms at http://www.opensource.org/licenses/gpl-2.0.php

 

Uninstalling eBirdMail

In time, you may want to install a new version of the application or uninstall eBirdMail.

Navigate to the Control Panel item to Add or Remove Programs then click on the Remove button for eBirdMail.


infoSpectrum Inc.
infoSpectrum Inc. © 2010-2011 Trademarks belong to their respective owners.
All rights reserved.