Using Offline IMAP in a larger project

Nicholas Cole nicholas.cole at
Wed Sep 4 09:25:15 BST 2013

On Wed, Sep 4, 2013 at 9:13 AM, Eygene Ryabinkin <rea at> wrote:
> Nicholas, good day.
> Tue, Sep 03, 2013 at 06:19:47PM +0100, Nicholas Cole wrote:
>> I know that OfflineIMAP was designed to be used as part of larger
>> projects as well as stand-alone, but all the documentation I can find
>> is really about how to run it as a stand-alone application.  Apologies
>> if I am missing something.  I'd like to use it to provide
>> (essentially) the IMAP support of a larger project, so that I only
>> have to worry about working on local folders and not the intricacies
>> of IMAP.  I'm sure I can hack something together, but is there any
>> documentation on how to do this well?
> Do you mean that you want to embed or use (parts of) OfflineIMAP
> programmatically into some other software product or you just want
> to use OfflineIMAP as the utility in the bigger project?
> If you'll try to explicitely describe what you intend to do, may be
> it will be more clear how and if we can help you with that.

Sorry for not being clear.  I'd like my users to enter their IMAP
details in my application, and to use OfflineIMAP to maintain a local
cache of the IMAP account that is then synced with the IMAP account,
without my users ever being aware that they are using OfflineIMAP at

My main application would no doubt need to check for dropped
connections and other errors, and manage all the configuration and
operation of OfflineIMAP.  So I guess what I had in mind is embedding
OfflineIMAP into another product.  What I don't want my users to have
to do is worrying about configuring OfflineIMAP themselves, or
starting and stopping it.  I'd like it to be entirely transparent to
the user.  I assume that there are different ways of achieving

Best wishes,


More information about the OfflineIMAP-project mailing list