[ofbiz-framework] 05/11: Documented: Framework/base migration to asciidoc (OFBIZ-11587)

[ho...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

holivier pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git

commit 2c700e86af00afa3f70e4267fb8ab2d774e231f2
Author: holivier <ho...@apache.org>
AuthorDate: Fri Apr 10 16:06:05 2020 +0200

    Documented: Framework/base  migration to asciidoc
    (OFBIZ-11587)
    
    only one file about receiving email, so create email.adoc which included
    receiving and later sending.
    email.adoc is included in developer-manual.adoc in deployment section
---
 docs/asciidoc/developer-manual.adoc                |  2 ++
 .../docs/asciidoc/_include/email-receiving.adoc    | 39 ++++++++++++++++++++++
 framework/base/src/docs/asciidoc/email.adoc        | 23 +++++++++++++
 3 files changed, 64 insertions(+)

diff --git a/docs/asciidoc/developer-manual.adoc b/docs/asciidoc/developer-manual.adoc
index 6895acd..3e07ab9 100644
--- a/docs/asciidoc/developer-manual.adoc
+++ b/docs/asciidoc/developer-manual.adoc
@@ -273,6 +273,8 @@ include::../../themes/docs/themes.adoc[leveloffset=+2]
 
 == Deployment
 
+include::../../framework/base/src/docs/asciidoc/email.adoc[leveloffset=+2]
+
 include::../../framework/security/src/docs/asciidoc/security.adoc[leveloffset=+1]
 
 == Appendices
diff --git a/framework/base/src/docs/asciidoc/_include/email-receiving.adoc b/framework/base/src/docs/asciidoc/_include/email-receiving.adoc
new file mode 100644
index 0000000..2e3c7c2
--- /dev/null
+++ b/framework/base/src/docs/asciidoc/_include/email-receiving.adoc
@@ -0,0 +1,39 @@
+////
+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.
+////
+= Receiving Email.
+
+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.
+
+To receive email a single POP/IMAP mailbox is polled at regular intervals. +
+This is configured in the ${ofbiz install dir}/framework/service/ofbiz-component.xml file in the commented section
+JavaMail Listener Container.
+
+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.
+
+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.
+
+By default the configuaration file has the email poller commented out. +
+The parameters to this function are pretty self explanatory.
\ No newline at end of file
diff --git a/framework/base/src/docs/asciidoc/email.adoc b/framework/base/src/docs/asciidoc/email.adoc
new file mode 100644
index 0000000..6408da3
--- /dev/null
+++ b/framework/base/src/docs/asciidoc/email.adoc
@@ -0,0 +1,23 @@
+////
+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.
+////
+= email
+
+== HowTo use email in OFBiz
+
+include::_include/email-receiving.adoc[leveloffset=+2]