err.no Git - scalable-opengroupware.org/blob - SOGo/SoObjects/Mailer/README

   1 # README for Mailer SoObjects
   2
   3 Class Overview
   4 ==============
   5
   6 SOGoMailManager
   7 - backend class connecting to NGImap4, will probably move to SOGoLogic
   8
   9 Class Hierarchy
  10 ===============
  11
  12 [NSObject]
  13   SOGoMailerProduct
  14   <SOGoObject>
  15     SOGoMailAccounts
  16     SOGoMailBaseObject
  17       SOGoDraftObject
  18       SOGoDraftsFolder
  19       SOGoMailAccount
  20         SOGoSharedMailAccount
  21       SOGoMailBodyPart
  22         SOGoImageMailBodyPart
  23         SOGoMessageMailBodyPart
  24       SOGoMailFolder
  25         SOGoSharedInboxFolder
  26       SOGoMailObject
  27   [EODataSource]
  28     SOGoMailFolderDataSource
  29
  30 Defaults
  31 ========
  32
  33 SOGoEnableIMAP4Debug       YES|NO - enable/disable debugging in SOGoMailManager
  34 SOGoDisableIMAP4Pooling    YES|NO - disable IMAP4 connection pooling
  35 SOGoMailSpoolPath          path   - FS path where mail drafts are stored
  36 SOGoNoDraftDeleteAfterSend YES|NO - makes the draft's -delete method a NOOP
  37
  38 SOGoSpecialFoldersInRoot   YES|NO - do special folders live under INBOX?
  39   - corresponds to the Cyrus setting: "altnamespace: yes"
  40 SOGoEnableSieveFolder      YES|NO - should the Sieve folder be visible?
  41
  42 SOGoSharedFolderName       IMAP4-Name
  43   - corresponds to the Cyrus setting: sharedprefix
  44 SOGoOtherUsersFolderName   IMAP4-Name
  45   - corresponds to the Cyrus setting: userprefix
  46
  47 SOGoInternetMailSuffix     String-Pattern
  48   - suffix to add to mails sent via Internet
  49   - eg: -SOGoInternetMailSuffix \
  50         '"*** This email was composed using SOGo on the public Internet ***"'
  51     you can access request values inside the pattern, eg:
  52          "$headers.host$"
  53
  54 SOGoDoNotFetchMailHeader   YES|NO - whether or not to fetch the mail header
  55   - the mail header is ~4KB to fetch, a slowdown of ~13ms on the dev system
  56   - the header gives much more information about the mail
  57     - eg: spam status
  58   - parsing the mail header takes time