1 =head1 NAME

     2 

     3 ma -- mailadmin tool

     4 

     5 =head1 SYNOPSIS

     6 

     7 B<ma> account [--add|--modify|--delete|--list] 

     8 [--address=s]

     9 [--fullname=s]

    10 [--group=s]

    11 [--[no]mbox]

    12 [--other=s]

    13 [--password=s]

    14 I<name>

    15 

    16 B<ma> alias  [--add|--modify|--delete|--list] [--members=s] I<name>

    17 

    18 B<ma> --help

    19 

    20 

    21 =head1 DESCRIPTION

    22 

    23 B<ma> ist ein Tool zur Administration vom Mailnutzern, deren Einstellungen im LDAP

    24 gespeichert sind.

    25 

    26 Es gliedert sich in zwei Sub-Kommands: C<account> und C<alias>.

    27 

    28 =head2 account

    29 

    30 Mit diesem Subkommando werden die Details des Accounts (Nutzer) modifiziert.

    31 Das sind vor allem Dinge wie 

    32 

    33 =over 4

    34 

    35 =item	. Name

    36 

    37 =item 	. Password

    38 

    39 =item	. Gruppenzugehörigkeit

    40 

    41 =item	. alternative Mailadressen

    42 

    43 =back

    44 

    45 Beeinflußt wird sowohl das LDAP als auch der Cyrus-Mailserver.  Im LDAP werden die Nutzerspezifischen 

    46 Daten gehalten, im Cyrus die Mailboxen.  Bei LDAP-Eintragungen wird davon ausgegangen, daß

    47 keine anderen Elemente in den entsprechenden Subbäumen liegen.  Besonders beim Löschen ist das zu berücksichtigen,

    48 denn z.B. das Entfernen eines Nutzer entfernt dessen B<gesamtes> LDAP-Objekt!

    49 

    50 =head1 OPTIONS

    51 

    52 =over 4

    53 

    54 =head2 OPTIONS für beide Sub-Kommandos

    55 

    56 =item B<--add>|B<--modify>|B<--delete>|B<--list>

    57 

    58 Ist eigentlich selbsterklärend :)

    59 

    60 =back

    61 

    62 =head2 OPTIONS für C<account>

    63 

    64 =over 4

    65 

    66 =item B<--address>=I<primäre Mailadresse>

    67 

    68 Die primäre Mailadresse des Nutzers.  Wird u.U. für das Masquerading bei ausgehender Mail

    69 genutzt.  Diese Adresse darf nicht schon existieren.  Mit einem C<!> am Ende der Adresse läßt sich 

    70 dieser Test ausschalten.

    71 

    72 =item B<--fullname>=I<Klartext-Name>

    73 

    74 Der volle Klartextname des Nutzers.  Wird nur für Dokumentationszwecke genutzt.

    75 

    76 =item B<--group>=I<Gruppenzuhörigkeit>

    77 

    78 Die Liste der Mailgruppen, in denen der Nutzer Mitglied ist.  Mail an diese Gruppen werden dann 

    79 auch an diesen Nutzer zugestellt.   Beim Neuanlegen genügt eine kommangetrennte Liste (keine Leerzeichen!).

    80 Beim Modifizieren können mit dem Präfix C<+> bzw. C<-> einzelne Gruppen hinzugefügt bzw. entfernt werden:

    81 

    82 	ma account --modify --group=+groupA,-groupB,+groupC hans

    83 

    84 entfernt C<hans> aus der Gruppe C<groupB> und fügt ihn in C<groupA> und C<groupB> ein.

    85 

    86 	ma account --modify --group= hans

    87 

    88 entfernt alle Gruppenzugehörigkeiten.

    89 

    90 	ma account --modify --group=groupA,groupB hans

    91 

    92 setzt genau die Zugehörigkeiten C<groupA> und C<groupB>.

    93 

    94 =item B<--[no]mbox>

    95 

    96 Mailbox-Anlegen oder auch nicht.  (Nur beim Neu-Anlegen.)

    97 

    98 =item B<--other=>=I<alternative Mailadressen>

    99 

   100 Wenn der Nutzer unter alternativen Mailadressen erreichbar sein soll, dann sind diese hier erwähnt.

   101 Es lassen sich Adressen hinzufügen und auch wieder löschen.  Die Syntax dazu entspricht der bei der 

   102 Gruppenzugehörigkeit.

   103 

   104 =item B<--password>=I<Passwort>

   105 

   106 Wenn beim Nutzeranlegen das Passwort nicht generiert werden soll, dann ist es hier anzugeben.

   107 Nachträglich läßt es sich auch hier ändern.

   108 

   109 =back

   110 

   111 =head2 Options für C<alias>

   112 

   113 =over 4

   114 

   115 =item B<--members>=I<Liste der Anliasangehörigen>

   116 

   117 Es können Alias-Mitglieder ein- und ausgetragen werden.  Die Syntax entspricht der oben bei der 

   118 Gruppenzugehörigkeit angegebenen.

   119 

   120 =back

   121 

   122 =head1 EXAMPLES

   123 

   124 Anlegen, Anzeigen, Verändern und Löschen eines Nutzers:

   125 

   126 	ma account --add --fullname "Hans Hanson" --other=h.hanson,hh --group=edv hans

   127 	ma account --list

   128 	ma account --modify --password=x --group=-edv,+it hans

   129 	ma account --delete hans

   130 

   131 Beim Löschen wird die B<Mailbox entfernt>!  Eventuelle Mitgliedschaften des Nutzers in

   132 Aliasen werden B<auch> berücksichtigt.  Die Nutzung 

   133 der Gruppen ist hier jedoch deutlich einfacher.

   134 

   135 Anlegen, Anzeigen, Verändern und Löschen eines Alias:

   136 

   137 	ma alias --add --members=hans,rudi operators

   138 	ma alias --list

   139 	ma alias --modify --members=+fritz operators

   140 	ma alias --delete operators

   141 

   142 =head1 Umgebungsvariablen

   143 

   144 =over 4

   145 

   146 =item	MA_CONF

   147 

   148 Konfigurations-Datei-Name.  Diese Variable B<muß> gesetzt werden, damit

   149 B<ma> sich überhaupt für eine Konfigurations-Datei interessiert.

   150 

   151 =item	LDAP_PASS

   152 

   153 Passwort für den LDAP-Administrator.  Optional.

   154 

   155 =item	IMAP_PASS

   156 

   157 Passwort für den IMAP-Administrator.  Optional.

   158 

   159 =back

   160 

   161 

   162 =head1 AUTHOR

   163 

   164 Heiko Schlittermann <hs@schlittermann.de>