Users

This collection contains User objects.

Properties

The following table lists the properties for this class, along with access and descriptions.

Property

Access

Description

_NewEnum

R/O

Enumeration object. Implements IEnumVARIANT. (For Windows only.)

ObjType

R/O

Enum( eadObjUsers )

System

R/O

System

Methods

User Add( String UserName, String SurName, String DN, [String Password], [String PO], [String Dom], [String MailboxID] )

Adds a User with the given UserName, Surname, and DN (distinguished name) to NDS and GroupWise. Password will apply to both NDS and GroupWise. See Remarks below.

User Add( String UserName, String SurName, String DN, [String Password], [PostOffice PO], [Domain Dom], [String MailboxID] )

Adds a User with the given UserName, Surname, and DN (distinguished name) to NDS and GroupWise. Password will apply to both NDS and GroupWise. See Remarks below.

User AddExistingUser( String UserName, String DN, [String Password], [String PO], [String Dom], [String MailboxID] )

Adds an existing NDS User with the given UserName and DN (distinguished name) to GroupWise. Password will apply to GroupWise only. See Remarks below.

User AddExistingUser( String UserName, String DN, [String Password], [PostOffice PO], [Domain Dom], [String MailboxID] )

Adds an existing NDS User with the given UserName and DN (distinguished name) to GroupWise. Password applies to GroupWise only. See Remarks below.

User AddExternalEntity( String UserName, String Surname, String DN, [String NetID], [String Password], [String PO], [String Dom], [String MailboxID] )

Adds an external entity with the given UserName, Surname, and DN (distinguished name) to NDS and GroupWise. Password applies to GroupWise only. See Remarks below.

User AddExternalEntity( String UserName, String Surname, String DN, [String NetID], [String Password], [PostOffice PO], [Domain Dom], [String MailboxID] )

Adds an external entity with the given UserName, Surname, and DN (distinguished name) to NDS and GroupWise. NetID is the User’s ID to the Network Operating System (NOS). Password will apply to GroupWise only. See Remarks below.

User AddExternalUser( String UserName, [String PO], [String Dom] )

Adds an external User with the given UserName to GroupWise. Dom, if supplied, must be an external domain. See Remarks below.

User AddExternalUser( String UserName, [PostOffice PO], [Domain Dom] )

Adds an external User with the given UserName to GroupWise. Dom, if supplied, must be an external domain. See Remarks below.

UsersIterator CreateIterator()

Creates a UsersIterator object.

Users Find( String GivenName, String Surname )

Finds all User objects with the specified GivenName and Surname. Partial names are signified by ending the String with the "*" character.

User Item( String Name, [String PO], [String Dom] )

Returns the User object with the given Name. See Remarks below.

User Item( String Name, [PostOffice PO], [Domain Dom] )

Returns the User object with the given Name. See Remarks below.

User ItemByDN( String DN [String Tree] )

Returns the User object with the given DN (distinguished name). If no Tree is supplied, the current tree is assumed.

User ItemByObjectID( String ObjectID )

Returns the object with the given ObjectID.

Remarks

The MailboxID parameter in the above methods is an optional three-character, alphanumeric file ID that is used to define the User in the User database. It is highly recommended that you do not specify a Mailbox ID, in which case the system will assign one for you. However, if you do specify a MailboxID, and it conflicts with an existing one, the system will automatically assign a different MailboxID.

This table applies to the above methods as noted. It shows the parameters you can use with the methods depending on where you obtain the Users object.

Source of Users Object

Required Parameters

Optional Parameters

PostOffice

   

PO, Dom

Domain

PO

Dom

System

PO, Dom