gosa-core/doc/devel/latex/classmailAccount.tex

   1 \section{mail\-Account Class Reference}
   2 \label{classmailAccount}\index{mailAccount@{mailAccount}}
   3 mail plugin
   4
   5
   6 Inheritance diagram for mail\-Account::\begin{figure}[H]
   7 \begin{center}
   8 \leavevmode
   9 \includegraphics[height=2cm]{classmailAccount}
  10 \end{center}
  11 \end{figure}
  12 \subsection*{Public Member Functions}
  13 \begin{CompactItemize}
  14 \item
  15 {\bf mail\-Account} (\${\bf dn}=NULL, \$shared\_\-folder=FALSE)\label{classmailAccount_a0}
  16
  17 \item
  18 {\bf get\-Imap\-Attributes} ()\label{classmailAccount_a1}
  19
  20 \item
  21 {\bf set\-Imap\-Attributes} ()\label{classmailAccount_a2}
  22
  23 \item
  24 {\bf set\-Sieve\-Attributes} ()\label{classmailAccount_a3}
  25
  26 \item
  27 {\bf execute} ()
  28 \begin{CompactList}\small\item\em execute plugin \item\end{CompactList}\item
  29 {\bf remove\_\-from\_\-parent} ()\label{classmailAccount_a5}
  30
  31 \item
  32 {\bf save\_\-object} ()\label{classmailAccount_a6}
  33
  34 \item
  35 {\bf save} ()\label{classmailAccount_a7}
  36
  37 \item
  38 {\bf check} ()\label{classmailAccount_a8}
  39
  40 \item
  41 {\bf adapt\_\-from\_\-template} (\${\bf dn})\label{classmailAccount_a9}
  42
  43 \item
  44 {\bf add\-Forwarder} (\$address)\label{classmailAccount_a10}
  45
  46 \item
  47 {\bf del\-Forwarder} (\$addresses)\label{classmailAccount_a11}
  48
  49 \item
  50 {\bf add\-Alternate} (\$address)\label{classmailAccount_a12}
  51
  52 \item
  53 {\bf del\-Alternate} (\$addresses)\label{classmailAccount_a13}
  54
  55 \end{CompactItemize}
  56 \subsection*{Public Attributes}
  57 \begin{CompactItemize}
  58 \item
  59 {\bf mail} = \char`\"{}\char`\"{}\label{classmailAccount_o0}
  60
  61 \item
  62 {\bf gosa\-Mail\-Alternate\-Address} = array()\label{classmailAccount_o1}
  63
  64 \item
  65 {\bf gosa\-Mail\-Forwarding\-Address} = array()\label{classmailAccount_o2}
  66
  67 \item
  68 {\bf gosa\-Mail\-Delivery\-Mode} = \char`\"{}[L ]\char`\"{}\label{classmailAccount_o3}
  69
  70 \item
  71 {\bf gosa\-Mail\-Server} = \char`\"{}\char`\"{}\label{classmailAccount_o4}
  72
  73 \item
  74 {\bf gosa\-Mail\-Quota} = \char`\"{}\char`\"{}\label{classmailAccount_o5}
  75
  76 \item
  77 {\bf gosa\-Mail\-Max\-Size} = \char`\"{}\char`\"{}\label{classmailAccount_o6}
  78
  79 \item
  80 {\bf gosa\-Vacation\-Message} = \char`\"{}\char`\"{}\label{classmailAccount_o7}
  81
  82 \item
  83 {\bf gosa\-Spam\-Sort\-Level} = \char`\"{}\char`\"{}\label{classmailAccount_o8}
  84
  85 \item
  86 {\bf gosa\-Spam\-Mailbox} = \char`\"{}\char`\"{}\label{classmailAccount_o9}
  87
  88 \item
  89 {\bf quota\-Usage} = 0\label{classmailAccount_o10}
  90
  91 \item
  92 {\bf forward\_\-dialog} = FALSE\label{classmailAccount_o11}
  93
  94 \item
  95 {\bf folder\_\-prefix} = \char`\"{}\char`\"{}\label{classmailAccount_o12}
  96
  97 \item
  98 {\bf mailbox\-List} = array()\label{classmailAccount_o13}
  99
 100 \item
 101 {\bf default\_\-permissions} = \char`\"{}none\char`\"{}\label{classmailAccount_o14}
 102
 103 \item
 104 {\bf member\_\-permissions} = \char`\"{}post\char`\"{}\label{classmailAccount_o15}
 105
 106 \item
 107 {\bf members} = array()\label{classmailAccount_o16}
 108
 109 \item
 110 {\bf admins} = array()\label{classmailAccount_o17}
 111
 112 \item
 113 {\bf perms}
 114 \item
 115 {\bf attributes}
 116 \item
 117 {\bf objectclasses} = array(\char`\"{}gosa\-Mail\-Account\char`\"{})\label{classmailAccount_o20}
 118
 119 \end{CompactItemize}
 120
 121
 122 \subsection{Detailed Description}
 123 mail plugin
 124
 125 \begin{Desc}
 126 \item[Author:]Cajus Pollmeier $<${\tt pollmeier@gonicus.de}$>$ \end{Desc}
 127 \begin{Desc}
 128 \item[Version:]2.00 \end{Desc}
 129 \begin{Desc}
 130 \item[Date:]24.07.2003\end{Desc}
 131 This class provides the functionality to read and write all attributes relevant for gosa\-Mail\-Accounts from/to the LDAP. It does syntax checking and displays the formulars required.
 132
 133
 134
 135 \subsection{Member Function Documentation}
 136 \index{mailAccount@{mail\-Account}!execute@{execute}}
 137 \index{execute@{execute}!mailAccount@{mail\-Account}}
 138 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}mail\-Account::execute ()}\label{classmailAccount_a4}
 139
 140
 141 execute plugin
 142
 143 Generates the html output for this node
 144
 145 Reimplemented from {\bf plugin} {\rm (p.\,\pageref{classplugin_a1})}.
 146
 147 \subsection{Member Data Documentation}
 148 \index{mailAccount@{mail\-Account}!attributes@{attributes}}
 149 \index{attributes@{attributes}!mailAccount@{mail\-Account}}
 150 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}mail\-Account::attributes}\label{classmailAccount_o19}
 151
 152
 153 {\bf Initial value:}
 154
 155 \footnotesize\begin{verbatim} array("mail", "gosaMailServer", "gosaMailQuota", "gosaMailMaxSize",
 156                         "gosaMailDeliveryMode", "gosaSpamSortLevel", "gosaSpamMailbox",
 157                         "gosaVacationMessage", "uid")
 158 \end{verbatim}\normalsize
 159
 160
 161 Reimplemented from {\bf plugin} {\rm (p.\,\pageref{classplugin})}.\index{mailAccount@{mail\-Account}!perms@{perms}}
 162 \index{perms@{perms}!mailAccount@{mail\-Account}}
 163 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}mail\-Account::perms}\label{classmailAccount_o18}
 164
 165
 166 {\bf Initial value:}
 167
 168 \footnotesize\begin{verbatim} array( "lrs" => "read", "lrsp" => "post", "lrsip" => "append",
 169                         "lrswipcd" => "write", "lrswipcda" => "all" )
 170 \end{verbatim}\normalsize
 171
 172
 173 The documentation for this class was generated from the following file:\begin{CompactItemize}
 174 \item
 175 class\_\-mail\-Account.inc\end{CompactItemize}