NAME

User::Base - Zero Knowledge User Base Class


SYNOPSIS

    use User::Base;

    $base = new User::Base();


REQUIRES

    Perl5.004+
    UserConfig
    User::Base
    Domain::Base (Sub-class)
    Server::Base (Sub-class)


EXPORTS

Nothing


DESCRIPTION

This is the base class for all User:: classes. The User::Base class implements the methods common to all classes in this hiearchy.

The User::Base does not sub-class any other classes.


CONSTRUCTOR

new User::Base()

This is the constructor for the User::Base object. This object should not be instatiated directly as it only serves as a parent class for all other User:: classes.

Example:

  $base = new User::Base();


METHODS

type ( [ TYPE ] )

Return the type identification code associated with this user object. If TYPE is supplied the it will be set internally by this user object.

name ( [ NAME ] )

Return the name associated with this user object. If NAME is supplied, then it will be set internally by this user object.

user ( [ USER ] )

Return the usernme associated with this user object. If USER is supplied, then it will be set iternally by this user object.

password ( [ PASSWORD ] )

Return the password associated with this user object. If PASSWORD is supplied, then it will be set internally by this user object.

email ( [ EMAIL ] )

Return the email address associated with this usewr object. If EMAIL is supplied, then it will be set internally by this user object.

quota ( [ NUMBER ] )

Return the ``quota'' value associated with this user. If NUMBER is supplied, then it will be set internally by this user object. The quota value accessed by this method is not for any specific use and as such may represent any such user specific restriction.

smtp_server ( [ SERVER ] )

Return the Server::MailServer object associated with this user for transmission of outgoing Internet mail messages. If SERVER is supplied then it will be set internally by this user object. The server object specified here, is user specific and is guaranteed correct for the currently active Zero Knowledge network.

popx_server ( [ SERVER ] )

Return the Server::MailServer object associated with this user for reception of incoming Internet mail messages. If SERVER is supplied then it will be set internally by this user object. The server object specified here, is user specific and is guaranteed correct for the currently active Zero Knowledge network.

nntp_server ( [ SERVER ] )

Return the Server::NewsServer object associated with this user for posting and receipt of Internet news messages. If SERVER is supplied then it will be set internally by this user object. The server object specified here, is user specific and is guaranteed correct for the currently active Zero Knowledge network.

domain ( [ DOMAIN ] )

Returns the Domain::Base object for this user object. If DOMAIN is supplied the it will be set internally by this user object. The domain object is guaranteed to be correct for the user on the currently active Zero Knowledge network.

print()

Print the contents of the user object to the default output device (stdout).


CLASS VARIABLES

None Present


SEE ALSO

Server::MailServer, Server::NewsServer, Domain::Base


AUTHOR

Kris Smith <krissmi@zeroknowledge.com> Philippe McLean <phillipem@zeroknowledge.com>


COPYRIGHT

Copyright 2000 Zero Knowledge Systems, Inc. All rights reserved