Following are Frequently Asked Questions about VMime:
- Can I build VMime on platform X?
- Do you provide binaries for platform X?
- How to compile VMime from SVN?
- Why GPL and not LGPL?
- Is VMime thread-safe?
- Messages actually not deleted from a folder
- How many projects use VMime?
- I have found a bug in VMime. What should I do?
- I have made a patch for VMime. May I send it to you?
Can I build VMime on platform X?
Probably. Actually, you can build VMime on almost every platform that support C++ and ‘iconv’ library. The C++ compiler should be enough recent to support templates, RTTI and the STL.
However, you will have to write your own platform handler as the default platform handler that comes with the distribution only works for POSIX-compliant platforms (for now). It’s not very difficult, just look at the files in the
src/platforms/posix directory. If you write a handler for your platform, please contribute to VMime code!
Update (2005/03/28): a platform handler for Windows is now available in VMime (thanks to Stefan Uhrig).
Do you provide binaries for platform X?
Unfortunately, we do not provide any binary, neither for Linux nor for Windows or for any platform.
Maintaining up-to-date binaries (and ensuring they work on the numerous platforms) is lot of work, and we prefer taking time to work on the library instead of dealing with binaries.
How to compile VMime from SVN?
First, you have to check out VMime’s SVN repository with the following instruction set.
svn co https://vmime.svn.sourceforge.net/svnroot/vmime/trunk vmime
We are going to compile VMime using autotools (configure, make).
As the Makefiles are not stored in the SVN, we need to generate them:
scons sendmail_path=foo autotools
(Note: sendmail_path is not used when using autotools, the value does not matter, but it must be specified on the command line).
Then, compile VMime the classical way:
If you want to install the libs and the header files on your system, become root
Why GPL and not LGPL?
Yes, VMime is licensed under the GNU GPL license.
So, why I have not chosen LGPL license? Because VMime is Free Software, and in my opinion, the LGPL is not enough Free (I mean, from the end user’s point of view). LGPL does not help to promote Free Software as it permits to create proprietary programs based on Free libraries.
However, if you absolutely need to use VMime in your proprietary program, check out our Dual Licensing.
Is VMime thread-safe?
VMime is thread-safe in the sense you can have multiple threads running VMime code at the same time.
What you can NOT do is to share VMime objects (for writing) between threads. For example, you should NOT modify the same
bodyPart object from two threads at the same time (reading is OK) unless you write your own synchronization mechanism between the calls.
If you are using the messaging module, it is OK to access multiple mailboxes (
store objects) from multiple threads (each thread accesses one mailbox).
The rest of the code (parser, utils, etc.) is thread-safe as long as (again…) you don’t share the objects (body parts, mailboxes, etc.) between multiple threads.
There are some singleton objects in VMime. There is absolutely no problem when instanciating a VMime singleton for the first time within multi-threaded code. Instanciation of all singletons is forced when VMime is initialized (static code, executed before your
I called deleteMessage() to delete a message from a store, but the message is not actually deleted!
folder->close(true) to expunge messages marked as deleted.
How many projects use VMime?
Currently, the following projects are known to use VMime:
If your project makes use of VMime and you want it to be listed here, please contact me.
I have found a bug in VMime. What should I do?
First, please ensure that your bug is not already listed in the bug request manager. Then, if your bug does not exist, then open a new bug report and provide as much information as possible (OS version, VMime version, minimal example code, steps to reproduce…). We will try to have a look at it as soon as possible.
I have made a patch for VMime. May I send it to you?
Sure! You are encouraged to contribute to VMime source code, this is a basic in Open Source development.
Please ensure your patch is well tested and does not break other parts in the library (you can run the unit tests of the distribution, and write your own tests). Then, you can publish your patch in the Patch tracker
or send us an email.
Also, be sure to read the VMime coding guidelines to know more about coding conventions and code quality.