NAME

User::Net - Zero Knowledge Network User Class


SYNOPSIS

    use User::Net;

    $netuser = new User::Net();


REQUIRES

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


EXPORTS

Nothing


DESCRIPTION

This is the User::Net user information class. This class encapsulates a generic network user. All internally stored network user information is accessed through an instantiation of this user object.

A new User::Net object must be created with the new method. Once this has been done, all user information is accessed through this object.

The User::Net is a sub-class of User:Base.


CONSTRUCTOR

new User::Base( [ OPTIONS ] )

This is the constructor for the User::Base object. A new user object will be automagically initialized from the Zero Knowledge network specific parameter files.

OPTIONS are passed in a hash like fashion, using key and value pairs and may be used to override the default items. This is NOT recommended as the netwok specific parameters associated with this user are guaranteed to be correct for the currently active Zero Knowledge network.

Possible options are:

Type - The type code.

Name - The full name.

User - The network username.

Password - The network password.

Email - The emil address.

Quota - The Quota value.

SMTP_server - The network specific SMTP server.

POPX_server - The netowrk specific POP server.

NNTP_server - The network specific NNTP server.

Example:

  $base = new User::Base( Type => 'ssh',
                          Name => 'Jody Foster',
                          User => 'jfoster@yellowcab.org',
                          Password => 'Utalk1nt0me');


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. This quota value is expressed as:

  <somenumber>k = 2000 = 2k
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, User::Base


AUTHOR

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


COPYRIGHT

Copyright 2000 Zero Knowledge Systems, Inc. All rights reserved