Home » Documentation » Sending emails
The Litium Framework contains a messaging component where messaging providers can be implemented for sending emails, sms or other messages. The Scensum release ships with a messaging service with an email message provider implemented as a windows service.
The messaging windows service is located under your Scensum directory in the Tools\Litium.Scensum.Messaging folder.
Note! See Litium.Framework.Messaging for detaild information about messaging implementation
Configure the Messaging Service
The configuration of the messaging service is divied into the windows service config file and the setting xml files.
Messaging config file
Locate the Litium.Scensum.Messaging.exe.config file in the Tools\Litium.Scensum.Messaging folder.
| Messaging.IoCConfigPath |
The path to the implementation to instantiate when using the messaging service. |
| SettingXmlFilePathTemplate |
The messaging service uses the setting files folder (e.g. for the Messaging.Database.xml) from the Scensum installation. This path describes the relative path to the Scensum Setting folder. |
Navigate to the Scensum Settings folder located in the Src\Setting folder.
Messaging.Database.xml
The messaging service uses a seperate database config file which enables the messaging service to be distributed to a seperate database or server.
Messaging.xml
The messaging file contains general settings for the Scensum messaging service.
| NumberOfRecipientsPerSendChunk |
The max number of recipients for each batch in a broadcast email. E.g. a newsletter with 100.000 receipents and a NumberOfRecipientsPerSendChunk = 1000 will be divided into 100 batches. |
Messaging.SmtpEmailSetting.xml
The email message provider is dependent on smtp settings.
| Host |
The smtp server, is by default set to 127.0.0.1 for local development. |
| Port |
The smtp port, by default set to smtp default port number i.e. 25 |
NetworkCredentialUserName,
NetworkCredentialPassword,
NetworkCredentialDomain |
If the smtp server requires network user credentials |
Messaging.MessageSend.xml
Settings for the differnt message types Single, SmallBulk and LargeBulk. Each of the types are executed in seperate threads and can have seperate settings. If no settings are defined for a message type e.g. the LargBulk group is deleted, the values for the Defaut setting will be used.
| SecondsToSleepBetweenSends |
Time to pause between executing the send method in seconds. |
| NumberOfMessagesToSendInBatch |
The number of messages to retreive from the database and execute in the sending thread. |
Messaging.MessageClean.xml
Cleanup settings for the message types.
| SecondsToSleepBetweenClean |
Time to pause between executing the clean method in seconds. |
| HoursBeforeFinishingBatch |
If setting the batch status failed but all internal sendings are set to Completed, this is the timeout time before the batch is set to status Completed. |
| DaysBeforeDeletingBatch |
Number of days to keep batches in status Completed. |
| HoursBeforeResettingStatusFromInProgress |
Number of hours before resetting a message that has been caught in status In progress to Ready to send |
If no settings are explicitly defined for a message type (Single, SmallBulk or LargeBulk) e.g. the LargBulk group is deleted, the values for the Defaut setting will be used.
Install the Messaging Service
The windows service is installed using the InstallUtil command from a visual studio command prompt.
c:> InstallUtil <your scensum directory>\Tools\Litium.Scensum.Messaging\Litium.Scensum.Messaging.exe
Uninstall with the -u switch
c:> InstallUtil -u <your scensum directory>\Tools\Litium.Scensum.Messaging\Litium.Scensum.Messaging.exe
Start the Messaging Service
The messaging service is installed as Litium.Scensum.MessagingService. Locate the service under Control Panel \ Administrative Tools \ Servfces, right click and select Start. The service is now ready to send email.
Designing the email template
The design of the default order confirmation email is specified under Templates in Scensum back office. Navigate to Interface \ Templates \ E-mail \ Order confirmation. The email messaging provider will choose the template defined as default order confirmation template for the channel theme.
Debugging the Messaging Service
The path to the Log4Net log files are set in the Litium.Scensum.Messaging.exe.config file. By defaul ther are set to create a Logs folder in the Messaging Service directory. Inspect the logfiles created for errors.
Comments made
No comments are made
You need to be logged in to make a comment