You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-dev@james.apache.org by er...@apache.org on 2012/06/27 09:47:29 UTC
svn commit: r1354354 - /james/site/trunk/www/server/3/dev-provided-mailets.html

Author: eric
Date: Wed Jun 27 07:47:28 2012
New Revision: 1354354

URL: http://svn.apache.org/viewvc?rev=1354354&view=rev
Log:
deploy ToSenderFolder mailet documentation (JAMES-1365)

Modified:
    james/site/trunk/www/server/3/dev-provided-mailets.html

Modified: james/site/trunk/www/server/3/dev-provided-mailets.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/server/3/dev-provided-mailets.html?rev=1354354&r1=1354353&r2=1354354&view=diff
==============================================================================
--- james/site/trunk/www/server/3/dev-provided-mailets.html (original)
+++ james/site/trunk/www/server/3/dev-provided-mailets.html Wed Jun 27 07:47:28 2012
@@ -18,7 +18,7 @@
   under the License.    
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- Generated by Apache Maven Doxia at Jun 17, 2012 -->
+<!-- Generated by Apache Maven Doxia at Jun 27, 2012 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
@@ -37,10 +37,10 @@
     <script type="text/javascript" src="./js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script>
     <script type="text/javascript" src="./js/fancybox/jquery.fancybox-1.3.4.js"></script>
     <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
-    <meta name="Date-Revision-yyyymmdd" content="20120617" />
+    <meta name="Date-Revision-yyyymmdd" content="20120627" />
     <meta http-equiv="Content-Language" content="en" />
                                                     
-<link title="DOAP" rel="meta" type="application/rdf+xml" href="http://james.apache.org//doap_james-project.rdf"/>
+<link type="application/rdf+xml" title="DOAP" rel="meta" href="http://james.apache.org//doap_james-project.rdf"/>
                       
           <!-- Google Analytics -->
     <script type="text/javascript">
@@ -77,7 +77,7 @@
             
                 
                 <div class="xleft">
-        <span id="publishDate">Last Published: 2012-06-17</span>
+        <span id="publishDate">Last Published: 2012-06-27</span>
                       </div>
             <div class="xright">                    <a href="../../index.html" title="Home">Home</a>
             |
@@ -811,15 +811,26 @@ present, no error message is set.</li>
 
 </div>
 
-<div class="section"><h3>ToFolder<a name="ToFolder"></a></h3>
-  <p>Description: ...</p>
+<div class="section"><h3>ToSenderFolder<a name="ToSenderFolder"></a></h3>
+  <p>
+    Description: Place a copy of the mail message in a folder of the sender. It needs to be used in combination
+    with the SenderIsLocal matcher
+  </p>
   
   <p>Parameters:
     </p><ul>
-      <li><b>...</b> (required) - ....</li>
-      <li><b>...</b> (optional) - ....</li>
+      <li><b>folder</b> (required) - The folder name of the Sender mailbox in which the mail will be copied.</li>
+      <li><b>consume</b> (optional) - flag tru or false: will tell is the mail will be further processed by the upcoming processor mailets, or not</li>
     </ul>
   
+  
+  <div class="source"><pre>
+&lt;mailet match=&quot;SenderIsLocal&quot; class=&quot;ToSenderFolder&quot;&gt;
+  &lt;folder&gt;Sent&lt;/folder&gt;
+  &lt;consume&gt;false&lt;/consume&gt;
+&lt;/mailet&gt;
+  </pre></div>
+  
 </div>
 
 <div class="section"><h3>ToMultiRepository<a name="ToMultiRepository"></a></h3>