Plug-in documentation and sample code are outdated
-
I understand that the MDaemon plug-in development documentation is outdated.
In addition to the date of last update in the file
C:\MDaemon\Docs\API\Plugins.txt, which is in 2019, the document refers to legacy plug-ins and not to those that MDaemon uses now and which are only mentioned in thePluginAPI.hfile.The example plug-in is also based on the legacy architecture:
C:\MDaemon\Docs\API\Sample Plugin.Would it be possible for both the documentation and the example to be updated and aligned with the modern plug-ins used by MDaemon in version 23.5 or, 24.0 when available?
Thank you in advance.
-
Keith Staff
Emanuele,
I'll see if I can put something together for a future version. Sound good? Perhaps v25.
-
Hello Keith,
regarding updating the plug-in documentation, I thank you in advance if you can update it in the future.
I'm not in a hurry at the moment, so v25.0 would be fine, because I'm always caught up in the node-mdaemon-api project and I only opened the plug-in document because I had a new idea and wanted to see how complex the plug-in development was.
-
Keith Staff
Understood. Since I designed/developed the newer Plugin API, only makes sense that I put together a sample for it. I tried to document/comment the PluginAPI.h header pretty well as things were added, but like most software developers, I hate writing documentation. I'll get with Jon and Arron regarding the docs.
-
Keith Staff
For future reference, this was created as Work Item 27759
-
Keith, if needed, I will volunteer as a 'dumb programmer' to read the draft document.
-
Keith Staff
LOL! Thanks Emanuele.
-
The API specs in the :1000/MdMgmtWS pages do not match what is the DOCS/ folders
The API spec suggests you are able to search for an email by date (using FolderOperation) but in fact you cannot. mDaemon ignores the Search items Date and Received fields.
Help examples say:<Search field="Received" filtertype="lte" datetime="2024-07-09T21:22:44.786Z"/><Search field="Date" filtertype="lte" datetime="2024-07-09T21:22:44.786Z"/>
But MdMgmtWS says these are the search items available:
<xNotes title="Values available" where="folder class" equals="IPF.Note">
<xNote heading="searchflags" note="the Search Element will define the boolean attributes of 'read', 'flagged', and 'hasattachments'" />
<xNote heading="from" note="Mail Folders Only. Used to define filtering by FROM: name and address." />
<xNote heading="to" note="Mail Folders Only. Used to define filtering by TO: name and address." />
<xNote heading="cc" note="Mail Folders Only. Used to define filtering by CC: name and address." />
<xNote heading="bcc" note="Mail Folders Only. Used to define filtering by BCC: name and address. Only valid if searching a mailbox's 'Sent Items' folder. A bcc value present when searching ny folder other than a 'Sent Items' folder will result on no results found." />
<xNote heading="subject" note="Mail Folders Only. Used to define filtering by subject text." />
<xNote heading="body" note="Mail Folders Only. Used to define filtering by body text." />
<xNote heading="attachment" note="Mail Folders Only. Used to define filtering by attachment names. Searching by attachment content or content type is not currently supported." />
<xNote heading="category" note="Mail Folders Only. Used to define filtering by category." />
<xNote heading="messageid" note="Mail Folders Only. Used to define filtering by RFC822 message-id." />
If you're going to risk being inconsistent with the documentation, just keep one source. It would save hours of wasted time for someone.
