diff options
Diffstat (limited to 'protocols/YAMN/docs')
| -rw-r--r-- | protocols/YAMN/docs/ChangeLog.txt | 243 | ||||
| -rw-r--r-- | protocols/YAMN/docs/InstallScript.xml | 49 | ||||
| -rw-r--r-- | protocols/YAMN/docs/license.txt | 340 | ||||
| -rw-r--r-- | protocols/YAMN/docs/readme.developers.txt | 205 | ||||
| -rw-r--r-- | protocols/YAMN/docs/readme.txt | 79 |
5 files changed, 916 insertions, 0 deletions
diff --git a/protocols/YAMN/docs/ChangeLog.txt b/protocols/YAMN/docs/ChangeLog.txt new file mode 100644 index 0000000000..0088e3c684 --- /dev/null +++ b/protocols/YAMN/docs/ChangeLog.txt @@ -0,0 +1,243 @@ +0.1.2.5 +======= +! fix many memory leaks patch by Merlin +* x64 support by Merlin +* Resource patch by mataes (for translations) + +0.1.2.4 +======= +* Only show popup tab if popup plugin is present +! Wrong time displayed in mailbrower (fix by y_b) + +0.1.2.3 +======= +* New design for the options pages (Thanks Eyecue) + +0.1.2.2 +======= +* using, with updater, the correct file id in file listing (yamn 2in1) ++ added folders plugin support ++ Support for miranda 0.8 + +0.1.2.1 +======= +! Don't close MailBrowser when e-mails are updated if it is manually open ++ Discard the new Event when message is shown or is deleted from the server ++ Option to disable the CList events per account ++ Contact status change also happens when e-mail are being deleted + +0.1.2.0 +======= +! patch by TioDuke for icolib and status and status icons handling. Thanks! +! code cleaning (properly destroy services and hooks) ++ Contact status changes accordingly the action (Ready, Working, Error) + +0.1.1.0 +======= ++ Show message is open in new thread ++ Click on individual new e-mail popups shows the message window + +0.1.0.2 +============ ++ Pressing "Space" key will show the selected message +! Delete message is done by DELETE key, not by '.' +! removed some repeated code +! "Ok" and "Select All" buttons in mail browser are translatable + +0.1.0.1 +============ ++ Message body shown in separate edit box. ++ Support for Content-transfer-encoding: Quoted-Printable and base64 ++ Recursive Content-type: multipart/ support ++ Option to auto retrieve body + +0.0.1.11 +============ ++ Option to use yamn as a protocol. +* Patch by Tioduke (code cleaning) +! Fixed the crash parsing invalid "Date" header (SPAMs or silly e-mail client) (y_b) +! ShowMessage dialog follows Content-type header to chose the codepage (y_b) ++ Only supported codepages are shown in the options (y_b) ++ Enhance codepages support (y_b) + +0.0.1.10 +============ +! Icons are based on single bitmap image (y_b) +* Show full feaders on double click in mailbrowser (y_b) +* Dates are shown localized and sorted correctly (y_b) +* To show long/short date and seconds (y_b) +! Solved a rare/random crash on unstable connection (y_b) +! Enabled tabstop on new tabcontrol and reordered tabstop in option pages (y_b) +* Enable TAB selection in mailbrowser dialog (patch by -pv-) ++ introducing 2in1 build - can be used both in win9x and NT/XP +* Options redesign. + +0.0.1.9 +============ +* Patch by Perf (visual patch) + +0.0.1.8 +============ ++ add ctr-A to select all mails ++ del key delete selected mail ++ add a select all button + +0.0.1.7 +============ +* Change options dialog (use tabsrmm uxtheme) +! Invert back and text color for no new mail popup in option page. +* New default icon reworked by Faith Healer. + +0.0.1.6 +============ +* Try to update all icons when changing in icolib. +! Allow scrolling in list of email account. (Patch by Jazzy) +! Memory leak in stls fix (y_b) + +0.0.1.5 +============ +! Bug fix with help.dll problem. (Patch by Jazzy) + (http://developer.berlios.de/bugs/?func=detailbug&bug_id=6692&group_id=3292) +! Remove merge in agressiveoptimize.h + +0.0.1.4 +============ +! Option page bug (patch by y_b) +* Allow to edit the application text + +0.0.1.3 +============ +! Bug fix with new icolib + +0.0.1.2 +============ +! Bug fix with updater and stable version ++ Using new m_icolib.h ++ New context menu entry to launch application ++ Patch by y_b +{ + + Start TLS support + + Better icolib support + + SSL Logging +} + +0.0.1.1 +============ +! Bug fix on left click popup. + +0.0.1.0 +============ +Time for release. + +0.0.0.18 +============ +! Visual bug in option page +! Recompilation for win 9x users. + +0.0.0.17 +============ +* Redesign option page to have only one entry in plugins options +! Bug fix when there is no date set in the header (spam mails) (Thx Egres) + +0.0.0.16 +============ +* Right click on error popup close the popup. +! Missing break; in nonewmail popup in switch. ++ Add option to rename contact according to new mail. +! Patch by pescuma on delete accounts + +0.0.0.15 +============ +! Fixed dismiss event by right click on new mail popup crash +* Change string for the status choose button +! use CallServiceSync() instead of CallService() for adding clistevent (now icon blinks) + +0.0.0.14 +============ +! Tooltip on the clist event will now show correct text +! Remove the messagebox on double clik on mail +* Change options dialog add dialog for status choose. + +0.0.0.13 +============ ++ Use of event count for the keyboard flashing + +0.0.0.12 +============ +- Remove message body retrieving due to bug. + +0.0.0.11 +============ ++ Add a function to retrieve the whole mail source. ++ Show the mail source when double clicking on it in mail browser. ++ Add a version resource. + +0.0.0.10 +============ ++ Now able to pass hContact handle to popup so can show avatar if set. +* Change folder structure in svn SDK\import replace by include + +0.0.0.9 +============ ++ Sorting asc and desc of the mail browser listview ++ Use the format yyyy-mm-dd hh:mm:ss for date comparaison in sorting ++ Doubleclick on list view to show the mail body but it seems to be empty :( + +0.0.0.8 +============ ++ Add date field in mail browser +* Modify the tooltip text for the clist event (add account name) +* Rename Contact member of CAccount by hContact since it is an HANDLE ++ Updater support for BETA +* Using the right headers (no more the one in SDK) + +0.0.0.7 +============ ++ Added changelog txt file. ++ Check presence of icolib to choose the right icon to show in clist ++ Status message will show all message pending in mail box (until they get retrieve by your email client) + +0.0.0.6 +============ +* Options page redesign. ++ Right click on popup close the clist event too. ++ Update status message if no new mail. ++ Right click on popup^with no new mail close the popup. +* No more delete of contact (avoid group affectation bug). + +0.0.0.5 +============ ++ Add contact context menu entry to check for new mail. ++ Catch double click event on contact to shown the mail browser. + +0.0.0.4 +============ ++ Add per account option to be show as contact or not. ++ Gestion de la suppression d'un compte ++ Use of the status message for showing number of emails. ++ Refresh yamn contact on the click on apply in options dialog. +* Better condition for the ^contact loop (ouuppsss) + +0.0.0.3 +============ ++ Now account are shown as a contact. ++ Source code modification and use of stdafx.h ++ Wait the event moduleloaded before loading the icons (support icolib). + +0.0.0.2 +============ ++ Use of patch by Q (From file listing) (Memory cleaning, empty mail browser even if there are mails, yamn freeze sometime) ++ Use of thread access function. ++ Possibility to change toptoolbar icons via icolib. ++ Icon in main menu entry (Asked by a7) ++ New Icons set by Manudevil. ++ Change version number to be compatible with updater plugin + +0.01 +============ + ++ icolib support. ++ keyboard flash support (just 10 sec) (thx TioDuke) needs Keyboard Notify Ext. 1.5.4.4 ++ list of email can be sorted. +* left click on popup shows email list. +* better toptoolbar support.
\ No newline at end of file diff --git a/protocols/YAMN/docs/InstallScript.xml b/protocols/YAMN/docs/InstallScript.xml new file mode 100644 index 0000000000..d389dbfa09 --- /dev/null +++ b/protocols/YAMN/docs/InstallScript.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<installscript> + <info> + <name>Yet Another Mail Notifier</name> + <author>majvan</author> + <version>0.2.4.7</version> + <type>Plugin</type> + </info> + + <packageinfo> + <title>Plugin</title> + <file>YAMN.dll</file> + </packageinfo> + + <packageinfo> + <optional/> + <title>Documentation</title> + <file>YAMN-Readme.txt</file> + <file>YAMN-License.txt</file> + <document/> + </packageinfo> + + <packageinfo> + <optional/> + <title>Developers Information</title> + <file>YAMN-Readme.developers.txt</file> + <document/> + </packageinfo> + + <packageinfo> + <optional/> + <title>Simple filter plugin</title> + <file>YAMN\simple.dll</file> + <file>YAMN\simple-readme.txt</file> + </packageinfo> + + <packageinfo> + <optional/> + <title>Base filter plugin</title> + <file>YAMN\base.dll</file> + <file>YAMN\base-readme.txt</file> + </packageinfo> + + <autorun> + <file>YAMN-Readme.txt</file> + <document/> + </autorun> + +</installscript> diff --git a/protocols/YAMN/docs/license.txt b/protocols/YAMN/docs/license.txt new file mode 100644 index 0000000000..f3790d8623 --- /dev/null +++ b/protocols/YAMN/docs/license.txt @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) 19yy <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19yy name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/protocols/YAMN/docs/readme.developers.txt b/protocols/YAMN/docs/readme.developers.txt new file mode 100644 index 0000000000..4ab336da8a --- /dev/null +++ b/protocols/YAMN/docs/readme.developers.txt @@ -0,0 +1,205 @@ +================================================================================== += YAMN plugin for Miranda (short readme for developers) = +================================================================================== +Hello developer! :) +I hope YAMN will give you what you find, but you can also improve YAMN. + +This readme gives you some info about YAMN. Please read it first before you are +going to look at YAMN sources. + +YAMN provides two types of plugins now: protocol plugins and filter plugins. + + +1. What do you need to make your protocol plugin cooperating with YAMN + ------------------------------------------------------------------- + + If you want to cooperate with YAMN, you have to do some things. YAMN offers you some services, + so your work is easier, but YAMN needs some things to be done for proper work. These limits go + according thread synchronization and memory mutual exclusion. + + YAMN offers you two types of services. Exported functions and Miranda services. Miranda + services are described in header files, exported functions are described in cpp files. All + exported functions in YAMN have the suffix Fcn, so you can easy get if the function is + exported. Using exported functions is more difficult than using miranda services, but after + solving some definitions, the work with exported functions is more clear and easier. Miranda + services from YAMN are for miscellaneus functions. The fact Miranda service uses only two + parameters and therefore is sometimes very unsuitable leads us to make exported functions. + Exported functions are divided in several parts: synchronizing functions (used for thread + and account synchronization) and MIME functions (used to work with MIME + messages). + + Miranda services are used through Miranda CallService function. YAMN exported functions are avialable + when registering plugin. Then YAMN gives you its table of exported functions. + + How to write write your protocol plugin for YAMN? The best way for you is to look at + internal POP3 protocol, where all info about this is written. At start, you need to register + plugin (it is done in two steps- registering and inserting to YAMN), then get pointers to + YAMN's exported functions (using Miranda's service MS_YAMN_GETFCN) you will need in your + protocol plugin. These are the first steps you should do when implementing some plugin to + YAMN. Next, you should know how YAMN is stuctured. Structures of YAMN are described in + chapter 2. And, at the end, you should know something about account synchronizing and some + limitations you have to achieve, if you want your plugin works well. + + +2. YAMN structures and memory organization + --------------------------------------- + + YAMN uses its own structures, that can change in the future. The problem with change is, + that there can occur some incomapatibilities between YAMN and plugins written for old YAMN + versions. To avoid problems, YAMN defines versions for services or exported/imported + functions, where strucutre version information is passed to/from plugins. + + +2.1. Structures of protcol plugin queue + + (PYAMN_PROTOPLUGINQUEUE)FirstPlugin---> =(HYAMNPROTOPLUGIN)= ---> =(HYAMNPROTOPLUGIN)= ---> =(HYAMNPROTOPLUGIN)= ---> NULL + | | | | | | | | | + | . | | | . | | | . | | + | . | | | . | | | . | | + | . | | | . | | | . | | + -------------------- | |------------------| | |------------------| | + | Next |--| | Next |--| | Next |--| + ==================== ==================== ==================== + + This structure is not needed if you only create protocol plugin for YAMN. YAMN plugin does + not see and it is not important for it how YAMN works with plugins and how it stores plugins + data. For plugin is important only handle for its own plugin, returned from + MS_YAMN_REGISTERPLUGIN service. + + +2.2. Structure of accounts + + Every account in YAMN belongs to exact plugin and its members are allocated with + MS_YAMN_CREATEPLUGINACCOUNT service. This service cooperates with your function, which is + defined in your function import table. In your function (if you have defined it), you should + create the whole account. It is because YAMN cannot know which members in structure did you + add. So you create the whole derived structure. If your fcn is not implemented (NULL in + import table), YAMN creates standard account structure. + + This structure contains information (members) related to YAMN, to plugin and members shared + between both (plugin and YAMN). Therefore it is needed to synchronize access to members (see + Ch. 3). Standard YAMN account is defined in m_account.h header file. There's also + description for every member how it is synchronised. YAMN creates two synchronizing objects + (SO) to synchronise access to members. In m_synchro.h file, there are definitions for easy + work with these SO. + + Accounts are queued in plugin: + + =(HYAMNPLUGIN)= ---> ===(HACCOUNT)=== ---> ===(HACCOUNT)=== ---> ===(HACCOUNT)=== ---> NULL + | | | | | | | | | | | | + | | | | | | | | | | | | + | . | | | | | | | | | | | + | . | | | | | | | | | | | + | . | | | | | | | | | | | + | | | |--------------| | |--------------| | |--------------| | + | (HACCOUNT) | | | Next |--| | Next |--| | Next |--| + | FirstAccount|--| ================ ================ ================ + |-------------| + | | + =============== + + Every account has its own back pointer to (HYAMNPLUGIN) in Plugin member, so you can easy + look at first account, when you have any other account (see m_account.h). + + +2.3. Structure of mails + + Account has a pointer to mails. Account's pointer to mails is pointer to first mail in fact + and mails are queued too: + + ==(HACCOUNT)== ---> ==(HYAMNMAIL)== ---> ==(HYAMNMAIL)== ---> ==(HYAMNMAIL)== ---> NULL + | | | | | | | | | | | | + | . | | | | | | | | | | | + | . | | | | | | | | | | | + | . | | | | | | | | | | | + | | | |-------------| | |-------------| | |-------------| | + | (HYAMNMAIL)| | | Next |--| | Next |--| | Next |--| + | Mails|--| =============== =============== =============== + |------------| + | | + ============== + + Standard MIME mail is defined in mails/m_mails.h file. + + Plugin can work with accounts in its own way, but note it is needed to synchronize access. + For better work, YAMN offers you some services and exports functions. Description of + exported functions is in its declartation; for accounts functions see account.cpp, for mails + functions see mails/mails.cpp and so on. + + +3. YAMN thread synchronization + --------------------------- + + Because YAMN is multithreaded, more than one thread can access to any member of account + structure. Therefore access to these members should be synchronised. YAMN offers two types + of synchronization objects (SO): SCOUNTER (Synchronized Counter) and SWMRG (Single + Writer/Multiple Readers Guard). To use these objects, you can use exported functions: + + SWMRG: WaitToWriteSO, WaitToWriteSOEx, WriteDoneSO, WaitToReadSO, WaitToReadSOEx, ReadDoneSO + SCOUNTER: SCGetNumber, SCInc, SCDec + + To see description for these functions, see m_synchro.h header file and synchro.cpp. Note + that in HACCOUNT structure, there are 3 synchronizing members, which you have to use if you + want to access to any member of account structure. All access techniques (writing to members + and read from members) are used in POP3 protocol plugin. Now, it is important what we have + to do when we want to make our plugin be synchronized with YAMN (in POP3 protocol it is + described too). + + 1. We have to use ThreadRunningEV event when YAMN calls our checking/deleting function. This + parameter is to stop YAMN called thread until we do not have copied datas from stack. After + that, we SetEvent(ThreadRunningEvent) to unblock YAMN to continue in its work. + + 2. We have to use UsingThreads account's member. This is only for YAMN account deleting + prevention. We use this counter to set number of threads using account. If no thread is just + using account, account is signaled, that it can be deleted (and is deleted when needed). + This leads us to do some things: We use SCInc(UsingThreads) as the first thing we can do. We + cannot omit, that called thread finished before we call this function. UsingThreads should + have "continuous" value greater than zero when using account. E.g. if YAMN creates thread + for plugin that checks account for new mail, YAMN waits until we set ThreadRunningEV (see + point 1). After setting this event to signal, that YAMN can continue in its work, we + increase SCInc(UsingThreads), so we ensure that another thread uses account before YAMN + thread, that uses this account ends. And SCDec(UsingThreads) should be the last thing we do + in our thread. If we run another thread in our thread, we should wait until it does not + SCInc(UsingThreads) and after that we should continue (just like YAMN creates and calls our + thread). + + 3. If we use account's SWMRG (AccountAccessSO, MessagesAccessSO), we should test what our + function returned. Use the same methods as POP3 protocol does while testing and accessing + critical section. Note that we cannot use WaitToWriteSO(MyAccount->AccountAccessSO), but in + easy way we can WaitToWrite(AccountAccess) and for mails + WaitToWriteSO(MyAccount->MessagesAccessSO) use MsgsWaitToWrite(AccountAccess) and so on. See + export.h file for these definitions. + + 4. Deleting account is quite easy, but in YAMN, it is very problematic operation. If you use + MS_YAMN_DELETEACCOUNT service, it is the best way to avoid any problem. These problems raise + from the facts desribed in the point 2. + + 5. You should use ctritical sections only for short time not to block other threads. You can + imagine that users can't browse through mails, because account is blocked by your thread... + + All needed infos in POP3 internal protocol plugin (see proto/pop3/pop3comm.cpp), are + described. + + +4. What do you need to make your filter plugin cooperating with YAMN + ----------------------------------------------------------------- + + Filter plugins are very easy to write in its own way, it much more easier than protocol + plugin. But some things are common: you have to register your plugin and insert to YAMN + (these are 2 steps, see sources of some filter plugin), You have to import to YAMN your + filter function. Filter function can do anything with mails, but the most important is, that + it can set Flags member of mail (see mails/m_mails.h file) to one of YAMN_MSG_SPAMLx. + Note Mail is in write-access, so your plugin can do anything with mail and avoid the + synchronization problem. + + Now YAMN recognizes 4 spam levels: + 1. Notifies about this mail, but shows it in mailbrowser with other color than normally + 2. Does not notify about this mail, shows it in mailbrowser with other color than normally + 3. Deletes mail from server (depends on protocol), does not notify and shows "this spam was + deleted" + 4. Deletes mail from server (depends on protocol), does not notify, does not show in + mailbrowser + + Your plugin can set data for mail in the TranslatedHeader structure, inserting it to the + queue. This information is stored, so it is reloaded after protocol read mails from book + file. diff --git a/protocols/YAMN/docs/readme.txt b/protocols/YAMN/docs/readme.txt new file mode 100644 index 0000000000..075a3a2a0a --- /dev/null +++ b/protocols/YAMN/docs/readme.txt @@ -0,0 +1,79 @@ +========================================================= += YAMN plugin for Miranda readme = +========================================================= +Yet Another Mail Notifier +Checks pop3 accounts for new mail + +Advantages: +- quite small +- structured in two parts: notifier and protocols +- unlimited number of accounts +- international support in Unicode +- open-source (GNU-GPL) +POP3: +- many switches for each account +- support for MIME standard +- support for Base64 and Quoted-Printable +- 100% detection of new mail based on unique message ID +- multithreaded checking (also with hotkey) +- deleting mail from server +- connecting through Miranda proxy +- secure password authentification +- SSL support through OpenSSL + +WIN9X SUPPORT +------------- +Win9x users, use unicows.dll library, download it at: +http://libunicows.sf.net (whole package) +or just visit http://www.majvan.host.sk/Projekty/YAMN +and download zip-ed unicows.dll +All you need is to copy unicows.dll to Windows system32 +directory (or to Miranda home directory). Use Win9x +version of YAMN, not WinNT version. + +SSL SUPPORT +----------- +If you want to use SSL features, you have to download +OpenSSL libraries on YAMN homepage +http://www.majvan.host.sk/Projekty/YAMN +or the latest (stable) version with installer on +http://www.slproweb.com/products/Win32OpenSSL.html +Copy *.dll files to Windows system32 directory (or to +Miranda home directory). + +LATEST STABLE +------------- +Version of YAMN has following structure: w.x.y.z +z- only some bug fixed or some changes +y- some new feature added +x- big feature added +w- if this changes, YAMN becomes better than Outlook ;-) +Latest stable plugin is always present to download from YAMN +homepage. + +BETA +---- +* YAMN-beta version is intended only for testing purposes. +* Author waits for stability reports. Sometimes author waits not +only for crash reports, but also for success reports (you are +informed by message box on startup, if success reports are also +needed). This is because he has no resources for testing. +* Please do not send reports if newer beta version is available. +* Please do not send reports without describing problem detailed. +* Beta version produces debug files (yamn-debug.*.log) located +in Miranda home directory (like every YAMN debug release). These +files are usefull for author to locate the bug (although not +100%). After Miranda restart, log files are rewritten. Log files +can become very large (more than 10MB). Sometimes they can be +cut at the end (contact author). +IMPORTANT FOR BETA: yamn-debug.comm.log file contains your plain +password. You should rewrite it. +Thank you for comprehension. + +========================================================= + Do you want some FAQ? Visit HOMEPAGE: + http://www.majvan.host.sk/Projekty/YAMN + Still don't know answer? Write question to guestbook. + + majvan +========================================================= |