svn commit: r819264 - in /ofbiz/trunk: applications/commonext/documen
Locked
 
|
Author: hansbak
Date: Sun Sep 27 06:35:01 2009 New Revision: 819264 URL: http://svn.apache.org/viewvc?rev=819264&view=rev Log: added a section about sending and receiving email and reorganized the framework sections Added: ofbiz/trunk/framework/base/documents/ReceivingEmail.xml (with props) ofbiz/trunk/framework/common/documents/ ofbiz/trunk/framework/common/documents/FrameworkCommon.xml (with props) ofbiz/trunk/framework/common/documents/SendingEmail.xml (with props) Modified: ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml ofbiz/trunk/framework/base/documents/FrameworkBase.xml ofbiz/trunk/framework/documents/Framework.xml Modified: ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml?rev=819264&r1=819263&r2=819264&view=diff ============================================================================== --- ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml (original) +++ ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml Sun Sep 27 06:35:01 2009 @@ -120,15 +120,13 @@ </listitem> </orderedlist> </section> - - - <xi:include href="../../../framework/documents/Framework.xml"/> - - </chapter> - - - + <xi:include href="../../../framework/documents/Framework.xml"/> + <xi:include href="../../../framework/base/documents/FrameworkBase.xml" /> + <xi:include href="../../../framework/common/documents/FrameworkCommon.xml" /> + <xi:include href="../../../framework/entity/documents/EntityEngine.xml" /> + <xi:include href="../../../framework/service/documents/ServiceEngine.xml" /> + <xi:include href="../../../framework/webtools/documents/Webtools.xml" /> <appendix> <title>The Apache OFBiz documentation system</title> Modified: ofbiz/trunk/framework/base/documents/FrameworkBase.xml URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/documents/FrameworkBase.xml?rev=819264&r1=819263&r2=819264&view=diff ============================================================================== --- ofbiz/trunk/framework/base/documents/FrameworkBase.xml (original) +++ ofbiz/trunk/framework/base/documents/FrameworkBase.xml Sun Sep 27 06:35:01 2009 @@ -17,23 +17,16 @@ specific language governing permissions and limitations under the License. --> -<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" +<chapter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd" xmlns="http://docbook.org/ns/docbook"> <title>Framework Base components</title> <para> This part of the framework contain the basic components like the several different connectors, catalina(tomcat) - which are the base of the other framwork. + which are the base of the other framework. </para> - <section> - <title>Java Mail Listener</title> - <para> - The java mail listener will logon to the mailserver as defined in the config/ofbiz-containers.xml and will - receive the mail present in the POP/IMAP mail account. When mail is received it will trigger MCA rules. - Examples of MCA files can be found in the party and content component. - </para> - </section> -</section> + <xi:include href="ReceivingEmail.xml" /> +</chapter> Added: ofbiz/trunk/framework/base/documents/ReceivingEmail.xml URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/documents/ReceivingEmail.xml?rev=819264&view=auto ============================================================================== --- ofbiz/trunk/framework/base/documents/ReceivingEmail.xml (added) +++ ofbiz/trunk/framework/base/documents/ReceivingEmail.xml Sun Sep 27 06:35:01 2009 @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> +<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" + xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd" + xmlns="http://docbook.org/ns/docbook"> + <title>Receiving Email.</title> + <para> + OFBiz can receive email for multiple email addresses and via an MCA can create Communication events + for the involved parties of the email. Email attachments, via again the MCA are stored in the content component + and can be accessed via the content Id. Examples of an MCA can be found in the Party and Content Component. + </para> + <para> + To receive email a single POP/IMAP mailbox is polled at regular intervals. This is configured in the + ${ofbiz install dir}/framework/base/config/ofbiz-containers.xml file. Any email address you want to be handled + by OFBiz need to be forwarded to this single mailbox by an external mail server. OFBiz then will try to match the + email addresses to existing parties and will create a single communication event referring to the found parties. + </para> + <para> + If an incoming email address cannot be matched against a party, the communication event will get a special status + and the receiving party can either delete the communication event or can ask the system to automatically create a party + from the incoming email address. + </para> + <para> + By default the configuaration file has the email poller commented out. The parameters to this function are pretty self + explanatory. + </para> +</section> + Propchange: ofbiz/trunk/framework/base/documents/ReceivingEmail.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/trunk/framework/base/documents/ReceivingEmail.xml ------------------------------------------------------------------------------ svn:keywords = "Date Rev Author URL Id" Propchange: ofbiz/trunk/framework/base/documents/ReceivingEmail.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/trunk/framework/common/documents/FrameworkCommon.xml URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/common/documents/FrameworkCommon.xml?rev=819264&view=auto ============================================================================== --- ofbiz/trunk/framework/common/documents/FrameworkCommon.xml (added) +++ ofbiz/trunk/framework/common/documents/FrameworkCommon.xml Sun Sep 27 06:35:01 2009 @@ -0,0 +1,30 @@ +<?xml version="1.0"?> +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> +<chapter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xsi:schemaLocation="http://docbook.org/ns/docbook ../../content/dtd/docbook.xsd" + xmlns="http://docbook.org/ns/docbook"> + <title>The Framework Common Component.</title> + <para> + The framework Common component contains all functions which do not justify a separate framework component. + </para> + <xi:include href="SendingEmail.xml" /> +</chapter> Propchange: ofbiz/trunk/framework/common/documents/FrameworkCommon.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/trunk/framework/common/documents/FrameworkCommon.xml ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/trunk/framework/common/documents/FrameworkCommon.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Added: ofbiz/trunk/framework/common/documents/SendingEmail.xml URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/common/documents/SendingEmail.xml?rev=819264&view=auto ============================================================================== --- ofbiz/trunk/framework/common/documents/SendingEmail.xml (added) +++ ofbiz/trunk/framework/common/documents/SendingEmail.xml Sun Sep 27 06:35:01 2009 @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> +<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0" + xmlns:xl="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xsi:schemaLocation="http://docbook.org/ns/docbook ../../../applications/content/dtd/docbook.xsd" + xmlns="http://docbook.org/ns/docbook"> + <title>Sending Email in OFBiz</title> + <para> + Various parts in the OFBiz application are sending out email for various reasons. Sending out email is controlled in the + ${ofbiz install dir}/framework/common/config/general.properties file with the following parameters: + <orderedlist> + <listitem><para> + SMTP Server (relay host): mail.smtp.relay.host + </para></listitem> + <listitem><para> + SMTP Username (if needed): mail.smtp.auth.user + </para></listitem> + <listitem><para> + SMTP Password (if needed): mail.smtp.auth.password + </para></listitem> + <listitem><para> + Turn on email notifications by setting the mail.notifications.enabled property to "Y". + </para></listitem> + </orderedlist> + </para> +</section> + Propchange: ofbiz/trunk/framework/common/documents/SendingEmail.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/trunk/framework/common/documents/SendingEmail.xml ------------------------------------------------------------------------------ svn:keywords = "Date Rev Author URL Id" Propchange: ofbiz/trunk/framework/common/documents/SendingEmail.xml ------------------------------------------------------------------------------ svn:mime-type = text/xml Modified: ofbiz/trunk/framework/documents/Framework.xml URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/documents/Framework.xml?rev=819264&r1=819263&r2=819264&view=diff ============================================================================== --- ofbiz/trunk/framework/documents/Framework.xml (original) +++ ofbiz/trunk/framework/documents/Framework.xml Sun Sep 27 06:35:01 2009 @@ -21,16 +21,8 @@ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xsi:schemaLocation="http://docbook.org/ns/docbook ../../applications/content/dtd/docbook.xsd" xmlns="http://docbook.org/ns/docbook"> - <title>The OFBiz Framework.</title> - <section> - <title>Introduction.</title> - <para> - For a core configuration guide check <link xl:href="http://ofbiz.apache.org/docs/coreconfig.html">the OFBiz website.</link> - </para> - </section> - <xi:include href="../base/documents/FrameworkBase.xml" /> - <xi:include href="../entity/documents/EntityEngine.xml" /> - <xi:include href="../service/documents/ServiceEngine.xml" /> - <xi:include href="../webtools/documents/Webtools.xml" /> - + <title>The OFBiz Framework Introduction.</title> + <para> + For a core configuration guide check <link xl:href="http://ofbiz.apache.org/docs/coreconfig.html">the OFBiz website.</link> + </para> </chapter> |
«
Return to OFBiz - Commits
|
1 view|%1 views
| Free forum by Nabble | Edit this page |