repository.rst 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. .. currentmodule:: offlineimap.repository
  2. :mod:`offlineimap.repository` -- Email repositories
  3. ------------------------------------------------------------
  4. A derivative of class
  5. :class:`Base.BaseRepository` represents an email
  6. repository depending on the type of storage, possible options are:
  7. * :class:`IMAPRepository`,
  8. * :class:`MappedIMAPRepository`
  9. * :class:`GmailRepository`,
  10. * :class:`MaildirRepository`, or
  11. * :class:`LocalStatusRepository`.
  12. Which class you need depends on your account
  13. configuration. The helper class :class:`offlineimap.repository.Repository` is
  14. an *autoloader*, that returns the correct class depending
  15. on your configuration. So when you want to instanciate a new
  16. :mod:`offlineimap.repository`, you will mostly do it through this class.
  17. .. autoclass:: offlineimap.repository.Repository
  18. :members:
  19. :inherited-members:
  20. :mod:`offlineimap.repository.Base.BaseRepository` -- Representation of a mail repository
  21. ------------------------------------------------------------------------------------------
  22. .. autoclass:: offlineimap.repository.Base.BaseRepository
  23. :members:
  24. :inherited-members:
  25. :undoc-members:
  26. .. .. note:: :meth:`foo`
  27. .. .. attribute:: Database.MODE
  28. Defines constants that are used as the mode in which to open a database.
  29. MODE.READ_ONLY
  30. Open the database in read-only mode
  31. MODE.READ_WRITE
  32. Open the database in read-write mode
  33. .. autoclass:: offlineimap.repository.IMAPRepository
  34. .. autoclass:: offlineimap.repository.MappedIMAPRepository
  35. .. autoclass:: offlineimap.repository.GmailRepository
  36. .. autoclass:: offlineimap.repository.MaildirRepository
  37. .. autoclass:: offlineimap.repository.LocalStatusRepository
  38. :mod:`offlineimap.folder` -- Basic representation of a local or remote Mail folder
  39. ---------------------------------------------------------------------------------------------------------
  40. .. autoclass:: offlineimap.folder.Base.BaseFolder
  41. :members:
  42. :inherited-members:
  43. :undoc-members:
  44. .. .. attribute:: Database.MODE
  45. Defines constants that are used as the mode in which to open a database.
  46. MODE.READ_ONLY
  47. Open the database in read-only mode
  48. MODE.READ_WRITE
  49. Open the database in read-write mode