Enable Incoming emails on a Custom SharePoint List
We had a requirement recently whereby we needed to create a custom SharePoint list that would accept incoming emails. This post is going to be very long so bear with me …
Initially, I was very optimisitic that all I needed to do was to setup incoming notifications via Central Administration and then turn on Incoming Email notifications on the list itself and it should all fall into place.
How wrong I was!
Setting up the Development Enviornment
The first thing you have to do is to setup your development enviornment so that you can send emails and your SharePoint list can recieve them. This turned out to be a massive task. I spent hours searching through blogs, forums and various sites to try and setup the infrastructure on my dev (Hyper-v VM based) enviornment but I just could not get it to work. Eventually I stubmled upon this post from Marc Charmois that explained in detail how to get the whole thing to work on your Dev enriornment:
Enabling Incoming-emails on the SharePoint List. The Problem:
Ok, so I created a custom SharePoint List went to List Settings and looked for the ‘In-coming email settings’ link under the ‘Communication’ settings and found it to be non-existent. Googling on this brought all sorts of theories, hearsay and rumours to light. Some thought that this option was only available on x,y or z type of lists then there were others that thought it was only available on a,b,c or d type of lists but one thing was for sure no one seemed to know for a fact what was actually going on. As I was looking at the object model I found a property on the SPList object called ‘CanReceieveEmail’. I thought maybe this was the answer i.e. all I needed to do was to get my list and set this property to true and it will all work. However you cannot set this property you can only get its value. I believe this property is used by the SharePoint UI to decide whether or not to show the ‘In-coming Email Settings’ link in the list settings area.
So it was time to fire up Reflector to find a way to set this property maybe through reflection?
Looking at the property via reflection I found:
1
2
3
4
5
6
7
8
| public bool get_CanReceiveEmail(){ if (!SPEmailHandler.HasHandler(this.BaseTemplate) && !this.HasExternalEmailHandler) { return false; } return !SPMeeting.IsMeetingWorkspaceWeb(this.ParentWeb);} |
And ..
1
2
3
4
5
6
7
8
| public static bool HasHandler(SPListTemplateType templateType){ if ((((templateType != SPListTemplateType.Announcements) && (templateType != SPListTemplateType.Events)) && ((templateType != SPListTemplateType.DocumentLibrary) && (templateType != SPListTemplateType.PictureLibrary))) && ((templateType != SPListTemplateType.XMLForm) && (templateType != SPListTemplateType.DiscussionBoard))) { return (templateType == SPListTemplateType.Posts); } return true;} |
And finally ….
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
| internal bool HasExternalEmailHandler{ get { bool flag = false; foreach (SPEventReceiverDefinition definition in this.EventReceivers) { if (definition.Type == SPEventReceiverType.EmailReceived) { flag = true; } } return flag; }} |
From this we can determine the following:
If the list, regardless of its type, appears in a meeting workspace web it will not be able to recieve in-coming emails.
The list either needs to have the BaseTemplate of one of the following:
AnnouncementsEventsDocumentLibraryPictureLibraryXMLFormDiscussionBoardPosts
or it needs to have an event handler of type ‘EmailReceived’ attached to it.
An important point to note here is that it mentions the base template which should not be mistaken for the BaseType. What this means is that you could create a custom list that inherits from the BaseType Document Library but that does not mean that it will have incoming emails enabled. Your list will need to have the same BaseTemplate as the out of the box lists mentioned above which is not really ideal.
Enabling Incoming-emails on the SharePoint List. The Solution:
So the only route left for me to take was to go the Event Handler path. I attached the Event Handler (and the incomming email settings link started to appear in the list settings area) then sent an email to my list and debugged my code with a break point on my event handler. However it just never seemed to get hit and neither were my emails appearing in the list itself.
The mistake I was making was to attach the w3wp process but this is not the process that processes the incoming emails. I dont want to go into this in detail but the incoming emails are processed by a SharePoint job that runs every minute therefore the process I needed to attach was the OWSTimer process. Once I attached this process it started to hit my break point however the emails were still not appearing in the list.
One thing to note here is that whenever you make any code changes to this event handler, after you deploy the dll’s to GAC, you need to ensure you restart the SharePoint Timer Job Service because it holds a cached version of the dll’s.
Finally, the reason the emails were not appearing in the list was because this needs to be done via the Event Handler. For the lists that are from one of the Templates I mentioned above SharePoint understands how to process and add the email messages however for your own custom list it is down to the Developer to write the code to do this processing. The event handler though provides you an object of type SPEmailMessage which has all the data you require. Below is an example of how it can be used to add the email subject to a simple custom list with only a title field:
1
2
3
4
5
6
| public override void EmailReceived(SPList list, SPEmailMessage emailMessage, String receiverData){ SPListItem newItem = list.Items.Add(); newItem["Title"] = emailMessage.Headers["subject"] newItem.Update();} |
You can easily extend it to deal with attachments as well but that is for another day!
P.S Illustrations to be added soon….
No comments:
Post a Comment