Previous     Contents     Index     DocHome     Next     
iPlanet Messaging Server 5.0 Schema Reference Manual



Chapter 1   iPlanet Messaging Server 5.0 Object Classes


This chapter describes the following iPlanet Messaging Server object classes:



Overview

The basic data model of the iPlanet Messaging Server object classes is to extend LDAP entry types (for example, user, group, domain) created by core object classes by overlaying them with shared classes (object classes can be shared by more than one service) and service-specific object classes (classes specific to a certain type of server). This relationship is depicted in the table below.


Table 1-1    Entry types and Corresponding Object Classes

Type

Class

Core Classes

Shared Classes

Messaging Server Classes

DC Tree Domain  

domain, inetdomain  

 

mailDomain, nsManagedDomain, icsCalendarDomain  

Org. Tree Domain  

organization  

 

nsManagedDomain  

Email User  

person, inetUser, organizationalPerson,inetOrgPerson  

ipUser, userPresenceProfile  

inetMailUser, inetLocalMailRecipient, nsManagedPerson  

Group  

groupOfUniqueNames  

 

inetMailGroup, inetLocalRecipient, inetMailGroupManagement, nsManagedMailList  

Family Account  

inetManagedGroup  

 

nsManagedDept  

Most Object classes and attributes mentioned in this document are further described within; however certain object classes, such as person and inetOrgPerson and certain attributes, such as UID, UserPassowrd, description, commonname, and co are described in RFC 2798 as well as within documents referenced by RFC 2798.



inetDomain


Supported by
iPlanet Messaging Server 5.0


Definition
Auxiliary class for Nortel and Sun/Netscape Alliance interoperability specification compliant services like mail, Radius, and calendar. Used to extend the base entry created by domain. It represents a hosted domain account and is used in conjunction with mailDomain and (optionally inetDomainAuthInfo) for creating a hosted domain node suitable for mail services for the hosted organization. This object class must be used for all hosted domain entries.


Superior Class
top


Object Class Type
auxiliary


OID
2.16.840.1.113730.3.2.129


Required Attributes
None


Allowed Attributes
inetDomainBaseDN, inetDomainStatus



inetDomainAlias


Supported by
iPlanet Messaging Server 5.0


Definition
Structural class for creating domain alias entries in the directory. Entries may be created in the domain component tree that point at other hosted domain objects. Such domain alias entries must use this object class. Attribute aliasedObjectName, inherited from the parent object class alias (see RFC2256), holds the DN of the LDAP entry for which the node is an alias.


Superior Class
alias


Object Class Type
structural


OID
2.16.840.1.113730.3.2.131


Required Attributes
dc


Allowed Attributes
None



inetDomainAuthInfo


Supported by
iPlanet Messaging Server 5.0


Definition
This object class is used to extend the domain entry with search filter, domain cert map, and a canonical domain name if more than one hosted domain refers to the same organization subtree.


Superior Class
top


Object Class Type
auxiliary


OID
2.16.840.1.113730.3.2.133


Required Attributes
None


Allowed Attributes
inetDomainSearchFilter, inetDomainBaseDN, inetCanonicalDomainName, mailDomainWelcomeMessage



inetDomainOrg


Supported by
iPlanet Messaging Server 5.0


Definition
Auxiliary class for supporting a managed domain organization. This object class is used in conjunction with the structural class organization to define a domain organization. A domain organization is usually created as a way of introducing hierarchy beneath a customer subtree and assigning administrators for that domain organization. For example, siroe.com could have a customer subtree with the DN o=Siroe Inc.,o=ISP. To create a sub-organization beneath the parent tree and designate a set of administrators for that sub-organization, you would create a Domain Organization node by using organization and inetDomainOrg object classes.


Superior Class
top


Object Class Type
auxiliary


OID
2.16.840.1.113730.3.2.132


Required Attributes
None


Allowed Attributes
domOrgMaxUsers, domOrgNumUsers



inetLocalMailRecipient


Supported by
iPlanet Messaging Server 5.0


Definition
Stores information that provides a way to designate an LDAP entry as one that represents a local (intra-organizational) email recipient, to specify the recipient's email address(es), and to provide routing information pertinent to the recipient. This is intended to support SMTP message transfer agents in routing RFC 822-based email within a private enterprise only, and is not to be used in the process of routing email across the public Internet.


Superior Class
top


Object Class Type
auxiliary


OID
2.16.840.1.113.730.3.2.147


Required Attributes
None


Allowed Attributes
mail, mailAlternateAddress, mailHost, mailRoutingAddress



inetMailAdministrator


Supported by
iPlanet Messaging Server 5.0


