--------------------------------------------------
CPSWebMail INSTALL
--------------------------------------------------

$Id: INSTALL.txt 17789 2004-08-19 16:30:20Z atchertchian $

Authors:
- Anahide Tchertchian (at@nuxeo.com)

--------------------------------------------------
Summary
--------------------------------------------------

- Requirements
- Installation notes

--------------------------------------------------
Requirements
--------------------------------------------------

  - Zope-2.5.1 or later.

  - CPS3.1

  - CPSDirectory >= 1.16.0 to be able to use personal address books.

--------------------------------------------------
Installation notes
--------------------------------------------------

    Unpack the relase in the Products directory, and rename it from
    CPSWebMail-<version> to CPSWebMail. Restart Zope.

    In the cps root, create an External Method object called cpswebmail_update
    or something similar. The settings should be:
       Module Name:   CPSWebMail.install
       Function Name: install

    After creating, open the External Method object and click the "Test" tab to
    run it. The output should look similar to this:


        Starting CPSWebMail update

         Checking available languages
          Checking installable languages
            Available languages: ('en', 'fr')
            Importing en.po into 'en' locale
            Importing fr.po into 'fr' locale
        Verifying skins
         FS Directory View 'cpswebmail_images'
          Creating skin
         FS Directory View 'cpswebmail_javascript'
          Creating skin
         FS Directory View 'cpswebmail_default'
          Creating skin
         Fixup of skin Basic
        Resetting skin cache
        Verifying tool portal_webMail
         Adding
         Verifying action webmail...added.
         Setting up schemas and layouts
         Setting up default address book directories
         Directory .addressbook
         Directory addressbook
         Directory .addressbook_links
        Address book directories added
        Verifiying schemas
         Adding schema addressbook_search
          Field sn.
          Field givenName.
          Field email.
          Field id.
         Adding schema addressbook
          Field fullname.
          Field givenName.
          Field email.
          Field sn.
          Field id.
         Adding layout addressbook_search
          Widget email
          Widget givenName
          Widget id
          Widget sn
         Adding layout addressbook_links
          Widget email
          Widget fullname
          Widget givenName
          Widget id
          Widget sn
         Adding layout addressbook
          Widget email
          Widget fullname
          Widget givenName
          Widget id
          Widget sn
        Schemas and layouts related to address book directories added
        Setting up vocabulary needed in the id widget, in the addressbook_links layout
         Adding vocabulary addressbook_links
          Installing.
        Vocabulary addressbook added
        Setting up default mailing lists directory
         Directory mailinglists
        Mailing lists directory added
        Verifiying schemas
         Adding schema mailinglists
          Field id.
          Field emails.
         Adding layout mailinglists
          Widget emails
          Widget id
         Adding layout mailinglists_search
          Widget emails
          Widget id
        Schemas and layouts related to mailing lists directory added
        End of specific CPSWebmail updates


    CPSWebMail is now installed.

    Go to the cps root, and click on the portal_webMail tool in the
    ZMI. Change the default parameters set on the properties tab.

    - title
    - IMAPServer*: localhost (your IMAP server address)
    - IMAPPort*: 143 (your IMAP server port)
    - SMTPServer*: localhost (your SMTP server address)
    - SMTPPort*: 25 (your SMTP server port)
    - IMAPLoginField*: imap_login
    - IMAPPasswordField*: imap_password
    - Addressbook_name*: addressbook
    - AddressbookEmailProp*: email
    - PrivAddressbook_name: .addressbook
    - PrivAddressbookEmailProp: email
    - PrivAddressbookLinks_name: .addressbook_links
    - PrivAddressbookLinksEmailProp: email
    - Mailing_list_name: mailinglists
    - MailingEmailsProp: emails
  	- EnableMembersMailing: yes/no
    - EnableGroupsMailing: yes/no
    - GroupsDirectory_name**: groups
    - EnableWorkspaceMembersMailing: yes/no
    - EnableSaveAttachments: yes/no

    * this property is required
    ** required if EnableGroupsMailing is set to yes.

    Each user will have to set its "imap_login" and "imap_password" in its
    preferences stored in the members directory to have access to its
    mails, unless IMAPLoginField and IMAPPasswordField are set to use other
    fields to get the IMAP login and pasword.
    WARNING: passwords may be protected in some directories, and CPSWebMail
    may not be able to access them.

    Please read the README file to know what features these properties give,
    and to know how to setup address books.


