Stockholm den den 12 oktober 2005
Contents
1. lt summary gt Gets whether the source supports importing lists lt summary gt public bool SupportsImport get return false lt summary gt Gets the name of the source lt summary gt public string Name get return StarCommunity lt summary gt Import recipients not supported for this source lt summary gt lt param name name gt lt param gt lt param name importDelegate gt lt param gt lt param name site gt lt param gt lt returns gt lt returns gt public RecipientContainer ImportRecipients string name RecipientImportDelegate importDelegate StarSuite Core Modules ISite site Hd return null lt summary gt Gets all RecipientContainers for a specific site lt summary gt param name site gt The site lt param gt lt returns gt The RecipientContainers belonging to this site lt returns gt public RecipientContainerCollection GetRecipientContainers StarSuite Core Modules ISite site 1 RecipientContainerCollection all GetAllRecipientContainers RecipientContainerCollection rcc new RecipientContainerCollection foreach RecipientContainer rc in all if rc Site null amp amp site null if rc Site ID site ID rcc Add rc if rc Site null amp amp site null rcc Add rc return rcc summary2. maildata html Hi 8a8 b lt br gt br Here is the content of the i email or Newsletter lt i gt br Your title is c lt html gt endofmaildata In the example above variables are being used The variables are inserted in the email by writing before the variable name for example a The variables are assigned names automatically a b c etc Below are two examples of how the resulting email from the example would look like to the end user Email 1 Hi Andreas Stjernstrom Here is the content of the email or Newsletter Your title is Partner Manager Email 2 Hi Gustav Lagercrantz Here is the content of the email or Newsletter Your title is CEO Mail Data Text The part of the order mail named maildata works the same way as Maildata exept that the content could not be html The maildata is only delivered to the email addresses in the order mail textaddr maildatatext Hi a Here is the content of the email or Newsletter endofmaildatatext Email addresses and variables In the part of the order mail named htmladdr and textaddr the addresses and variables for the distribution is included One row for each recipient containing email addresses and attribute values separated by semicolon htmladdr emailAGnetstar se Andreas Stjernstr m Partner Manager 9 31 V StarMail emailBGnetstar se Gustav Lagercrantz
3. StarMail is powerful software for distribution of emails and newsletters StarMail is designed to handle very large numbers of email recipients StarMail consists of a client administration part and a server part both of which are described in this Technical Manual In the client part the StarMail Editor the email or newsletter is created and the distribution is initiated An order email with content and recipient data is sent to our dedicated StarMail Server Cluster This cluster of servers then distributes the emails or newsletters without consuming valuable power from the sender s IT environment Detailed real time statistics for each newsletter is available gt AG a StarMail StarMail Distribution Editor Server Cluster P Statistics e The web based StarMail Editor is where the message is created HTML mails can be composed by using the built in html editor or by selecting a page already created in EPiServer DocStar or by providing a URL e An order email is sent to the StarMail Broker which calculates the most efficient way to distribute the message to the recipients via the servers in its cluster considering current load and queue length for each distribution server Managing and creating recipients lists From a developers perspective all recipient sources inherits and implements the IRecipientSource Interface Each recipient source can provide any number of recipient lists of the type RecipientContainer
4. Magnus Lindberg haren iv iv 19 31 StarMail Web Sites This section gives users and groups rights to view and do changes below the Web Sites section in System Settings Adding and removing groups and users works in the same way as the other access right sections G Administrate 2 Security At the security page the administrator can give users and groups general security rights This includes adding changing and removing other users and groups i Access Rights for Security Management Search E iil E si Bi E T3 Remove 2 20 31 V StarMail 5 8 Site Partitioning Below the web sites header new websites can be created as well as existing ones updated f Soves Accem Bitte Name Sweden Hostname Alias demo netstar se x The administrator can choose new and the default language to use on the site Hostnames are added by typing a name in the Hostname Alias textbox followed by clicking on the Add Alias button The Access Rights tab lets the administrator set what groups and users are allowed to operate on this site The access rights available are Read Create Change Remove and Administrate 21 31 I StarMail 5 4 Globalization The globalization section allows the administrator to translate texts in order to have web pages
5. foreach RecipientContainer rc in rcc if mame rc Name return rc return null lt summary gt Remove a RecipientContainer by its ID this is not supported for this lt summary gt 28 31 StarMail lt param name containerId gt The RecipientContainer s ID lt param gt public void RemoveRecipientContainer Guid containerId endregion IRecipientSource return Can t remove this list region methods lt summary gt Gets all recipient containers lt summary gt returns returns private RecipientContainerCollection GetAllRecipientContainers using DbDataReader reader DatabaseHandler GetReader spStarMailGetStarCommunitySites container RecipientContainerCollection rcc new RecipientContainerCollection while reader Read int siteId int recipientCount string name if reader IsDBNull 0 siteId 1 recipientCount GetRecipientCountBySite null name All users else siteId reader GetInt32 0 Site site StarSuite Core SiteHandler GetSite siteId if site null break if SC Security IUser SC Core StarCommunitySystem CurrentContext DefaultSecurity NewUser GetAttribute m subscriptionUserAttributeName site null break recipientCount GetRecipientCountBySite site name All users on site Name rcc Add new RecipientContainer reader GetGuid 1 name re
6. lt recipient gt lt recipient gt lt email gt email3 mail com lt email gt lt attributeList gt attribute id 1 sattribute value for attr 1 lt attribute gt attribute id 2 sattribute value for attr 2 lt attribute gt attribute id 3 sattribute value for attr 3 lt attribute gt lt attributeList gt lt recipient gt lt starMailImport gt 3 Order Mail The distribution is initiated when the StarMail Server cluster receives an order mail The order mail is created either according to below specification or with the StarMail Editor the client part of StarMail The order mail includes the actual email content subject sender information recipients and etc The order mail is sent to account starmail netstar se 7 31 V StarMail 3 1 Specification of StarMail Order Mail 2 0 Below is a an example and specification of an order mail that complies to StarMail Order Mail Version 2 0 options subject Subject Text sender name domain com sendername The Name guid 1e5693f 49b0 40f7 b526 8d3befc02ebc senddate 2006 12 30 24 30 endofoptions maildata html Hi 8a8 b lt br gt br Here is the content of the lt i gt email or Newsletter lt i gt br Your title is c lt html gt endofmaildata maildatatext Hi a Here is the content of the email or Newsletter endofmaildatatext htmladdr emailAGnetsta
7. Gets all global RecipientContainers summary returns The RecipientContainers lt returns gt public RecipientContainerCollection GetRecipientContainers return GetRecipientContainers null lt summary gt 26 31 StarMail Gets a Recipient by its ID lt summary gt lt param name guid gt The Recipient ID lt param gt xeturns The Recipient lt returns gt public Recipient GetRecipient Guid guid RecipientContainerCollection all GetAllRecipientContainers We have to check for this guid in each recipient container foreach RecipientContainer re in all SC Queries UserQuery uq new SC Queries UserQuery SC Queries StringCriterion starMailUserGuid new SC Queries StringCriterion starMailUserGuid Value guid ToString ug StarMailUserGuid rc Site starMailUserGuid StarSuite Core Modules Security UserCollection uc SC Core StarCommunitySystem CurrentContext DefaultSecurity GetQueryResult uq if uc Count gt 0 SC Security IUser u SC Security IUser uc 0 return GetRecipient u rc return null lt summary gt Gets the Recipients in specified RecipientContainer lt summary gt lt param name container gt The RecipientContainer lt param gt returns The Recipients lt returns gt public RecipientCollection GetRecipients RecipientContainer container bool isInTransaction DatabaseHandler InTransact
8. that the CSV file is in UTF 8 format open the file with a regular text editor such as Notepad and save the file again making sure that the file is in UTF 8 format Save As Save in Recipients Lists Q U Q X amp Toos Nam 4 Storlek Typ 1k8 Microsoft Office Select CSV format StarMail_Demo_List csv Places Save as type CSV Comma delimited csv 6 31 V StarMail 2 3 3 XML An email list can also be imported from an XML file See below for an example of a compatible XML file lt xml version 1 0 encoding utf 8 gt lt starMailImport gt lt attributes gt attribute id 1 gt sattributeNamel lt attribute gt attribute id 2 gt sattributeName2 lt attribute gt attribute id 3 gt sattributeName3 lt attribute gt lt attributes gt lt recipient gt lt email gt emaill mail com lt email gt lt attributeList gt attribute id 1 sattribute value for attr 1 lt attribute gt attribute id 2 sattribute value for attr 2 lt attribute gt attribute id 3 sattribute value for attr 3 lt attribute gt lt attributeList gt lt recipient gt lt recipient gt lt email gt email2 mail com lt email gt lt attributeList gt attribute id 1 sattribute value for attr 1 lt attribute gt attribute id 2 sattribute value for attr 2 lt attribute gt attribute id 3 sattribute value for attr 3 lt attribute gt lt attributeList gt
9. void AddBounces int messageld string emails void AddBounce int messageld string email AddBounces accepts an array of email addresses strings which are to be marked as bouncing The messageld is the version provided in the order mail AddBounce works just like AddBounces but accepts a single email address SOAP details The WSDL specification file for the web service is available at the Netstar partner web site Here are example calls for the web service methods returning bounces for a newsletter using StarMail Order Mail Specification 2 0 or later Example 1a POST Netstar StarMail StarMail asmx HTTP 1 1 Content Type text xml charset utf 8 SOAPAction http netstar se StarMail AddBouncesByGuid lt xml version 1 0 encoding utf 8 gt lt soap Envelope xmlns xsi http www w3 org 2001 XMLSchema instance xmlns xsd http www w3 0rg 2001 XMLSchema xmlns soap http schemas xmlsoap org soap envelope gt lt soap Body gt lt AddBounces xmlns http netstar se StarMail gt lt messagelId gt f1e5693f 49b0 40 7 b526 8d3befc02ebc lt messageld gt lt emails gt lt string gt emaill domain com lt string gt lt string gt email2 domain com lt string gt lt emails gt lt AddBounces gt lt soap Body gt lt soap Envelope gt Example 1b POST Netstar StarMail StarMail asmx HTTP 1 1 Content Type text xml charset utf 8 SOAPAction http netstar se StarMail AddBounceByGuid lt xml version
10. xml version 1 0 encoding utf 8 gt lt soap Envelope xmlns xsi http www w3 0rg 2001 XMLSchema instance xmlns xgd http www w3 0rg 2001 XMLSchema xmlns soap http schemas xmlsoap org soap envelope gt goap Body AddBounce xmlns http netstar se StarMail gt messageId 17 messageId lt email gt emaill domain com lt email gt lt AddBounce gt lt soap Body gt lt soap Envelope gt Statistic setup Statistics for number of opened emails and clicks are collected through the Netstar StarMail GoMail aspx page This page has to be publicly available for the statistics collection to work If the StarMail Editor is not used it is necessary to implement such a page to make it possible to get statistics Note that links in the HTML mail will need to be modified to go to this page prior to sending the order mail The gomail page itself should to be set up to log the request and then redirect to the original destination 13 31 V StarMail 4 1 3 What kind of Statistics is it possible to get Opened messages Unique opened messages Unknown Export opened Clicks Export clicks When the messages opened 4 1 4 Bounce Management The StarMail server collects information about emails that bounce not deliverable The information is sent back to the sender using a SOAP Web Service interface It is up to the sender to decide action on e mail addresses that bounce For example if an address bounc
11. 1 0 encoding utf 8 gt lt soap Envelope xmlns xsi http www w3 0rg 2001 XMLSchema instance xmlns xsd http www w3 org 2001 XMLSchema xmlns soap http schemas xmlsoap org soap envelope gt lt soap Body gt lt AddBounce xmlns http netstar se StarMail gt lt messageld gt f1e5693f 49b0 40 7 b526 8d3befc02ebc lt messageld gt lt email gt emaill domain com lt email gt 12 31 V StarMail lt AddBounce gt lt soap Body gt lt soap Envelope gt Here are example calls for the web service methods returning bounces for a newsletter using a StarMail Order Mail Specification prior to 2 0 Example 2a POST Netstar StarMail StarMail asmx HTTP 1 1 Content Type text xml charset utf 8 SOAPAction http netstar se StarMail AddBounces lt xml version 1 0 encoding utf 8 gt lt soap Envelope xmlns xsi http www w3 0rg 2001 XMLSchema instance xmlns xgd http www w3 0rg 2001 XMLSchema xmlns soap http schemas xmlsoap org soap envelope gt lt soap Body gt lt AddBounces xmlns http netstar se StarMail gt messageId 17 messageId emails lt string gt emaill domain com lt string gt lt string gt email2 domain com lt string gt lt emails gt lt AddBounces gt lt soap Body gt lt soap Envelope gt Example 2b POST Netstar StarMail StarMail asmx HTTP 1 1 Content Type text xml charset utf 8 SOAPAction http netstar se StarMail AddBounce lt
12. 1 1 SOAP detalls ERREUR GERA ANS ERBRINGEN 4 1 2 Statistic setup 4 1 3 What kind of Statistics is it possible to Get esssssscssescesesecssescsssscssesesssescssssessssesseeecsseeesseees 14 4 1 4 sfeltlste Mi Ihrem 14 4 2 StarMail Configuration File sesssssssssssssecssecssscsseccssccssccssccssscsseccssecssscssceesccessccssecensecusecsseesseecsecssecsneeeseessseesse 14 EyychpeIljeereet D RR M 16 5 1 Users and BUE ECL oo RR 16 5 2 Administrative WES oec n Ieri trreE er SERES SEEN eir ea RETE E 18 5 3 Site Partitioning ct 21 5 4 Ga Dal Z eat OA m aii 22 5 5 Ere A 23 PRREGUIFGMVGMIES ER 24 6 1 Knowledge 24 6 2 SYSTSMITEQUIFEMEMtS sesssncsscassesescsssecaserooessoensashesincsossssascudascissbacanuesetoncoosaouactisetuseondsuassasteodncboecbeancasutdissousanuosebesduse 24 Related Product QR 24 Help us get better iscascessssssacaistsasCssssicveccsectssdsssstessdensasuetdabnesecesessosescodeendateagesnstbevecoddebascussndayeco anpadecabecesiedeivosessodecodateagiGaitoesseoys 24 Appendix 1 StarCommunity Source Sample Code sessssssssssssecssecsseesssecssecsecsseseseecssecsecssecsuecesecessecsseessecsseessseess 25 2 31 I NS StarMail 1 2 About StarMail
13. 3FwLvAOiEDuAS5 M3Q6kn7Srdz VhWURfB4CwoZkdgDv5t2 wY2tRRHAb33V1 qiJ7ZB20Cuuj566LdY gIfJod3PSOIOE8VpOql1pPeof09U700QHZK1f974BvB jcVm4TCM5vR7G8hBZROTAqf2rkNmby3BNAqkxpJUnB9VSR6iec XSLsisQZ390eU2KAYgspLfi81 TyxGAChyT ar6Ao8MQHuapmkXG IYANNMBAA20RP61UVrCAINfVTjjTRu5U5hMYqKBA4btc3JPj9 XgRtpMSZ n961lwuy3uXPFK8 6dWR1pOSNF6r u NB53wgmwrrWdsurYYsxCnE8 1gvK1CoPgKkFk 4hVBmuFytGem Xuv3aDyAlENtTgz7UV DB2m3L64e6b1V4AukChzTUZXQmHejHfL21SXzbBW1 zY AigpyhZke20LB66ndlMgb jm8S5teftK11pUnqKGd7 017eQa47jMBdznZ2U1MDhnYcGxDJd44J OkW smhRG3 LrFDKf COYIHtQRCw30kXnL4TMj xub61V9U AoknbamgXV1cgaUM3 FKIR5Y3HayfGY uUiOQI3 PDEUSE4vSU lt Modulus gt lt Exponent gt AQAB lt Exponent gt lt RSAKeyValue gt lt BrokerPublickey gt lt StarMail gt lt SettingsData gt 15 31 INE StarMail 5 System Settings Here the StarMail administrator can create and remove groups or users that can help to administrate the StarMail DocStar System Settings StarStats StarCommunity StarMail System Settings S Groups Users 8 SJ Administrative Access Rights SJ Modules SJ Web Sites ag cova a 3g Groups Users S Add User IA Add Group a Search Group User B Administrative Access Rights 36 Modules EE starMail StarStats ED StarCommunity DocStar 36 Web Sites a New Web Site When System Settings is activated the following menu is E Man SES Norway displayed sweden a Test 36 Globalization Add Globaliza
14. CEO emailC netstar se Elvis Presley The King emailDGnetstar se Tiger Woods Golf Pro endofhtmladdr textaddr emailEGnetstar se Andreas Stjernstr m Partner Manager emailFGnetstar se Gustav Lagercrantz CEO emailG netstar se Elvis Presley The King emailHGnetstar se Tiger Woods Golf Pro endoftextaddr Below illustrates how the variables for the recipient on the first row are interpreted Email address emailAGnetstar se Variable A a Andreas Variable B b Stjernstr m Variable C c Partner Manager 3 1 5 Encryption StarMail Order Mail Specification 2 0 is introducing support for RSA AES based encryption If the BrokerPublicKey parameter in StarMail config contains a valid public key at StarMail Editor initialization all outgoing order mails are encrypted Here is an example of an encrypted ordermail Version StarMail Client 4 1 0 0 cCdRBVOS7uTf0MdUi0Q PF6BOR9Lm3AiO01nYuvRhDlghOhDjCIvDllrFx5Ixkwps bonMFg3neHIO LvTtokpdxefTO avb3Rsbp1Zsa7ngD2xHUPyvu6 A0Tefniu G Ihob9 903 Jwwj CHE AC76Ka7J 1 9XcMafTYeiHUCN27NU646cCGkN3bbZGzdAWstOt XXvu6jAMiAcASbJRIRN2X6wBe2fTO6hjgOT 89ewNKg3Ks2 4 d gtvM55EsbnHiONksVV6NbR5OPAOYSP2PYUJ3NLX6xWzHKBPhBaFUYFxhtqcyGe rulX3XKQP DNpqYdnMdlwovZxcW kSl1EJWQOqvTmo2dQQV1FYLwlDNkLsuuVwizRBrMJ9k ZO5tP B95FnlNESpgz EP5OYd4 49Di xaTArE3DOmn87x1XYgXMRdemuhKn36D1kcGziPep59KzX1JtOuc HMzkZB0s jxifU9pi2Q0Wa7wl16AgcNxebhBPtPUWj0J5l4ChwuZiFFOCGFfXcildM21j JOGvlVb6 Sq7E 9
15. One implementation that supports recipient list import is included with StarMail Editor and does not need to be implemented by the developer This recipient source is called Standard and is used whenever a list is to be imported 3 31 V StarMail Source Standard X Web site Deal I Name Created Current number of recipients StarMail demo 9 25 2006 7 53AM 23 Name of list Import File xml or txt However in many cases there is need for dynamic recipient lists to integrate StarMail with an existing system where the recipient information resides Most commonly such a list is generated by database queries To do this you need to implement the IRecipientSource Interface Description of this and samples can be found in section 2 2 2 1 1 Site Partitioning For larger organizations it is possible to create different sites that selected users or groups can be given access to See the section System Settings User and user groups 2 2 Source Recipient List To implement your own recipient source you need to implement the IRecipientSource interface 2 2 1 Recipient class The Recipient class is defined in the StarMail Core namespace The Recipient class defines the following public properties e Guid ID The unique identifier of the recipient e string Email The email address of the recipient e AttributeCollection Attributes The collection of
16. V StarMail StarMail 4 1 0 Technical Manual e e e e e e Efficient e mail communication with your Target Group StarMail 4 1 0 Technical Manual v1 0 Copyright 2007 Netstar AB Netstar AB Box 3415 103 68 Stockholm Sweden Phone 46 0 8 5000 98 70 Fax 46 0 8 5000 98 71 products netstar se www netstar se gt NETSTAR V StarMail Table of Content Oo QM AOU isi Inu le Managing and creating recipients lists 2 1 1 Site Partitioning sss 2 2 Source Recipient List sse 2 2 1 Recipient class sss 2 2 2 RecipientContainer class 2 2 3 Creating a Source sss 2 2 4 Sample Code sss 2 3 Standard Recipient List 2 3 1 MITA DOME m 2 3 2 CSV FIGS eecseessseccseccnsecsseesscccssecsscessscsseeesses 2 3 3 XM eau 3 1 Specification of StarMail Order Mail 2 0 3 1 1 Options eter eig es 3 1 2 Mail hata AT ML 3 1 3 MEIBPEICHI uU E 3 1 4 Email addresses and variables wie 3 1 5 MEY eIde n 3 1 6 Headers Statistics ccccesesessesesesssssssesseees 4 1 WEB ESCIV ICE EE 2 4
17. aHTXwi5LUS3MocGhTCak6503jFzmXOsFq C28j IGAzdkd78MTFdzTSgoT sP3XWeUqVSiQ gVrt9aZQJXVK30qX9kdQwHvZeKnrtfXqPDi7sexw4Aze3ElrZA5eZcPNafSzVzQBXngKI3d9SUA ObsOgnvN3OmHEKkvmrtSARwLbJb8aPkvpjBHXbJ HWlLK2KExk 4 cHFmuOvg6Z 4Rjqb65AZG3CN3v eyyiegjyATSLdJO0Kusn6EPHGowcbnG T75y45jcIOhX8qIIOhWTl1qtPfMjyhFlgPRJvJyiT8ONLr bmffCSWwYWuUI5TSgaCmrZJ4Oy5SiKaoaQN Px51q8M93kMO8DWM5tMPNbmMRa6XaRZTshhEex U KispOOdT1A6THEjcrs5m 0Yufy3rgwOgOp60L4aZGyRlifhEKlc2409FKnD Dnma69C9m61WYm2 AqGPzf9at Vv5eEdZcgUkWrMKGCvSrXMbCS7DOPFQwPhPVstMe6xkFA2amY LOQtm4IXFl1EwOF8xx ndg pWRXLzFqfYl9sxquVZX2eEJgd7KdINghyg9RnL1COQ secet END ORDERMAIL MESSAGE 10 31 V StarMail 3 1 6 giLwNtgaVxYyspoYsjLt74 XfALLwm9JSXN8Z6Ynzf42LC4Xcirln oktg4fjDBgFwdgpqu6imOx vM GyrDaE9Ebzf9460WvFdM4nmWxKpZX ZPLOCDXhO yg6nOupzkAOnhQOR5hUEaPtg4Bwt6uUf7c k1tM dx0Kjk8k0L1p11WaRjWZdWP 5jdtUrg0aYIVLT6pbbWPhhP Y9wrdKIEkrhPci 0ow0wi7E e vN62dcFTyej i2i0Ywk9ZbEmiVpqukKyDYPJMNy1h GrNOU rIbdJMbYkXSY204esowyuHDOkw cOKxfrjvUVK116HLL18KzxhQbL5AIOEvQ9JO0sC5F Ar697BU6XmDE3ETiC4 n9cg9E8sSaJwv9WVq SCKBburloOgiLQO9G8NGVYaJ3Z28EDIglQBExcFOtOfbeHjolQaJ20BglrQJimzwvkOz 4otp jFngL uKq J4j3wJmx3nEW5fT3XqTIRKVftsPBWwJgAlcjcIjqgXuVLkqESGNKf 4XjDuTwW1SSyXZbPVwxzc dbwsemSylmI6enFaW 60H3108cuKXUihDRAH JCelLnPBUKq8hqt7uDd6rA5oFWJuSPA45O08UxLr Z94fm2AZny Y6memYcORjhXvTYliWE5xaVtjvSvcx 2F2HMctg2Lf1XJ3tilvI IBPmMAlrrtIo cGIC2K8B3ZnMzGy5Lqt3JlYbsfMXB7N T LOi6Jzlt2zHkISQN Ej60OwZ5 4mmgWG oXDdbhnhGVJ M9PV6dzJ
18. ary gt Handles removed sites lt summary gt lt param name args gt lt param gt private void SiteHandler SiteRemoved SiteEventArgs args bool isInTransaction DatabaseHandler InTransaction if isInTransaction DatabaseHandler BeginTransaction try DatabaseHandler ExecuteNonQuery spStarMailRemoveStarCommunitySiteSource args Site ID m_subscriptionUserAttributeName if isInTransaction DatabaseHandler Commit catch Exception if isInTransaction DatabaseHandler Rollback throw endregion methods 31 31
19. attributes of the recipient These attributes are used for substitution of variables in the mail body The variables in the mail body must be in the format a b c etc and are substituted by the corresponding attribute where the order of attributes in the attribute collection coincides with the alphabetic order of the variable name e boollsUnsubscribed Gets whether the user has been marked as unsubscribed e Guid Containerld Gets the unique identifier of the RecipientContainer that this Recipient is connected to 4 31 V StarMail 2 2 2 2 2 3 2 2 4 RecipientContainer class The RecipientContainer class represents a specific list of recipients One of the properties of a RecipientContainer is an implementation of the IRecipientSource interface that the RecipientContainer was provided by Creating a Source This section describes the properties and methods defined in the IRecipientSource Interface in the StarMail Core namespace that needs to be implemented e Guid ID The unique identifier for this source This must be constant for any given source e bool SupportsImport In most cases false since an implementation that supports this is already shipped with the StarMail Editor Standard source e string Name The name of this source This must be constant for any given source e RecipientContainer ImportRecipients If Supportslmport is set to false the implementation should just r
20. available in several different languages At the Find Translation tab the administrator can search for language keys and edit or remove them New keys can easily be added on the Add Key tab To edit an existing key search for the key and click on its name Find Translation AddKey Wadaten arom toga Search Result 1 Ix x x x x xix x x xix x x x x x x x After having clicked on a key the popup window is displayed as shown on the screenshot below This page displays the languages that the key has been translated to Texts can be changed and languages can be added or removed Edit Globalization Key StarCommunity AtAGlance AvailableStatistics Add Add Language Swedish Tilg nglig statistik x English Available statistics x 22 31 V StarMail 5 5 Licensing The Active License page contains information that is specific for your license It lists all products and their modules that are installed on your system The license has restrictions for maximum number of sites the administrator can create and maximum number of users that can register on the community It also contains an expiration date for the whole license as well as IP restrictions on the servers that are hosting the system 23 31 V StarMail 6 6 1 6 2 Requirements Kno
21. checkbox Access followed by Save To remove a user or group click Remove followed by Save li Access Rights for Netstar Products Administration Search For m x _search_ Administrators testarupp Admin User admin A Sti m A MN Hans Leijstr m hans aa aad Baa bad Mattias Nordbera praducts netstar se add ESI s aad bad E Magnus Lindberg Haren Inexor Demo inexor Egg E Maria H ggkvist MariaMusic i D I I I I I B B B i i Groups Users Access ij Administrators Iv SJ Maria H ggkvist MariaMusic v amp Tomas Admin tomasadmin v 18 31 v StarMail System Settings The System Settings section contains the members and groups that have access to view the System Settings part of Netstar Product Administration Users and groups can be added and removed in the same way as in the Administration section Access Rights for System Settings Search For far _search_ i Administrators E testarupp EJ Admin User admin amp Andreas Stjernstr m andreas S3 Hans Leijstr m hans G3 Mattias Nordbera products netstar se BJ Magnus Lindberg Haren GJ Inexor Demo inexor S Maria H ggkvist MarisMusic lE E E E lE lE E E E E amp 4 Tomas Admin tomasadmin Groups Users Read Change Administrators v 2
22. cipientCount m id DateTime Now siteId Feturn rcc summary Gets a Recipient by StarCommunity User and RecipientContainer lt summary gt lt param name user gt lt param gt lt param name container gt lt param gt lt returns gt lt returns gt private Recipient GetRecipient SC Security IUser user RecipientContainer AttributeCollection ac new AttributeCollection ac Add new StarMail Core Attribute First name user GivenName ac Add new StarMail Core Attribute Last name user SurName bool unsubscribed luser GetAttributeValue bool m subscriptionUserAttributeName container Site string userGuid user GetAttributeValue lt string gt StarMailUserGuid container Site if userGuid null 29 31 StarMail Recipient r new Recipient new Guid userGuid user EMail unsubscribed container ID ac return ry else return null lt summary gt Gets Recipient count by Site lt summary gt lt param name site gt lt param gt returns returns private int GetRecipientCountBySite Site site SC Queries UserQuery uq new SC Queries UserQuery SC Queries BooleanCriterion subscriptionCriterion new SC Queries BooleanCriterion subscriptionCriterion Value true ug m subscriptionUserAttributeName site subscriptionCriterion int count 0 StarSuite Core Modules Sec
23. es more than two times it could be removed from the recipient list When using the StarMail Editor and its built in bounce reporting system bounces are recorded in the table tblStarMailBounce 4 2 StarMail Configuration File The data in the configuration file is created when installing StarMail To change the StarMail configuration after the installation it can be done in the StarMail Configuration file The configuration file is located at Netstar StarMail StarMail config Below is an example of a StarMail configuration file lt xml version 1 0 standalone yes gt lt SettingsData xmlns http netstar se StarMail SettingsData xsd gt lt StarMail gt lt BrokerAddress gt broker starmail netstar se lt BrokerAddress gt lt DefaultFromAddress gt noreply domain com lt DefaultFromAddress gt DefaultFromName StarMail Sender Name lt DefaultFromName gt GoMailURL http www domain com Netstar StarMail GoMail aspx GoMailURL lt StarMailFromAddress gt name domain com lt StarMailFromAddress gt lt MailServer gt smtp domain se lt MailServer gt GoMaillmageURL http www domain com Netstar StarMail Images pixel gif Go MailImageURL gt lt Encoding gt iso 8859 1 lt Encoding gt lt BrokerIP gt 195 178 179 55 lt BrokerIP gt 14 31 V StarMail BrokerPublicKey lt RSAKeyValue gt lt Modulus gt zG5Z4RaYhz5Grx1b HVRWG2zzuGMECzngy1 OMmbOts0iZyirrZZ1P69B30h8xZJKA Z smE7WWx31uPasRmP2bWe9OTGbF1
24. eturn null e RecipientContainerCollection GetRecipientContainers should return a recipient container collection If the provided Site is not applicable return your list of RecipientContainers when the Site is null e Recipient GetRecipient Should return the recipient for the supplied Guid e RecipientCollection GetRecipients Should return the recipients for the supplied RecipientContainer e void UnsubcribeRecipient Unsubscribes or re subscribes the supplied recipient e RecipientContainer GetRecipientContainer Should return the recipient container with the supplied Guid or name e void RemoveRecipientContainer Should remove a recipient container with the supplied guid If removal of RecipientContainers is not supported just return The compiled assembly should be put in the bin directory on the web server Sample Code When running StarMail together with StarCommunity or EPiServer 4 x there are options to install implementations of IRecipientSource for these during the StarMail Installation The StarCommunity source selects all current StarCommunity users with the subscription user attribute set The name of the attribute can be specified in the configuration file The EPiServer source selects all current EPiServer users The sample code in appendix 1 is an excerpt from the StarCommunity source When creating your own sources you may want to start by modifying the GetRecipients method If you are running StarCommunity y
25. iKBjCZqghCKiw6ugkemqwofM48herk7CzsMaQ3u pvO0G2j sB1Tq8AeOx OPhQOk eVOs 6LO2T9iEIdywAA4K09gWyuxwxMa7bAwOuKZMzweYvcfZ tV14P3wNjNicfpop6ew7dss9RDEOAVtp GIy3Mnfdjgg5JOSIBH2iwO2ySwBpTSCSKe8Yh VdlOKPy2ObkAdA3113u2kP jWFTN8GM61QcAyh zh8GnOLSsIfhduuBJHlrtaOYgRza6NwQa9MDD17700iompsORgG9nfX56kEXOabl3151ElnOlcek qtWtZJpGbkdpZ19HdKH6hiVyfhAsm0O1H dXlWLAOSqOBQtAC7QS9mgepSBM7TqmJ 0W2mj emuBK7 a7a0V310710ho6rA2XDL50W8QwzMBWzIejPl1fFOE65AWDqYOOoWSN9W6GNeNIwbD8fVmp53LCGdr EdV6 0B3QDQfKNBhvhOVvS PqoUg1 EYKOLBbTxF 90ynSQpnLmQoh3UmI LRWND2063MKiGHbznRZW7L b 8zplY7gccjGWrOA4gRPhW82Fv QpVhOo929fUnPorexXGzc2dMrhJugjaRDNIWmIhFeBv5KUj0 StarMail creates a unique symmetric key and uses it to encrypt the ordermail content found starting at BEGIN ORDERMAIL MESSAGE The symmetric key and initialization vector is then encypted with the custom public RSA key of the StarMail installation and supplies it for decryption on the server side as shown in example above Headers From StarMail Order Mail Specification 2 0 version number is defined in the mail header as parameter StarMail OrderMail Version 11 31 V StarMail 4 4 1 4 1 1 Statistics Web service The Web Service section is only for systems that do not have the Starmail Editor installed If you are not using the StarMail Editor but want to handle bounces you need to implement the following to web service methods which are called from the StarMail Server Cluster
26. ion if isInTransaction DatabaseHandler BeginTransaction try DatabaseHandler ExecuteNonQuery true spStarMailUpdateStarCommunityUserGuids container Site null object container Site ID null m_subscriptionUserAttributeName SC Queries UserQuery uq new SC Queries UserQuery SC Queries BooleanCriterion subscriptionCriterion new SC Queries BooleanCriterion subscriptionCriterion Value true ug m subscriptionUserAttributeName container Site subscriptionCriterion StarSuite Core Modules Security UserCollection uc SC Core StarCommunitySystem CurrentContext DefaultSecurity GetQueryResult uq RecipientCollection rc new RecipientCollection foreach SC Security IUser u in uc Recipient r GetRecipient u container if r null rc Add r return rc if isInTransaction DatabaseHandler Commit catch Exception if isInTransaction DatabaseHandler Rollback throw 27 31 StarMail lt summary gt Sets unsubscribed status for specified Recipient lt summary gt lt param name recipient gt The Recipient lt param gt lt param name isUnsubscribed gt Whether the Recipient should be unsubscribed lt param gt public void UnsubcribeRecipient Recipient recipient bool isUnsubscribed RecipientContainer container GetRecipientContainer recipient ContainerId SC Queries UserQuery uq new SC Queries UserQue
27. ou can use the user search handler to get the recipients as in the sample However you can of course create customized database queries to get recipients from any database or other data source accessible 5 31 V StarMail 2 3 2 3 1 2 3 2 Standard Recipient List Import StarMail can import E mail address lists from XML and CSV text files semi colon separated CSV files Most common is importing Email lists from Excel When importing email addresses from Microsoft Excel the file needs to be saved in a specific format Please see instructions below A a C D 1 E mail Name Sur Name Title 2 jemailA netstarse Andreas Stjernstr m Partner Manager 3 emailB gnetstar se Gustav Lagercrantz CEO 4 emailC gnetstarse X Elvis Presley The King 5 emailD gdomain com Tiger Woods Golf Pro 6 7 a The first row is a header row and is not imported to StarMail The first column is always used as the email address It is possible to import a list that consists of only one column with email addresses In the example above there are additional columns with variables such as Name Sur Name and Title These variables can be used for different needs and are used to personalize each email sent from StarMail StarMail handles up to 20 variables for each recipient list Save the Excel sheet as a CSV file Semi colon delimited and make sure that the file has the format UTF 8 If it is not possible to make sure
28. r se Andreas Stjernstr m Partner Manager emailBGnetstar se Gustav Lagercrantz CEO emailC netstar se Elvis Presley The King emailDGnetstar se Tiger Woods Golf Pro endofhtmladdr textaddr emailEGnetstar se Andreas Stjernstr m Partner Manager emailFGnetstar se Gustav Lagercrantz CEO emailG netstar se Elvis Presley The King emailH netstar se Tiger Woods Golf Pro endoftextaddr 3 1 1 Options In the part of the order mail named Options following parameters could be set options subject Subject Text sender Name domain com sendername Name guid f1e5693f 49b0 40f7 b526 8d3befc02ebc senddate 2006 12 30 24 30 charset iso 8859 1 endofoptions Subject sets the Subject text for the message Sender Sets the sender E mail adress Sendername Sets the name of the sender GUID sets the Globally Unique Identifier of the specific newsletter to prevent the same mail from being sent out more then once This replaces the deprecated option Version 8 31 V StarMail Senddate sets when the distribution starts With this setting it is possible to schedule a distribution Format for senddate is YYYY MM DD HH MM Setting this is optional the entire row should be excluded if not used Mail data HTML In the part of the order mail named maildata the content of the mail is included The maildata is only delivered to the email addresses in the order mail htmladdr
29. ry SC Queries StringCriterion starMailUserGuid new SC Queries StringCriterion starMailUserGuid Value recipient ID ToString ug StarMailUserGuid container Site starMailUserGuid StarSuite Core Modules Security UserCollection uc SC Core StarCommunitySystem CurrentContext DefaultSecurity GetQueryResult uq true source if uc Count gt 0 SC Security IUser u SC Security IUser uc 0 if isUnsubscribed u SetAttributeValue bool m subscriptionUserAttributeName container Site false else u SetAttributeValue bool m subscriptionUserAttributeName container Site SC Core StarCommunitySystem CurrentContext DefaultSecurity UpdateUser u summary Gets a RecipientContainer by its ID summary param name guid gt The RecipientContainer s ID lt param gt returns The RecipientContainer lt returns gt public RecipientContainer GetRecipientContainer Guid guid RecipientContainerCollection rcc GetAllRecipientContainers foreach RecipientContainer rc in rcc if guid rc ID return rc return null lt summary gt Gets a RecipientContainer by its name lt summary gt lt param name name gt The RecipientContainer s name lt param gt returns The RecipientContainer lt returns gt public RecipientContainer GetRecipientContainer string name RecipientContainerCollection rcc GetAllRecipientContainers
30. tSource private Guid m_id private string m subscriptionUserAttributeName public StarCommunitySource m_id new Guid 07A3CA4C EA15 444F 9569 C8B9916E31A2 LoadSettings if string IsNullOrEmpty m_subscriptionUserAttributeName bool hasUserGuidAttribute false bool hasUserSubscribedAttribute false foreach SC Core Modules Attributes IAttribute attribute in SC Core Modules Attributes AttributeHandler GetAttributes typeof SC Core Modules Security IUse r if attribute Name m_subscriptionUserAttributeName hasUserSubscribedAttribute true if attribute Name StarMailUserGuid hasUserGuidAttribute true if hasUserGuidAttribute SC Core Modules Attributes AttributeHandler AddAttribute new SC Core Modules Attributes Attribute StarMailUserGuid typeof SC Core Modules Security IUser typeof string true if hasUserSubscribedAttribute SC Core Modules Attributes AttributeHandler AddAttribute new SC Core Modules Attributes Attribute m subscriptionUserAttributeName typeof SC Core Modules Security IUser typeof bool false StarSuite Core SiteHandler SiteAdded new SiteEventHandler SiteHandler_SiteAdded StarSuite Core SiteHandler SiteRemoved new SiteEventHandler SiteHandler_SiteRemoved region IRecipientSource lt summary gt Gets the source s ID lt summary gt public Guid ID 25 31 StarMail get return m_id
31. tion ag Licensing A Active License 5 1 Users and User Groups Add User In the Add User page you can create a new user with his basic details as well as add him to groups in order to inherit access rights 16 31 User Settings Member Of Available Groups Selected Groups Administrators testgrupp Add Group A group it added by specifying its name Groups can also have child groups that inherit access rights from their parent group Add Group Group Settings fe NN Members Available Groups Selected Child Groups Search At the Search Group User page you can search for both groups and users and remove them if needed 17 31 I S StarMail f Search Group User Search For f Tan zi Y Search Result T E Administrators E testarupp BE Admin User admin amp Andreas Stjernstr m andreas 8J Hans Leijstr m hans 83 Mattias Nordberg products amp netstar se 8J Magnus Lindberg Haren 8J Inexor Demo inexor G4 Maria H amp ggkvist MariaMusic is Tomas Admin in XX xXx xxxxx x 5 2 Administrative rights Administration At the administration part of the access rights section the administrator can give users and groups rights to log in to Netstar Products Administration To add a user or group do a search for its name click on Add check the
32. urity UserCollection uc SC Core StarCommunitySystem CurrentContext DefaultSecurity GetQueryResult uq 1 1 out count return count lt summary gt Help method to load in the settings for this module Will set the static variable upload file path lt summary gt public void LoadSettings SettingsData settings new SettingsData string path System I0O Path Combine AppDomain CurrentDomain BaseDirectory Netstar StarMail StarMailStarCommunitySource config settings ReadxXml path if settings StarMailStarCommunitySource Rows Count gt 0 SettingsData StarMailStarCommunitySourceRow starCommunitySource SettingsData StarMailStarCommunitySourceRow settings StarMailStarCommunitySource Rows 0 m subscriptionUserAttributeName starCommunitySource SubscriptionUserAttributeName lt summary gt Handles added sites lt summary gt lt param name args gt lt param gt private void SiteHandler SiteAdded SiteEventArgs args bool isInTransaction DatabaseHandler InTransaction if isInTransaction DatabaseHandler BeginTransaction try DatabaseHandler ExecuteNonQuery spStarMailAddStarCommunitySiteSource args Site ID m_subscriptionUserAttributeName if isInTransaction DatabaseHandler Commit catch Exception if isInTransaction DatabaseHandler Rollback throw 30 31 StarMail lt summ
33. wledge StarMail requires basic knowledge of using a Internet Explorer Firefox Development experience to implement Recipient Sources System requirements Client side administrators a Internet Explorer 6 Firefox 1 5 Related products Other products from Netstar Products AB from which web and community systems may be based on include StarCommunity software modules used to provide interactivity with target groups a DocStar web content management system used to manage all editorial web pages a StarStats for providing relevant event based statistics to support business decisions Help us get better Please send your comments and feedback on this user manual by email to product _feedback netstar se We also appreciate if you notify us of any errors in this user manual or features you think are not described correctly 24 31 StarMail 9 Appendix 1 StarCommunity Source Sample Code using System using System Data using System Data Common using StarSuite Core using StarSuite Core Data using StarSuite Core Modules using StarMail Core using SC_Queries StarCommunity Core Modules Queries using SC_Security StarCommunity Core Modules Security using SC_Core StarCommunity Core namespace StarMail Sources StarCommunity lt summary gt Basic recipient source for StarCommunity that has a recipient container per site lt summary gt public class StarCommunitySource IRecipien
Download Pdf Manuals
Related Search