Definition
LDAP group defined with groupOfUniqueNames can be overlaid with this object class. Members (listed in the attribute uniqueMember) of a group overlaid with this object class and where mailAdminRole is set to storeAdmin get IMAP proxyauth rights over all users in the same domain in which the group entry exists.


Superior Class
top


Object Class Type
auxiliary


OID
2.16.840.1.113730.3.2.148


Required Attributes
None


Allowed Attributes
mailAdminRole



inetMailGroup


Supported by
iPlanet Messaging Server 5.0


Definition
Used to extend the base entry created by groupOfUniqueNames to define a group of mail recipients. inetMailGroup is used to store attributes of a mailing list. It is used in conjunction with inetLocalMailRecipient and inetMailGroupManagement (for mailing lists managed by the Delegated Administrator).


Superior Class
top


Object Class Type
auxiliary


OID
1.3.6.1.4.1.42.2.27.2.2.2


Required Attributes
None


Allowed Attributes
mgrpErrorsTo, mgrpAddHeader, mgrpRemoveHeader, mgrpModerator, mgrpRequestTo, mgrpAuthPassword, mgrpAllowedDomain, mgrpDisallowedDomain, mgrpAllowedBroadcaster, mgrpDisallowedBroadcaster, inetMailGroupStatus, mailDeliveryFileURL, mailDeliveryOption, mailProgramDeliveryInfo, mgrpRFC822MailMember, mgrpDeliverTo, mgrpBroadcasterPolicy, mgrpMsgMaxSize, mgrpMsgRejectAction, mgrpMsgRejectText, mgrpNoDuplicateChecks, preferredLanguage, dataSource



inetMailGroupManagement


Supported by
iPlanet Messaging Server 5.0


Definition
Used to extend the base entry created by groupOfUniqueNames. inetMailGroupManagement is used to store attributes for managing a distribution list by using Delegated Administrator for Messaging. This object class is used in conjunction with inetMailGroup and inetLocalMailRecipient. The attributes in this object class have no operational impact on the messaging server's MTA or message access/message store.


Superior Class
top


Object Class Type
auxiliary


OID
2.16.840.1.113730.3.2.149


Required Attributes
None


Allowed Attributes
mgmanAllowSubscribe, mgmanDenySubscribe, mgmanHidden, mgmanJoinability, mgmanMemberVisibility, mgmanIntroText, mgmanGoodbyeText, multiLineDescription



inetMailUser


Supported by
iPlanet Messaging Server 5.0


Definition
Used to extend the base entry created by inetOrgPerson to define a messaging service user. It represents a mail account and is used in conjunction with inetUser and inetLocalMailRecipient. Optionally, inetSubscriber may also be used for general account management purposes.


Superior Class
top


Object Class Type
auxiliary


OID
2.16.840.1.113730.3.2.146


Required Attributes
None


Allowed Attributes
mailAutoReplyTimeOut, mailAutoReplySubject, mailAutoReplyText, mailAutoReplyTextInternal, mailAutoReplyMode, mailDeliveryOption, mailForwardingAddress, mailMessageStore,mailProgramDeliveryInfo, mailQuota, mailMsgQuota, mailSieveRuleSource, mailAllowedServiceAccess, nswmExtendedUserPrefs, dataSource, mailUserStatus, mailSMTPSubmitChannel, cn



inetManagedGroup


Supported by
iPlanet Messaging Server 5.0


Definition
Used to define a managed group. If a managed group is just a department or family group, then the structural class to use is top, but it can also be used to make a statically defined group (from groupOfUniqueNames) and make that a managed group.


Superior Class
top


Object Class Type
auxiliary


OID
2.16.840.1.113730.3.2.137


Required Attributes
commonname (cn is an alias for common name)


Allowed Attributes
mnggrpBillableUser, mnggrpDeletionPolicy, mnggrpAdditionPolicy, description, mnggrpStatus, mnggrpMaxUsers, mnggrpCurrentUsers, mnggrpMailQuota, owner, nsdaModifiableBy, mnggrpUserClassOfServices



inetSubscriber


Supported by
iPlanet Messaging Server 5.0


Definition
Used to extend the base entry created by inetOrgPerson to define a user. It represents a subscriber account and may be used in conjunction with inetUser, inetMailUser, and ipUser for creating a mail account.


Superior Class
top


Object Class Type
auxiliary


OID
2.16.840.1.113730.3.2.134


Required Attributes
None


Allowed Attributes
inetSubscriberAccountId,inetSubscriberChallenge, inetSubscriberResponse



inetUser


Supported by
iPlanet Messaging Server 5.0


