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).

SendMail/Download: Setting Up Newsletter Instructions (2.0.2670.21174.zip).txt

File Setting Up Newsletter Instructions (2.0.2670.21174.zip).txt, 6.4 KB (added by steve@…, 7 years ago)

2.0 Release of Newsletter module

Line 
1= Installing the Newsletter Module =
2 1. Import the example pages from Admin mode
3    This will import 3 page types, one example newsletter, and the subscribe and unsunscribe pages. No code will be added at this point.
4 1. Add the files from the ExampleTemplates directory to your web site project in Visual Studio in a /newsletter subdirectory. These are the web forms that implements the design and functionality for the newsletter.
5 1. Open SQL Server Manager or another tool that let you run sql script against your EPiServer database.
6 1. Open and execute the combinedcreatescript.sql file. Make sure you run against the correct database.
7 1. Copy the files from the webroot directory into the root of your web folder. This is the runtime files needed by the newsletter module.
8 1. Open the web.config file, and configure the module according to the [wiki:Configuration] page.
9 1. Make sure you have a valid license for the aspNetEmail component. This is included in the purchased version of the newsletter module. (See [wiki:Configuration] for more information.) You can download an evaluation of the aspNetEmail component on [http://www.advancedintellect.com/download.aspx#smtp the Advanced Intellect home page.]
10 1. Open the site, go to Admin mode, select Config tab, System Settings and the Newsletter tab. Click to enable the newsletter functionality.
11
12= Working with the newsletter project in VS =
13The Visual Studio projects use the [wiki:PostBuildEvent Post Build Event] to copy the run-time files to your web project, using  [http://www.eworldui.net/UnleashIt/Default.aspx 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.
14
15You typically need the BVNetwork.EPiSendMail and BVNetwork.EPiSendMail.Data projects loaded if you want to change the core functionality. If you only want to change the layout of the newsletter, you should work directly with the example templates copied into your Visual Studio project (see above).
16
17= Using the Newsletter module =
18== Sending a newsletter ==
19When sending a newsletter, you typically:
20 1. Create the newsletter with content and layout
21 1. Add recipients to the newsletter by using one or more of the available recipient providers.
22 1. Filter the recipient list using one of your block lists.
23 1. Send the newsletter
24
25== Creating a new newsletter ==
26 1. Create a new page of the type Newsletter in a suitable place on the site
27 1. Enter the required fields
28    * Sender Email Address
29     * Subject
30     * Editor
31     * Text Formatted Content
32 1. Save and view the page to preview the newsletter
33 1. Click the "Send email" tab, give the newsletter a name and description, click "Create"
34 1. You should now see the interface for working with the newsletter
35 1. The newsletter should also be available on the plug-in tab in the tree view to the left.
36 
37== Adding recipients to a newsletter ==
38More information coming...
39
40== Filtering recipients ==
41More information coming...
42     
43= Configuration =
44More information coming...
45 * Pagetype id of newsletter
46 * Sendertype
47 * Lisence path
48
49== Example Configuration ==
50#!text/xml
51{{{
52 <!-- Newsletter module settings -->
53 <!-- Master Mail Plug-in availability setting -->
54 <add key="EPfEnableSendMailPlugIn" value="True" />
55 <!-- Default sender address, if missing on page -->
56 <add key="EPsSendMailFromAddress" value="your@address.here" />
57 <!-- The address the report should be sent to. -->
58 <add key="EPsSendMailSendReportMailTo" value="feature.will@be.removed.soon" />
59 <!-- If missing on page, default title to be used -->
60 <add key="EPsSendMailSubject" value="Newsletter" />
61 <!-- Comma separated list of page types where the plug-in should be available. If empty
62       the module will look for a page type called "Newsletter"
63  -->
64 <add key="EPnSendMailPageType" value="" />
65 <!-- A class inheriting from MailSenderBase, responsible for sending the email
66  The MailSenderNetSmtp type is default. You can also use MailSenderAdvIntellect
67  from the same namespace. -->
68 <add key="EPsSendMailSenderType" value="BVNetwork.EPiSendMail.Library.MailSenderAdvIntellect, BVNetwork.EPiSendMail" />
69 <!-- Location of email templates used by the system. Currently, only used for
70  the admin report. You should not change the original templates, but copy
71  and point to the new directory.-->
72 <add key="EPsSendMailTemplateDir" value="~/bvn/sendmail/mailtemplates/" />
73 <!-- The configuration xml file. This is very important for the newsletter
74  functionality, and things will not work without it. Copy this file, and
75  point to the new file here. Note - this feature has been replaced, and will
76  be removed from the code in v2.1 -->
77 <add key="EPsSendMailConfigurationFile" value="~/bvn/sendmail/configuration/newsletterconfiguration.xml" />
78 <!-- The location of the production license file. The root dir will be prepended.
79       Note! This is a filesystem path, not a virtual path. It needs to be relative
80        to the root dir of your site.
81 -->
82 <add key="EPsAspNetEmailRelativeLicensePath" value="newsletter\aspnetemail.xml.lic" />
83 <!-- The (max) number of emails the send task will send each time it runs.
84        If you set the scheduled task to run each minute, and each mail takes one second
85        to send, a value of 50 is optimal.
86 -->
87 <add key="EPnSendMailSendBatchSize" value="50" />
88}}}
89 
90== The Scheduler ==
91Emails are sent as a background job, which means you can do other things while the emails are being sent. This also means that the sending process is less suspectible to timeouts.
92
93You need to find a balance on how often you want the scheduled task to run and how many emails the task should attempt to send in one go.
94
95For an example, if you set the scheduler to run the task each minute, and you have timed the sending process to take approx 1 second per email, a batch size (see the `EPnSendMailSendBatchSize` setting) of 50 is reasonable. It might give you 10 seconds of idle time, but this is a lot better than having the whole process time out or fail because of an error in your ASP.NET hosting environment. If you set the batch size to high, for an example to 70, and it takes 62 seconds to run the task, you will get 58 seconds of idle time between each send. Even if you set the task to run often, it will not start sending new emails if there is already a task that is sending emails. This is done to avoid exhausting the the thread pool.