Developer's Guide - EPiServer World

More documents

Recommendations

Info

116 | Developer’s Guide EPiServer Community 3.1 StarCommunity.Modules.Webmail is described by clicking on their respective names. Make sure you also add the mentioned assemblies as references, as mentioned in section 1.1.1. using StarCommunity.Core; using StarCommunity.Core.Modules.Security; using StarCommunity.Modules.Webmail; Creating the Account To create the account, we get the User for which the account is to be created, and then call the AddMailAccount method in the WebmailHandler, specifying the local part of the address (the part before the “@” sign) to be associated with the new account. Optionally you can also supply a Domain. If no domain is supplied, the one set in the configuration file is used as the default. Domain domain = WebmailHandler.GetDomainByDomainName("my.domain"); IUser user = (IUser)StarCommunitySystem. CurrentContext.DefaultSecurity.GetUser(17); WebmailHandler.AddMailAccount(user, "address.part", domain); The account is now created on the mail server, and incoming messages to this address will be accepted from this point on. It is important to note that the local part of the address has to be unique; it is therefore a good idea to think of some means of making sure that collisions will not occur. For instance, the EPiServer Community username may be used (as that is known to be unique), provided that it does not contain any illegal characters. 2.28.3 Disabling, Reactivating and Permanently Removing Accounts It may be of interest to disable an account for different reasons or to remove an account entirely. For instance, the mail account may be a premium service, which should be disabled if the user stops paying. Another example may be a misbehaving user that should have their account removed. Keep in mind that when a EPiServer Community user is soft-removed, reactivated or permanently removed, these changes also reflect on the user’s mail account automatically, if there is one. © EPiServer AB
Tutorials | 117 Import Necessary Namespaces First, import the necessary namespaces that will be needed for this, the namespaces StarCommunity.Core, StarCommunity.Core.Modules.Security and StarCommunity.Modules.VideoGallery The StarCommunity.Modules.VideoGallery namespace contains classes for creating video galleries and uploading videos for transcoding into a web friendly format, like Adobe Flash Video. StarCommunity.Modules.Webmail are described by clicking on their respective names. Make sure you also add the mentioned assemblies as references, as mentioned in section 1.1.1. using StarCommunity.Core; using StarCommunity.Core.Modules.Security; using StarCommunity.Modules.Webmail; Soft Removing an Account To disable an account, we get the account for the relevant user and call the SoftRemoveMailAccount method in the handler. Note that this is automatically done when soft removing a user in the administration interface. IUser user = (IUser)StarCommunitySystem. CurrentContext.DefaultSecurity.GetUser(17); MailAccount account = WebmailHandler.GetMailAccount(user); WebmailHandler.SoftRemoveMailAccount(account); Now the account has been disabled. This means that no mail can be delivered to it and that you can no longer get mail from this account. Restoring a soft removed account To reactivate a disabled account, we get the account for the relevant user and call the SoftRestoreMailAccount method in the handler. Note that this is automatically done when restoring a user in the administration interface. IUser user = (IUser)StarCommunitySystem. CurrentContext.DefaultSecurity.GetUser(17); MailAccount account = WebmailHandler.GetMailAccount(user); WebmailHandler.SoftRestoreMailAccount(account); Now the account has been restored. Any messages which were there before the account was disabled are now available again. © EPiServer AB
Page 1 and 2:
Release 3.1.0 Developer’s Guide
Page 3 and 4:
Table of Contents | 3 Table of Cont
Page 5 and 6:
Basic Understanding | 5 2.10.5 Addi
Page 7 and 8:
Basic Understanding | 7 1 Basic Und
Page 9 and 10:
Basic Understanding | 9 1.2.2 EPiSe
Page 11 and 12:
Basic Understanding | 11 StarCommun
Page 13 and 14:
Basic Understanding | 13 1.2.4 EPiS
Page 15 and 16:
Basic Understanding | 15 If MyClass
Page 17 and 18:
Basic Understanding | 17 1.3.4 Star
Page 19 and 20:
Basic Understanding | 19 1.3.18 Sta
Page 21 and 22:
Table of Contents | 3 2 Tutorials 2
Page 23 and 24:
Tutorials | 5 Note that when changi
Page 25 and 26:
Tutorials | 7 IUser user = (IUser)S
Page 27 and 28:
Tutorials | 9 user.BirthDate = new
Page 29 and 30:
Tutorials | 11 Attaching the Group
Page 31 and 32:
Tutorials | 13 The Tag object is de
Page 33 and 34:
Tutorials | 15 2.3.4 Retrieving ent
Page 35 and 36:
Tutorials | 17 //Get the category b
Page 37 and 38:
Tutorials | 19 2.6 Queries The Quer
Page 39 and 40:
Tutorials | 21 2.6.4 Remove Query R
Page 41 and 42:
Tutorials | 23 // Create a blog ent
Page 43 and 44:
Tutorials | 25 Below an example of
Page 45 and 46:
Tutorials | 27 The logging frequenc
Page 47 and 48:
Tutorials | 29 Committing the chang
Page 49 and 50:
Tutorials | 31 Get All Blog Entries
Page 51 and 52:
Tutorials | 33 2.10 Calendar Calend
Page 53 and 54:
Tutorials | 35 Create a New Event C
Page 55 and 56:
Tutorials | 37 Create Recurrent Eve
Page 57 and 58:
Tutorials | 39 Import Necessary Nam
Page 59 and 60:
Tutorials | 41 2.11 Chat The Chat M
Page 61 and 62:
Tutorials | 43 2.11.2 Base The base
Page 63 and 64:
Tutorials | 45 2.11.5 MessageBox Th
Page 65 and 66:
Tutorials | 47 2.12.2 Removing a Cl
Page 67 and 68:
Tutorials | 49 Adding an Ad with an
Page 69 and 70:
Tutorials | 51 Import Necessary Nam
Page 71 and 72:
Tutorials | 53 Get the contact rela
Page 73 and 74:
Tutorials | 55 Then create a new Co
Page 75 and 76:
Tutorials | 57 2.14.5 Configuration
Page 77 and 78:
Tutorials | 59 Then we get the cont
Page 79 and 80:
Tutorials | 61 To get a UserCollect
Page 81 and 82:
Tutorials | 63 Now we are ready to
Page 83 and 84: Tutorials | 65 Folder inbox = dmc.G
Page 85 and 86: Tutorials | 67 Then we remove it: D
Page 87 and 88: Tutorials | 69 2.17.6 Configuration
Page 89 and 90: Tutorials | 71 2.18.2 Add a Member
Page 91 and 92: Tutorials | 73 Check if a User is a
Page 93 and 94: Tutorials | 75 Assign a Question To
Page 95 and 96: Tutorials | 77 Get Questions Assign
Page 97 and 98: Tutorials | 79 2.19 Forum Forums ar
Page 99 and 100: Tutorials | 81 Locking the Topic To
Page 101 and 102: Tutorials | 83 2.19.7 Removing a Re
Page 103 and 104: Tutorials | 85 First we need the Im
Page 105 and 106: Tutorials | 87 To begin with, we ne
Page 107 and 108: Tutorials | 89 2.21 Moblog The Mobl
Page 109 and 110: Tutorials | 91 2.22 MyPage The EPiS
Page 111 and 112: Tutorials | 93 Getting Blocked User
Page 113 and 114: Tutorials | 95 2.23 NML NML is a ma
Page 115 and 116: Tutorials | 97 Limiting Maximum Wor
Page 117 and 118: Tutorials | 99 Getting a User’s L
Page 119 and 120: Tutorials | 101 Add a Poll In this
Page 121 and 122: Tutorials | 103 Voting in a Poll To
Page 123 and 124: Tutorials | 105 2.25.6 Add Choices
Page 125 and 126: Tutorials | 107 Import Necessary Na
Page 127 and 128: Tutorials | 109 2.27.2 Adding video
Page 129 and 130: Tutorials | 111 Calling AddVideo pr
Page 131 and 132: Tutorials | 113 2.27.6 Get preview
Page 133: Tutorials | 115 2.28 Webmail Webmai
Page 137 and 138: Tutorials | 119 Accessing a Mailbox
Page 139 and 140: Tutorials | 121 Note that it is rec
Page 141 and 142: Extending EPiServer Community | 123
show all

Developer's Guide - EPiServer World

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?