Code

* Created "old" branch and moved stuff
[gosa.git] / branches / old / gosa-core / doc / devel / html / classmailAccount.html
diff --git a/branches/old/gosa-core/doc/devel/html/classmailAccount.html b/branches/old/gosa-core/doc/devel/html/classmailAccount.html
new file mode 100644 (file)
index 0000000..febb30e
--- /dev/null
@@ -0,0 +1,224 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>GOsa: mailAccount class Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.3.2 -->
+<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Compound&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a></div>
+<h1>mailAccount Class Reference</h1>mail plugin  
+<a href="#_details">More...</a>
+<p>
+<p>Inheritance diagram for mailAccount:
+<p><center><img src="classmailAccount.png" usemap="#mailAccount_map" border="0" alt=""></center>
+<map name="mailAccount_map">
+<area href="classplugin.html" alt="plugin" shape="rect" coords="0,0,81,24">
+</map>
+<a href="classmailAccount-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
+<tr><td></td></tr>
+<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a0" doxytag="mailAccount::mailAccount"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>mailAccount</b> ($<a class="el" href="classplugin.html#o4">dn</a>=NULL, $shared_folder=FALSE)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a1" doxytag="mailAccount::getImapAttributes"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>getImapAttributes</b> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a2" doxytag="mailAccount::setImapAttributes"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>setImapAttributes</b> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a3" doxytag="mailAccount::setSieveAttributes"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>setSieveAttributes</b> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classmailAccount.html#a4">execute</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">execute plugin </em> <a href="#a4"></a><em><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a5" doxytag="mailAccount::remove_from_parent"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>remove_from_parent</b> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a6" doxytag="mailAccount::save_object"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>save_object</b> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a7" doxytag="mailAccount::save"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>save</b> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a8" doxytag="mailAccount::check"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>check</b> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a9" doxytag="mailAccount::adapt_from_template"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>adapt_from_template</b> ($<a class="el" href="classplugin.html#o4">dn</a>)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a10" doxytag="mailAccount::addForwarder"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>addForwarder</b> ($address)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a11" doxytag="mailAccount::delForwarder"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>delForwarder</b> ($addresses)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a12" doxytag="mailAccount::addAlternate"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>addAlternate</b> ($address)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a13" doxytag="mailAccount::delAlternate"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>delAlternate</b> ($addresses)</td></tr>
+
+<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o0" doxytag="mailAccount::mail"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>mail</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o1" doxytag="mailAccount::gosaMailAlternateAddress"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>gosaMailAlternateAddress</b> = array()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o2" doxytag="mailAccount::gosaMailForwardingAddress"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>gosaMailForwardingAddress</b> = array()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o3" doxytag="mailAccount::gosaMailDeliveryMode"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>gosaMailDeliveryMode</b> = "[L ]"</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o4" doxytag="mailAccount::gosaMailServer"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>gosaMailServer</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o5" doxytag="mailAccount::gosaMailQuota"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>gosaMailQuota</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o6" doxytag="mailAccount::gosaMailMaxSize"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>gosaMailMaxSize</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o7" doxytag="mailAccount::gosaVacationMessage"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>gosaVacationMessage</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o8" doxytag="mailAccount::gosaSpamSortLevel"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>gosaSpamSortLevel</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o9" doxytag="mailAccount::gosaSpamMailbox"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>gosaSpamMailbox</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o10" doxytag="mailAccount::quotaUsage"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>quotaUsage</b> = 0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o11" doxytag="mailAccount::forward_dialog"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>forward_dialog</b> = FALSE</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o12" doxytag="mailAccount::folder_prefix"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>folder_prefix</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o13" doxytag="mailAccount::mailboxList"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>mailboxList</b> = array()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o14" doxytag="mailAccount::default_permissions"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>default_permissions</b> = "none"</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o15" doxytag="mailAccount::member_permissions"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>member_permissions</b> = "post"</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o16" doxytag="mailAccount::members"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>members</b> = array()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o17" doxytag="mailAccount::admins"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>admins</b> = array()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><b>perms</b></td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><b>attributes</b></td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o20" doxytag="mailAccount::objectclasses"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>objectclasses</b> = array("gosaMailAccount")</td></tr>
+
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+mail plugin 
+<p>
+<dl compact><dt><b>Author:</b></dt><dd>Cajus Pollmeier &lt;<a href="mailto:pollmeier@gonicus.de">pollmeier@gonicus.de</a>&gt; </dd></dl>
+<dl compact><dt><b>Version:</b></dt><dd>2.00 </dd></dl>
+<dl compact><dt><b>Date:</b></dt><dd>24.07.2003</dd></dl>
+This class provides the functionality to read and write all attributes relevant for gosaMailAccounts from/to the LDAP. It does syntax checking and displays the formulars required. 
+<p>
+<hr><h2>Member Function Documentation</h2>
+<a name="a4" doxytag="mailAccount::execute"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> mailAccount::execute </td>
+          <td class="md" valign="top">(&nbsp;</td>
+          <td class="mdname1" valign="top" nowrap>          </td>
+          <td class="md" valign="top">&nbsp;)&nbsp;</td>
+          <td class="md" nowrap></td>
+        </tr>
+
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+execute plugin 
+<p>
+Generates the html output for this node 
+<p>
+Reimplemented from <a class="el" href="classplugin.html#a1">plugin</a>.    </td>
+  </tr>
+</table>
+<hr><h2>Member Data Documentation</h2>
+<a name="o19" doxytag="mailAccount::attributes"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> mailAccount::attributes
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+<b>Initial value:</b><div class="fragment"><pre> array(<span class="stringliteral">"mail"</span>, <span class="stringliteral">"gosaMailServer"</span>, <span class="stringliteral">"gosaMailQuota"</span>, <span class="stringliteral">"gosaMailMaxSize"</span>,
+                        <span class="stringliteral">"gosaMailDeliveryMode"</span>, <span class="stringliteral">"gosaSpamSortLevel"</span>, <span class="stringliteral">"gosaSpamMailbox"</span>,
+                        <span class="stringliteral">"gosaVacationMessage"</span>, <span class="stringliteral">"uid"</span>)
+</pre></div>
+<p>
+Reimplemented from <a class="el" href="classplugin.html">plugin</a>.    </td>
+  </tr>
+</table>
+<a name="o18" doxytag="mailAccount::perms"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> mailAccount::perms
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+<b>Initial value:</b><div class="fragment"><pre> array( <span class="stringliteral">"lrs"</span> =&gt; <span class="stringliteral">"read"</span>, <span class="stringliteral">"lrsp"</span> =&gt; <span class="stringliteral">"post"</span>, <span class="stringliteral">"lrsip"</span> =&gt; <span class="stringliteral">"append"</span>,
+                        <span class="stringliteral">"lrswipcd"</span> =&gt; <span class="stringliteral">"write"</span>, <span class="stringliteral">"lrswipcda"</span> =&gt; <span class="stringliteral">"all"</span> )
+</pre></div>    </td>
+  </tr>
+</table>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li>class_mailAccount.inc</ul>
+<hr size="1"><address style="align: right;"><small>Generated on Sat Jul 26 18:32:23 2003 for GOsa by
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 > 
+</a>1.3.2 </small></address>
+</body>
+</html>