Loading...

All project content is available for reading, but you need to be a member of the project for Subversion checkout of source code, or to create/modify any information.
Login if you are a member. Apply here to request membership (open to all).

Installing the Newsletter Module

Installing using the EPiServer CMS Manager

For EPiServer CMS 5 R1 and R2, using the EPiServer CMS Manager - Module Installer feature. Please note that you need to install the Zip Module Installer add-on if you want to install for R2. (R2 SP1 includes the module installer).

  1. Download the installation package from the download page
  2. Open EPiServer CMS Manager / Installation Manager, select the site you want to install to
  3. Right click the site, select "Install Module"
  4. Step through the wizard and select the downloaded installation package when asked for the module to install
  5. A browser will open and you need to point to the place in the edit tree where you want the newsletter example pages to be imported (if you're unsure, select the start page - you can always move them later).
  6. Extract the .zip/.epimodule file you have downloaded or grab the database script from the download page
  7. Open SQL Server Manager or another tool that let you run sql script against your EPiServer database.
  8. Open and execute the Newsletter_Install_SqlScript.sql file (the file name might include the version too). Make sure you run against the correct database. (Only SQL Server 2005 and 2008 are supported).
  9. Make sure you have a valid license for the aspNetEmail component. This is included in the purchased version of the newsletter module. (See SendMail/Configuration for more information on how to specify the location of this file.) You can download an evaluation license of the aspNetEmail component on the Advanced Intellect home page.
  10. Open Admin mode, find the Send Newsletter Task scheduled job. Enable the task, set the interval to 1 minute.
  11. The module should now be ready for use. You can find an example newsletter in the page tree under Newsletters.
  12. You should include the files under the /newsletter directory into Visual Studio and start changing the design and layout of the newsletter.aspx file. Please note that the newsletter.aspx has no code-behind file (you can add one if you want to.)

Installing manually

If you want full control of the installation, or want to include the module in your own deployment routines, you can do a manual install.

  1. Download the installation package from the download page and extract the .zip file. If you download the .epimodule file, rename it to .zip and extract the contents.
  2. Import the example pages and pagetypes in the util\install\newsletterpages.episerverdata file from Admin mode This will import 3 page types, one example newsletter, and the subscribe and unsubscribe pages. No code will be added at this point.
  3. Add the bin, bvn, lang and newsletter directories to the root of your web site. Only the newsletter directory needs to be included in your Visual Studio project.
  4. Open SQL Server Manager or another tool that let you run sql script against your EPiServer database.
  5. Open and execute the Newsletter_Install_SqlScript.sql file. Make sure you run against the correct database. (Only SQL Server 2005 and 2008 are supported).
  6. Open the web.config file, and configure the module according to the Configuration page.
  7. Make sure you have a valid license for the aspNetEmail component. This is included in the purchased version of the newsletter module. (See SendMail/Configuration for more information on how to specify the location of this file.) You can download an evaluation license of the aspNetEmail component on the Advanced Intellect home page.
  8. Open Admin mode, find the Send Newsletter Task scheduled job. Enable the task, set the interval to 1 minute.
  9. The module should now be ready for use. You can find an example newsletter in the page tree under Newsletters.
  10. You can include the files under the /newsletter directory into Visual Studio and start changing the design and layout of the newsletter.aspx file. Please note that the newsletter.aspx has no code-behind file (you can add one if you want to.)

The easiest way to see if the module has been successfully installed is to open Edit mode and look for a tab with an envelope next to the "My Tasks" tab.

Working with the newsletter project in VS

The Visual Studio projects use the Post Build Event to copy the run-time files to your web project, using Unleash-It. Make sure you save the .sln file in the root of your EPiServer web site to have the run-time files copied correctly during compilation.

You should add BVNetwork.EPiSendMail and BVNetwork.EPiSendMail.Data to your solution.

Using the Newsletter module

Sending a newsletter

When sending a newsletter, you typically:

  1. Create the newsletter with content and layout
  2. Add recipients to the newsletter by using one or more of the available recipient providers.
  3. Filter the recipient list using one of your block lists.
  4. Send the newsletter

Creating a new newsletter

  1. Create a new page of the type Newsletter in a suitable place on the site
  2. Enter the required fields
    • Sender Email Address
      • Subject
      • Editor
      • Text Formatted Content
  3. Save and view the page to preview the newsletter
  4. Click the "Send email" tab, give the newsletter a name and description, click "Create"
  5. You should now see the interface for working with the newsletter
  6. The newsletter should also be available on the plug-in tab in the tree view to the left.