 |
Enterprise Systems »
Microsoft Exchange »
General
Intermediate
License: The Code Project Open License (CPOL)
Programming With Exchange Server 2007 (EWS) - Part 2By BrijThis article is the second part of the series on EWS which explores Exchange Web Services |
C#, .NET
|
|
Advanced Search Add to IE Search |
|
|
|
||||||||||||||||
In part 1, I discussed about the brief history of Exchange Server 2007 and a brief description of EWS with it’s special features. I’ll try to keep the article short and more focused.
In this part, I’ll explain how to read the messages from different folderand searching on it.
Here we can have two things.
I’ll discuss both in this article.
Few points regarding reading mails for different folders
Here we use an API FindItem provided by EWS which only returns 512 bytes of an item i. e. the returned object’s all properties can’t be populated although we can specify some properties that we want.
The key EWS functionalities are discussed here:
For all this, we need the FolderID of the folders folders like Inbox, SentItems, Drafts etc…So we need to call one other API for this like below:
public FolderIdType FindFolderID()
{
DistinguishedFolderIdType objSearchRootFolder = new DistinguishedFolderIdType();
objSearchRootFolder.Id = DistinguishedFolderIdNameType.msgfolderroot;
FindFolderType requestFindFolder = new FindFolderType();
requestFindFolder.Traversal = FolderQueryTraversalType.Deep;
requestFindFolder.ParentFolderIds = new DistinguishedFolderIdType[] { objSearchRootFolder };
requestFindFolder.FolderShape = new FolderResponseShapeType();
requestFindFolder.FolderShape.BaseShape = DefaultShapeNamesType.IdOnly;
//Search filter definition
requestFindFolder.Restriction = new RestrictionType();
#region Contains expression
ContainsExpressionType objContainsExpression = new ContainsExpressionType();
objContainsExpression.ContainmentMode = ContainmentModeType.FullString;
objContainsExpression.ContainmentModeSpecified = true;
objContainsExpression.ContainmentComparison = ContainmentComparisonType.Exact;
objContainsExpression.ContainmentComparisonSpecified = true;
PathToUnindexedFieldType objFieldFolderName = new PathToUnindexedFieldType();
objFieldFolderName.FieldURI = UnindexedFieldURIType.folderDisplayName;
objContainsExpression.Item = objFieldFolderName;
objContainsExpression.Constant = new ConstantValueType();
objContainsExpression.Constant.Value = "Inbox";
#endregion Contains expression
requestFindFolder.Restriction.Item = objContainsExpression;
FindFolderResponseType objFindFolderResponse =
_esb.FindFolder(requestFindFolder);
if (objFindFolderResponse.ResponseMessages.Items.Length == 0)
return null;
foreach (ResponseMessageType responseMsg in
objFindFolderResponse.ResponseMessages.Items)
{
if (responseMsg.ResponseClass == ResponseClassType.Success)
{
FindFolderResponseMessageType objFindResponse =
responseMsg as FindFolderResponseMessageType;
foreach (
BaseFolderType objFolderType in objFindResponse.RootFolder.Folders)
{
return objFolderType.FolderId;
}
}
}
return null;
}
If the folder contains no Item, It'll return -1.
public int GetFolderItemsCount()
{
FindItemType findRequest = new FindItemType();
findRequest.ItemShape = new ItemResponseShapeType();
findRequest.ItemShape.BaseShape = DefaultShapeNamesType.IdOnly;
BaseFolderIdType p_folder = FindFolderID();
findRequest.ParentFolderIds = new BaseFolderIdType[] { p_folder };
findRequest.Traversal = ItemQueryTraversalType.Shallow;
// Perform the inbox search
FindItemResponseType response = _esb.FindItem(findRequest);
FindItemResponseMessageType responseMessage =
response.ResponseMessages.Items[0]
as FindItemResponseMessageType;
if (responseMessage.ResponseCode != ResponseCodeType.NoError)
{
throw new Exception(responseMessage.MessageText);
}
else
{
if (responseMessage != null && responseMessage.RootFolder != null)
{
return responseMessage.RootFolder.TotalItemsInView;
}
else
{
return -1;
}
}
}
public int GetUnreadFolderItemsCount()
{
int unReadCount = -1;
// Identify the folder properties to return.
FolderResponseShapeType properties = new FolderResponseShapeType();
PathToUnindexedFieldType ptuft = new PathToUnindexedFieldType();
ptuft.FieldURI = UnindexedFieldURIType.folderManagedFolderInformation;
PathToUnindexedFieldType[] ptufts = new PathToUnindexedFieldType[1] { ptuft };
properties.AdditionalProperties = ptufts;
properties.BaseShape = DefaultShapeNamesType.AllProperties;
// Form the get folder request.
BaseFolderIdType p_folder = FindFolderID();
GetFolderType request = new GetFolderType();
request.FolderIds = new BaseFolderIdType[1] { p_folder };
request.FolderShape = properties;
// Send the request and get the response.
GetFolderResponseType response = _esb.GetFolder(request);
ArrayOfResponseMessagesType aormt = response.ResponseMessages;
ResponseMessageType[] rmta = aormt.Items;
foreach (ResponseMessageType rmt in rmta)
{
if (rmt.ResponseClass == ResponseClassType.Error)
{
throw new Exception(rmt.MessageText);
}
else
{
FolderInfoResponseMessageType firmt;
firmt = (rmt as FolderInfoResponseMessageType);
BaseFolderType[] folders = firmt.Folders;
foreach (BaseFolderType rfolder in folders)
{
if (rfolder is FolderType)
{
FolderType myFolder;
myFolder = (rfolder as FolderType);
if (myFolder.UnreadCountSpecified)
{
unReadCount = myFolder.UnreadCount;
}
}
}
}
}
return unReadCount;
}
public List<messagetype> GetFolderItems() { FindItemType findRequest = new FindItemType(); findRequest.ItemShape = new ItemResponseShapeType(); ItemResponseShapeType itemProperties = new ItemResponseShapeType(); // Use the Default shape for the response. itemProperties.BaseShape = DefaultShapeNamesType.Default; findRequest.ItemShape = itemProperties; Set the inbox as the parent search folder in search attachementRequest. BaseFolderIdType p_folder = FindFolderID(); findRequest.ParentFolderIds = new BaseFolderIdType[] { p_folder }; findRequest.Traversal = ItemQueryTraversalType.Shallow; // Perform the inbox search FindItemResponseType response = _esb.FindItem(findRequest); FindItemResponseMessageType responseMessage = response.ResponseMessages.Items[0] as FindItemResponseMessageType; if (responseMessage.ResponseCode != ResponseCodeType.NoError) { throw new Exception(responseMessage.MessageText); } else { // Set the next index to use ArrayOfRealItemsType items = responseMessage.RootFolder.Item as ArrayOfRealItemsType; if (items.Items == null) { // no items in the view. return null; } // Create our response list List<messagetype> result = new List<messagetype>(items.Items.Length); foreach (MessageType item in items.Items) { result.Add(item); } return result; } }
For sorting, first we need to select on which field I want to sort, here I selected Subject:
FieldOrderType[] fieldsOrder = new FieldOrderType[1];
fieldsOrder[0] = new FieldOrderType();
PathToUnindexedFieldType pathSortField = new PathToUnindexedFieldType();
pathSortField.FieldURI = UnindexedFieldURIType.itemSubject;
fieldsOrder[0].Order = SortDirectionType.Descending;
findRequest.SortOrder = fieldsOrder;
For indexed view (i. e. if I want to bring only 10 items at a time from server) we can set set the max item returned and can set the startitem I'd like.
IndexedPageViewType indexedView = new IndexedPageViewType();
indexedView.BasePoint = IndexBasePointType.Beginning;
indexedView.MaxEntriesReturned = p_intMaxRec;
indexedView.MaxEntriesReturnedSpecified = true;
indexedView.Offset = p_intStartIdx;
findRequest.Item = indexedView;
Here, also if I want some special properties then I can do like below:
PathToUnindexedFieldType pathSentDateTime = new PathToUnindexedFieldType();
pathSentDateTime.FieldURI = UnindexedFieldURIType.itemDateTimeSent;
itemProperties.AdditionalProperties = new BasePathToElementType[] { pathSentDateTime;}
findRequest.ItemShape = itemProperties;
For searching any folder we need to to do the same as above for all those properties. We also need here one other object of class RestrictionType as:
RestrictionType objRestrictionType = new RestrictionType();
In searching, we have two options:
For single property searching we need to create the object of OrType as
OrType orType = new OrType();
Else for multiple
AndType andType = new AndType();
And another one object of type as ContainsExpressionType
Here ContainsRxpressionType is used because if, let’s say, the subject is hello and we give the value just “hel” then it’ll search all the items in which the subject value contains “hel.”
ContainsExpressionType expressionType = null;
List<searchexpressiontype> searchExps = null;
Now for searching for subject
PathToUnindexedFieldType path.FieldURI = UnindexedFieldURIType.itemSubject;
expressionType = new ContainsExpressionType();
expressionType.Item = path;
expressionType.ContainmentMode = ContainmentModeType.Substring; //seach for substrings
expressionType.ContainmentModeSpecified = true;
expressionType.ContainmentComparison =
ContainmentComparisonType.IgnoreCaseAndNonSpacingCharacters;
expressionType.ContainmentComparisonSpecified = true;
expressionType.Constant = new ConstantValueType();
expressionType.Constant.Value = “Hi”; //search for any string containing
searchExps.Add(expressionType);
Similarly we can iterate for as many properies as we want:
Now for andType
andType.Items = searchExps.ToArray();
objRestrictionType.Item = andType;
for OrType
orType.Items = searchExps.ToArray();
objRestrictionType.Item = orType;
For this restriction type object we need to set in findrequest as:
findRequest.Restriction = p_RestrictionType;
then it’ll search the folder according to the restriction.
I'll discuss in the next part, reading details of mail from different folders. Also, I'll try to cover the one of the main features of the EWS Extended property, which is very useful when we need some custom attributes for the every item.
| You must Sign In to use this message board. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
General 
News 
Question 
Answer 
Joke 
Rant 
Admin
|
PermaLink |
Privacy |
Terms of Use
Last Updated: 14 Nov 2008 Editor: Sean Ewington |
Copyright 2008 by Brij Everything else Copyright © CodeProject, 1999-2009 Web22 | Advertise on the Code Project |