Definition
Used to extend the base entry created by inetOrgPerson. It represents a user account and is used in conjunction with inetMailUser and ipUser for creating a mail account. This can be used with icsUser for creating a calendar account.


Superior Class
top


Object Class Type
auxiliary


OID
2.16.840.1.113730.3.2.130


Required Attributes
None.


Allowed Attributes
uid, inetUserStatus, userPassword, inetUserHttpURL, memberOf



ipUser


Supported by
iPlanet Messaging Server 5.0


Definition
Object class for services like mail and calendar. Used to extend the base entry created by inetOrgPerson and inetUser. This object class holds the reference to the personal address book container and the class of service specifier.


Superior Class
top


Object Class Type
auxiliary


OID
2.16.840.1.113730.3.2.135


Required Attributes
None


Allowed Attributes
pabURI,memberOfManagedGroup, maxPabEntries, inetCOS



mailDomain


Supported by
iPlanet Messaging Server 5.0


Definition
Auxiliary class used to extend the base entry created by domain and inetDomain for enabling messaging services for the hosted domain. It represents a hosted domain account with access to Messaging Service. This object class must be used for all hosted domain entries.


Superior Class
top


Object Class Type
auxiliary


OID
2.16.840.1.113730.3.2.151


Required Attributes
None


Allowed Attributes
mailRoutingHosts, mailRoutingSmartHost, preferredMailHost, preferredMailMessageStore, mailAccessProxyPreAuth, mailAccessProxyReplay, mailDomainAllowedServiceAccess, mailDomainWelcomeMessage, mailDomainDiskQuota, mailDomainMsgQuota, mailClientAttachmentQuota, mailQuota, mailDomainStatus, preferredLanguage



msgVanityDomainUser


Supported by
iPlanet Messaging Server 5.0


Definition
Auxiliary class for supporting the notion of a vanity domain for messaging. Used to extend the base mail user entry to assign a vanity domain to the user.


Superior Class
top


Object Class Type
auxiliary


OID
2.16.840.1.113730.3.2.150


Required Attributes
None


Allowed Attributes
msgVanityDomain



pab


Supported by
iPlanet Messaging Server 5.0


Definition
The data model used is as follows:

pabPerson is a user entry in the personal address book.

pabGroup is the group entry and corresponds to a personal distribution list. For example, the pabGroup "pab-notes" may contain pabPersons micky and john.

pab is the address book that contains zero or more pabPerson and zero or more pabGroup entries. This is the top level logical container. pab may contain pabPerson and/or pabGroup. A pabPerson may belong in zero or more pabGroup and zero or more pab.

pabPerson may belong to zero or more pabGroup entries. This link is established by memberOfPABGroup, a multi-valued attribute holding the DN of the pabGroup in which the pabPerson belongs. A pabPerson may also belong to many personal address book's. This link is established by having the DN of the pab listed as a value of the attribute memberOfPAB.

All users and groups belong in the default personal address book called "All."


Superior Class
top


Object Class Type
structural


OID
2.16.840.1.113730.3.2.140


Required Attributes
cn


Allowed Attributes
un, description



pabGroup


Supported by
iPlanet Messaging Server 5.0


Definition
pabPerson is a user entry in the personal address book.

pabGroup is the group entry and corresponds to a personal distribution list. For example, the pabGroup "pab-notes" may contain pabPersons micky and john.


Superior Class
top


Object Class Type
structural


OID
2.16.840.1.113730.3.2.139


Required Attributes
cn


Allowed Attributes
un, description, nickName, memberOfPABGroup



pabPerson


Supported by
iPlanet Messaging Server 5.0


Definition
The basic entry in a personal address book is created using the pabPerson object class. This is a structural object class and inherits from inetOrgPerson.


Superior Class
inetOrgPerson


Object Class Type
structural


OID
2.16.840.1.113730.3.2.138


Required Attributes
None


Allowed Attributes
un, organizationName, organizationName, co, mailAlternateAddress, dateOfBirth, memberOfPAB, memberOfPABGroup, nickName, calCalURI, calFBURL



userPresenceProfile


Supported by
iPlanet Messaging Server 5.0


Definition
Used to store the presence information for a user. Currently only two attributes are defined: vacationStartTime and vacationEndTime.


Superior Class
top


Object Class Type
auxiliary


OID
2.16.840.1.113730.3.2.136


Required Attributes
None


Allowed Attributes
vacationStartDate, vacationEndDate


Previous     Contents     Index     DocHome     Next     
Copyright © 2000 Sun Microsystems, Inc. Some preexisting portions Copyright © 2000 Netscape Communications Corp. All rights reserved.

Last Updated March 27, 2001