Name

msgusercreate — create a new Messaging Server user

Synopsis

/opt/lsb-caldera.com-volution/msg/bin/msgusercreate --uid=name --domain=domain 
   [ attributes]

Description

The msgusercreate utility is a Perl script that creates a new Messaging Server user, creating both a Cyrus user (the inbox) and the LDAP user object, replete with user attributes. Only the Messaging Server admin user can use the msgusercreate tool.

Messaging Server users can also be created with the Server Manager in the Users menu under Create Users.

Specify the user with:

--uid=name

Specifies the unique identifier within a Messaging Server mail system.

Note

The Messaging Server uid (unique identifier) is not comparable to a conventional Linux or UNIX uid. It is not necessary for Messaging Server users to have conventional uids on the host system, and in most cases it is inappropriate.

--domain=domain

specifies the domain to which the new user will be added; virtual domain names are allowed.

The following attributes are optional and can be used once at most:

--firstname=firstname

The given name (gn) or first name of the new user.

--lastname=lastname

The surname of the new user, also known as the last name.

--fullname=fullname

The new user's full name; for example, "Dana Welsh".

-- mail=mailaddress

The mail address defaults to uid@vdomain, where vdomain is the given virtual domain. Using this parameter overrides the default.

--homephone=value

Home phone number.

--businessphone=value

Business phone number.

--fax=value

Fax number.

--pager=value

Pager number.

--mobile=value

Mobile phone number.

--title=value

Job title.

--mailstop=value

Interoffice-Mail address.

--forward=value

An email address to which to forward all the new user's email. The address is a string that is not verified against the LDAP server.

--forwardcopy=[ TRUE | FALSE ]

Save a copy of forwarded mail in the user's inbox if forwarding is enabled.

--alternatemail=value

An alternate email address for the new user. The email address must be qualified with the name of the mail domain under which the user resides.

--quotalimit=[ value | NONE ]

Set or remove quota limits for user mailstores, including inbox and folders. Values are kilobytes of disk space; the value 0 is legal but will disable mail delivery. NONE removes the quota.

--ctsnodeid=value

Assign a calendar node ID to the new user.

Note

This field is required if the Steltor CorporateTime Server is installed.

The msgusercreate utility also sets defaults automatically for mail filtering depending on the settings specified by msgaclset(8). To change these default settings after a user has been created, use the msgusermod(8) utility.

Files

/opt/lsb-caldera.com-volution/msg/bin/msgusercreate

the msgusercreate Perl script

See also

msgaclget(8), msgaclset(8), msgcalendarlistnodes(8), msguserdelete(8), msgusergetaliases(8), msguserisadmin(8), msguserlist(8), msguserlistall(8), msgusermod(8), msguserpw(8)

Steltor CorporateTime Serverdocumentation