Welcome to OfflineIMAP’s developer documentation

License

Developer’s Certificate of Origin (dco)

Documented APIs

• offlineimap's API documentation
• offlineimap – The OfflineImap module
  • OfflineImap
    • OfflineImap.__deletefolder()
    • OfflineImap.__dumpstacks()
    • OfflineImap.__migratefmd5()
    • OfflineImap.__parse_cmd_options()
    • OfflineImap.__serverdiagnostics()
    • OfflineImap.__sync()
    • OfflineImap.__sync_singlethreaded()
    • OfflineImap._get_activeaccounts()
    • OfflineImap.get_env_info()
    • OfflineImap.run()
• offlineimap.account
  • Account
  • SyncableAccount
    • SyncableAccount.get_abort_event()
    • SyncableAccount.get_local_folder()
    • SyncableAccount.getconf()
    • SyncableAccount.getconf_xform()
    • SyncableAccount.getconfboolean()
    • SyncableAccount.getconffloat()
    • SyncableAccount.getconfig()
    • SyncableAccount.getconfint()
    • SyncableAccount.getconflist()
    • SyncableAccount.getsection()
    • SyncableAccount.serverdiagnostics()
    • SyncableAccount.set_abort_event()
    • SyncableAccount.syncrunner()
  • OfflineImapError – A Notmuch execution error
    • OfflineImapError
      • OfflineImapError.ERROR
• offlineimap.globals – module with global variables
  • options
  • set_options()
• offlineimap.repository – Email repositories
  • Repository
• offlineimap.repository.Base.BaseRepository – Representation of a mail repository
  • BaseRepository
    • BaseRepository.accountname
    • BaseRepository.connect()
    • BaseRepository.deletefolder()
    • BaseRepository.dropconnections()
    • BaseRepository.forgetfolders()
    • BaseRepository.getaccount()
    • BaseRepository.getconf()
    • BaseRepository.getconf_xform()
    • BaseRepository.getconfboolean()
    • BaseRepository.getconffloat()
    • BaseRepository.getconfig()
    • BaseRepository.getconfint()
    • BaseRepository.getconflist()
    • BaseRepository.getfolder()
    • BaseRepository.getfolders()
    • BaseRepository.getkeywordmap()
    • BaseRepository.getlocaleval()
    • BaseRepository.getlocalroot()
    • BaseRepository.getmapdir()
    • BaseRepository.getname()
    • BaseRepository.getsection()
    • BaseRepository.getsep()
    • BaseRepository.getuiddir()
    • BaseRepository.holdordropconnections()
    • BaseRepository.makefolder()
    • BaseRepository.readonly
    • BaseRepository.restore_atime()
    • BaseRepository.should_create_folders()
    • BaseRepository.should_sync_folder()
    • BaseRepository.startkeepalive()
    • BaseRepository.stopkeepalive()
    • BaseRepository.sync_folder_structure()
  • IMAPRepository
  • MappedIMAPRepository
  • GmailRepository
  • MaildirRepository
  • LocalStatusRepository
• offlineimap.folder – Basic representation of a local or remote Mail folder
  • BaseFolder
    • BaseFolder.accountname
    • BaseFolder.addmessageflags()
    • BaseFolder.addmessageheader()
    • BaseFolder.addmessagelabels()
    • BaseFolder.addmessagesflags()
    • BaseFolder.addmessageslabels()
    • BaseFolder.cachemessagelist()
    • BaseFolder.change_message_uid()
    • BaseFolder.check_uidvalidity()
    • BaseFolder.combine_flags_and_keywords()
    • BaseFolder.copymessageto()
    • BaseFolder.deletemessage()
    • BaseFolder.deletemessageflags()
    • BaseFolder.deletemessageheaders()
    • BaseFolder.deletemessagelabels()
    • BaseFolder.deletemessages()
    • BaseFolder.deletemessagesflags()
    • BaseFolder.deletemessageslabels()
    • BaseFolder.dofsync()
    • BaseFolder.dropmessagelistcache()
    • BaseFolder.get_message_date()
    • BaseFolder.get_min_uid_file()
    • BaseFolder.get_saveduidvalidity()
    • BaseFolder.get_uidvalidity()
    • BaseFolder.getexplainedname()
    • BaseFolder.getfolderbasename()
    • BaseFolder.getfullname()
    • BaseFolder.getinstancelimitnamespace()
    • BaseFolder.getmaxage()
    • BaseFolder.getmaxsize()
    • BaseFolder.getmessage()
    • BaseFolder.getmessagecount()
    • BaseFolder.getmessageflags()
    • BaseFolder.getmessageheader()
    • BaseFolder.getmessageheaderlist()
    • BaseFolder.getmessagekeywords()
    • BaseFolder.getmessagelabels()
    • BaseFolder.getmessagelist()
    • BaseFolder.getmessagemtime()
    • BaseFolder.getmessagetime()
    • BaseFolder.getmessageuidlist()
    • BaseFolder.getname()
    • BaseFolder.getrepository()
    • BaseFolder.getroot()
    • BaseFolder.getsep()
    • BaseFolder.getstartdate()
    • BaseFolder.getvisiblename()
    • BaseFolder.ismessagelistempty()
    • BaseFolder.msglist_item_initializer()
    • BaseFolder.quickchanged()
    • BaseFolder.retrieve_min_uid()
    • BaseFolder.save_min_uid()
    • BaseFolder.save_uidvalidity()
    • BaseFolder.savemessage()
    • BaseFolder.savemessageflags()
    • BaseFolder.savemessagelabels()
    • BaseFolder.storesmessages()
    • BaseFolder.suggeststhreads()
    • BaseFolder.sync_this
    • BaseFolder.syncmessagesto()
    • BaseFolder.uidexists()
    • BaseFolder.waitforthread()
• offlineimap.ui – A flexible logging system
  • ui.setglobalui()
  • ui.getglobalui()
  • Base UI plugin
    • UIBase
      • UIBase.acct()
      • UIBase.acctdone()
      • UIBase.connecting()
      • UIBase.copyingmessage()
      • UIBase.error()
      • UIBase.getnicename()
      • UIBase.getthreadaccount()
      • UIBase.ignorecopyingmessage()
      • UIBase.info()
      • UIBase.init_banner()
      • UIBase.isusable()
      • UIBase.makefolder()
      • UIBase.registerthread()
      • UIBase.savemessage()
      • UIBase.serverdiagnostics()
      • UIBase.setlogfile()
      • UIBase.setup_consolehandler()
      • UIBase.setup_sysloghandler()
      • UIBase.skippingfolder()
      • UIBase.sleep()
      • UIBase.sleeping()
      • UIBase.syncfolders()
      • UIBase.syncingfolder()
      • UIBase.terminate()
      • UIBase.threadException()
      • UIBase.threadExited()
      • UIBase.unregisterthread()

License:

This module is covered under the GNU GPL v2 (or later).