EwsFindFolderIdByFullName Method (FolderId, String) |
Namespace: MailBee.EwsMail
public FolderId FindFolderIdByFullName( FolderId containingFolderId, string folderFullName )
Exception | Condition |
---|---|
MailBeeException | An error occurred and ThrowExceptions is true. |
NotImplementedException | The .NET runtime is .NET Core. |
To delimit levels of hierarchy in the folder name, use the same character which is set by FolderLevelDelimiter property. By default, it's '/' (forward slash).
containingFolderId is just for optimization so you can leave it a null reference. However, if you already know that the folder you're looking for is contained in some upper level folder, you can specify it there. This will optimize performance as only a subset of all folders in the account will be searched. If you don't know the containing folder, you can use another optimization provided by FindFolderIdByFullName(string, int) overload.
containingFolderId does not need to be the immediate parent of the folder you're looking for, it can be any level up (e.g. you can specify WellKnownFolderName.Inbox while searching for "Inbox/Nested folder/Deeply nested folder"). Still, more close containingFolderId's level is to folderFullName's level - faster the search will be.
Key difference of this method from DownloadFolderByFullName(FolderId, String) is that it returns just ID. This means that MailBee requests less info from the server making this method a bit more efficient. However, if you need the detailed info about the folder (e.g. message count, unseen count, etc), use DownloadFolderByFullName(FolderId, String) instead.
Note |
---|
This method is not implemented in .NET Core. Use FindFolderIdByFullNameAsync(FolderId, String) instead. |