doc/guide/devel/html/classmailAccount.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>GOsa: mailAccount class Reference</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3.2 -->
   7 <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>
   8 <h1>mailAccount Class Reference</h1>mail plugin
   9 <a href="#_details">More...</a>
  10 <p>
  11 <p>Inheritance diagram for mailAccount:
  12 <p><center><img src="classmailAccount.png" usemap="#mailAccount_map" border="0" alt=""></center>
  13 <map name="mailAccount_map">
  14 <area href="classplugin.html" alt="plugin" shape="rect" coords="0,0,81,24">
  15 </map>
  16 <a href="classmailAccount-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  17 <tr><td></td></tr>
  18 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  19 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a0" doxytag="mailAccount::mailAccount"></a>
  20 &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>
  21
  22 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a1" doxytag="mailAccount::getImapAttributes"></a>
  23 &nbsp;</td><td class="memItemRight" valign=bottom><b>getImapAttributes</b> ()</td></tr>
  24
  25 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a2" doxytag="mailAccount::setImapAttributes"></a>
  26 &nbsp;</td><td class="memItemRight" valign=bottom><b>setImapAttributes</b> ()</td></tr>
  27
  28 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a3" doxytag="mailAccount::setSieveAttributes"></a>
  29 &nbsp;</td><td class="memItemRight" valign=bottom><b>setSieveAttributes</b> ()</td></tr>
  30
  31 <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>
  32
  33 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">execute plugin </em> <a href="#a4"></a><em><br><br></td></tr>
  34 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a5" doxytag="mailAccount::remove_from_parent"></a>
  35 &nbsp;</td><td class="memItemRight" valign=bottom><b>remove_from_parent</b> ()</td></tr>
  36
  37 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a6" doxytag="mailAccount::save_object"></a>
  38 &nbsp;</td><td class="memItemRight" valign=bottom><b>save_object</b> ()</td></tr>
  39
  40 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a7" doxytag="mailAccount::save"></a>
  41 &nbsp;</td><td class="memItemRight" valign=bottom><b>save</b> ()</td></tr>
  42
  43 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a8" doxytag="mailAccount::check"></a>
  44 &nbsp;</td><td class="memItemRight" valign=bottom><b>check</b> ()</td></tr>
  45
  46 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a9" doxytag="mailAccount::adapt_from_template"></a>
  47 &nbsp;</td><td class="memItemRight" valign=bottom><b>adapt_from_template</b> ($<a class="el" href="classplugin.html#o4">dn</a>)</td></tr>
  48
  49 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a10" doxytag="mailAccount::addForwarder"></a>
  50 &nbsp;</td><td class="memItemRight" valign=bottom><b>addForwarder</b> ($address)</td></tr>
  51
  52 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a11" doxytag="mailAccount::delForwarder"></a>
  53 &nbsp;</td><td class="memItemRight" valign=bottom><b>delForwarder</b> ($addresses)</td></tr>
  54
  55 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a12" doxytag="mailAccount::addAlternate"></a>
  56 &nbsp;</td><td class="memItemRight" valign=bottom><b>addAlternate</b> ($address)</td></tr>
  57
  58 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a13" doxytag="mailAccount::delAlternate"></a>
  59 &nbsp;</td><td class="memItemRight" valign=bottom><b>delAlternate</b> ($addresses)</td></tr>
  60
  61 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
  62 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o0" doxytag="mailAccount::mail"></a>
  63 &nbsp;</td><td class="memItemRight" valign=bottom><b>mail</b> = ""</td></tr>
  64
  65 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o1" doxytag="mailAccount::gosaMailAlternateAddress"></a>
  66 &nbsp;</td><td class="memItemRight" valign=bottom><b>gosaMailAlternateAddress</b> = array()</td></tr>
  67
  68 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o2" doxytag="mailAccount::gosaMailForwardingAddress"></a>
  69 &nbsp;</td><td class="memItemRight" valign=bottom><b>gosaMailForwardingAddress</b> = array()</td></tr>
  70
  71 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o3" doxytag="mailAccount::gosaMailDeliveryMode"></a>
  72 &nbsp;</td><td class="memItemRight" valign=bottom><b>gosaMailDeliveryMode</b> = "[L ]"</td></tr>
  73
  74 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o4" doxytag="mailAccount::gosaMailServer"></a>
  75 &nbsp;</td><td class="memItemRight" valign=bottom><b>gosaMailServer</b> = ""</td></tr>
  76
  77 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o5" doxytag="mailAccount::gosaMailQuota"></a>
  78 &nbsp;</td><td class="memItemRight" valign=bottom><b>gosaMailQuota</b> = ""</td></tr>
  79
  80 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o6" doxytag="mailAccount::gosaMailMaxSize"></a>
  81 &nbsp;</td><td class="memItemRight" valign=bottom><b>gosaMailMaxSize</b> = ""</td></tr>
  82
  83 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o7" doxytag="mailAccount::gosaVacationMessage"></a>
  84 &nbsp;</td><td class="memItemRight" valign=bottom><b>gosaVacationMessage</b> = ""</td></tr>
  85
  86 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o8" doxytag="mailAccount::gosaSpamSortLevel"></a>
  87 &nbsp;</td><td class="memItemRight" valign=bottom><b>gosaSpamSortLevel</b> = ""</td></tr>
  88
  89 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o9" doxytag="mailAccount::gosaSpamMailbox"></a>
  90 &nbsp;</td><td class="memItemRight" valign=bottom><b>gosaSpamMailbox</b> = ""</td></tr>
  91
  92 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o10" doxytag="mailAccount::quotaUsage"></a>
  93 &nbsp;</td><td class="memItemRight" valign=bottom><b>quotaUsage</b> = 0</td></tr>
  94
  95 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o11" doxytag="mailAccount::forward_dialog"></a>
  96 &nbsp;</td><td class="memItemRight" valign=bottom><b>forward_dialog</b> = FALSE</td></tr>
  97
  98 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o12" doxytag="mailAccount::folder_prefix"></a>
  99 &nbsp;</td><td class="memItemRight" valign=bottom><b>folder_prefix</b> = ""</td></tr>
 100
 101 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o13" doxytag="mailAccount::mailboxList"></a>
 102 &nbsp;</td><td class="memItemRight" valign=bottom><b>mailboxList</b> = array()</td></tr>
 103
 104 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o14" doxytag="mailAccount::default_permissions"></a>
 105 &nbsp;</td><td class="memItemRight" valign=bottom><b>default_permissions</b> = "none"</td></tr>
 106
 107 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o15" doxytag="mailAccount::member_permissions"></a>
 108 &nbsp;</td><td class="memItemRight" valign=bottom><b>member_permissions</b> = "post"</td></tr>
 109
 110 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o16" doxytag="mailAccount::members"></a>
 111 &nbsp;</td><td class="memItemRight" valign=bottom><b>members</b> = array()</td></tr>
 112
 113 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o17" doxytag="mailAccount::admins"></a>
 114 &nbsp;</td><td class="memItemRight" valign=bottom><b>admins</b> = array()</td></tr>
 115
 116 <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><b>perms</b></td></tr>
 117
 118 <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><b>attributes</b></td></tr>
 119
 120 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o20" doxytag="mailAccount::objectclasses"></a>
 121 &nbsp;</td><td class="memItemRight" valign=bottom><b>objectclasses</b> = array("gosaMailAccount")</td></tr>
 122
 123 </table>
 124 <hr><a name="_details"></a><h2>Detailed Description</h2>
 125 mail plugin
 126 <p>
 127 <dl compact><dt><b>Author:</b></dt><dd>Cajus Pollmeier &lt;<a href="mailto:pollmeier@gonicus.de">pollmeier@gonicus.de</a>&gt; </dd></dl>
 128 <dl compact><dt><b>Version:</b></dt><dd>2.00 </dd></dl>
 129 <dl compact><dt><b>Date:</b></dt><dd>24.07.2003</dd></dl>
 130 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.
 131 <p>
 132 <hr><h2>Member Function Documentation</h2>
 133 <a name="a4" doxytag="mailAccount::execute"></a><p>
 134 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 135   <tr>
 136     <td class="mdRow">
 137       <table cellpadding="0" cellspacing="0" border="0">
 138         <tr>
 139           <td class="md" nowrap valign="top"> mailAccount::execute </td>
 140           <td class="md" valign="top">(&nbsp;</td>
 141           <td class="mdname1" valign="top" nowrap>          </td>
 142           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 143           <td class="md" nowrap></td>
 144         </tr>
 145
 146       </table>
 147     </td>
 148   </tr>
 149 </table>
 150 <table cellspacing=5 cellpadding=0 border=0>
 151   <tr>
 152     <td>
 153       &nbsp;
 154     </td>
 155     <td>
 156
 157 <p>
 158 execute plugin
 159 <p>
 160 Generates the html output for this node
 161 <p>
 162 Reimplemented from <a class="el" href="classplugin.html#a1">plugin</a>.    </td>
 163   </tr>
 164 </table>
 165 <hr><h2>Member Data Documentation</h2>
 166 <a name="o19" doxytag="mailAccount::attributes"></a><p>
 167 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 168   <tr>
 169     <td class="mdRow">
 170       <table cellpadding="0" cellspacing="0" border="0">
 171         <tr>
 172           <td class="md" nowrap valign="top"> mailAccount::attributes
 173       </table>
 174     </td>
 175   </tr>
 176 </table>
 177 <table cellspacing=5 cellpadding=0 border=0>
 178   <tr>
 179     <td>
 180       &nbsp;
 181     </td>
 182     <td>
 183
 184 <p>
 185 <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>,
 186                         <span class="stringliteral">"gosaMailDeliveryMode"</span>, <span class="stringliteral">"gosaSpamSortLevel"</span>, <span class="stringliteral">"gosaSpamMailbox"</span>,
 187                         <span class="stringliteral">"gosaVacationMessage"</span>, <span class="stringliteral">"uid"</span>)
 188 </pre></div>
 189 <p>
 190 Reimplemented from <a class="el" href="classplugin.html">plugin</a>.    </td>
 191   </tr>
 192 </table>
 193 <a name="o18" doxytag="mailAccount::perms"></a><p>
 194 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 195   <tr>
 196     <td class="mdRow">
 197       <table cellpadding="0" cellspacing="0" border="0">
 198         <tr>
 199           <td class="md" nowrap valign="top"> mailAccount::perms
 200       </table>
 201     </td>
 202   </tr>
 203 </table>
 204 <table cellspacing=5 cellpadding=0 border=0>
 205   <tr>
 206     <td>
 207       &nbsp;
 208     </td>
 209     <td>
 210
 211 <p>
 212 <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>,
 213                         <span class="stringliteral">"lrswipcd"</span> =&gt; <span class="stringliteral">"write"</span>, <span class="stringliteral">"lrswipcda"</span> =&gt; <span class="stringliteral">"all"</span> )
 214 </pre></div>    </td>
 215   </tr>
 216 </table>
 217 <hr>The documentation for this class was generated from the following file:<ul>
 218 <li>class_mailAccount.inc</ul>
 219 <hr size="1"><address style="align: right;"><small>Generated on Sat Jul 26 18:32:23 2003 for GOsa by
 220 <a href="http://www.doxygen.org/index.html">
 221 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 222 </a>1.3.2 </small></address>
 223 </body>
 224 </html>