Previous     Contents     Index     Next     
iPlanet Messaging and Collaboration Schema Reference



Chapter 2   Object Classes


This chapter describes LDAP object classes for iPlanet Messaging and Collaboration products. The objects are listed alphabetically.



List of Object Classes



This chapter describes the following object classes for iPlanet Messaging and Collaboration products:



Object Classes



domain


Supported by
iPlanet Messaging Server 5.0, iPlanet Calendar Server 5.1


Definition
Object class used to define entries that represent DNS domains.

This class can only be used with an entry that doe not correspond to an organization, organizational unit, or other type of object for which an object class has been defined.

This is a core class for both Messaging and Calendar products.


Superior Class
top


Object Class Type
structural


OID
0.9.2342.19200300.100.4.13


Required Attributes
dc, objectClass


Allowed Attributes
associatedName, businessCategory, description, destinationIndicator, fax (facsimileTelephoneNumber), internationalIsdnNumber, localityName, manager, o (organizationName), physicalDeliveryOfficeName, postOfficeBox, postalAddress, postalCode, preferredDeliveryMethod, registeredAddress, searchGuide, seeAlso, st, street, telephoneNumber, telexTerminalIdentifier, telexNumber, userPassword, x121Address



groupOfUniqueNames


Supported by
iPlanet Messaging Server 5.0


Definition
Defines entries for a group of unique names.


Superior Class
top


Object Class Type


OID
2.5.6.17


Required Attributes
cn, objectClass


Allowed Attributes
businessCategory, description, o, ou, owner, seeAlso, uniqueMember



icsCalendarResource


Supported by
iPlanet Calendar Server 5.1


Definition
Specifies a calendar resource. Must be used in conjunction with inetResource.


Superior Class
inetResouce


Object Class Type
auxiliary


OID
2.16.840.1.113730.3.2.143


Required Attributes
N/A


Allowed Attributes
cn, facsimileTelephoneNumber, icsTimezone, postalAddress, uid



icsCalendarUser


Supported by
iPlanet Calendar Server 5.1


Definition
Specifies a calendar user.


Superior Class


Object Class Type


OID
2.16.840.1.113730.3.2.141


Required Attributes
N/A


Allowed Attributes
cn, givenName, icsDefaultSet, icsExtendedUserPrefs, icsFirstDay, icsSet, icsSubscribed, icsTimezone, mail, preferredLanguage, sn, uid, userPassword



inetAdmin


Supported by
iPlanet Messaging Server 5.0


Definition
Identifies administrator user or group.


Superior Class
top


Object Class Type
Auxiliary


OID
2.16.840.1.113730.3.2.112


Required Attributes
objectClass


Allowed Attributes
memberOf, adminRole



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
N/A


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 RFC 2256), 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
N/A



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
N/A


Allowed Attributes
domainUidSeparator, inetDomainSearchFilter, inetDomainCertMap, inetCanonicalDomainName



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
N/A


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
N/A


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 (proxy authentication) 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
N/A


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
N/A


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



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
N/A


Allowed Attributes
mgmanAllowSubscribe, mgmanDenySubscribe, mgmanGoodbyeText, mgmanHidden, mgmanIntroText, mgmanJoinability, mgmanMemberVisibility, mgmanVisibility, 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
N/A


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



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
description, mnggrpAdditionPolicy, mnggrpBillableUser, mnggrpCurrentUsers, mnggrpDeletionPolicy, mnggrpMailQuota, mnggrpMaxUsers, mnggrpStatus, mnggrpUserClassOfServices, nsdaModifiableBy, owner



inetResource


Supported by
iPlanet Calendar Server 5.1


Definition
Specifies a resource.


Superior Class


Object Class Type


OID
2.16.840.1.113730.3.2.142


Required Attributes
cn


Allowed Attributes
facsimileTelephoneNumber, inetCOS, inetResourceStatus, mail, postalAddress, telephoneNumber



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
N/A


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
N/A.


Allowed Attributes
inetUserHttpURL, inetUserStatus, memberOf, uid, userPassword



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
N/A


Allowed Attributes
inetCOS, memberOfManagedGroup, maxPabEntries, pabURI



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
N/A


Allowed Attributes
mailAccessProxyPreAuth, mailAccessProxyReplay, mailClientAttachmentQuota, mailDomainAllowedServiceAccess, mailDomainConversionTag, mailDomainCatchallAddress, mailDomainMsgMaxBlocks, mailDomainMsgQuota, mailDomainReportAddress, mailDomainSieveRuleSource,mailDomainStatus, mailDomainWelcomeMessage, mailQuota,mailRoutingHosts, mailRoutingSmartHost, preferredLanguage, preferredMailHost, preferredMailMessageStore



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
N/A


Allowed Attributes
msgVanityDomain



nsManagedDept


Supported by
iPlanet Messaging Server 5.0


Definition
Stores information for a non-administrator group. Every non-administrator group must contain this object class in order to be managed by iPlanet Delegated Administrator.


Superior Class
groupOfUniqueNames


Object Class Type


OID
2.16.840.1.113730.3.2.88


Required Attributes
objectClass


Allowed Attributes
nsMaxDepts, nsMaxUsers, nsNumDepts, nsNumUsers, nsdaModifiableBy, owner



nsManagedDeptAdminGroup


Supported by
iPlanet Messaging Server 5.0


Definition
Stores information for a group of administrators.


Superior Class
top


Object Class Type


OID
2.16.840.1.113730.3.2.111


Required Attributes
objectClass


Allowed Attributes
N/A



nsManagedDomain


Supported by
iPlanet Messaging Server 5.0


Definition
Stores information for an organization. All organizations must contain this object class in order to be managed by iPlanet Delegated Administrator.


Superior Class
top


Object Class Type


OID
2.16.840.1.113730.3.2.86


Required Attributes
objectClass


Allowed Attributes
nsDefaultMaxDeptSize, nsMaxDepts,nsMaxDomains, nsMaxMailingLists, nsMaxUsers, nsNumDepts, nsNumDomains, nsNumMailLists, nsNumUsers, nsdaModifiableBy, owner



nsManagedFamilyGroup


Supported by
iPlanet Messaging Server 5.0


Definition
Stores information for a family group managed by a delegated administrator. The family group is like a Group, with a few differences. It was added primarily to support Delegated Administrator deployments using Sun Internet Message Service (SIMS) 4.0.


Superior Class
top


OID
2.16.840.1.113730.3.2.89


Required Attribute
objectClass


Allowed Attributes
nsMaxUsers, nsNumUsers, nsdaModifiableBy, owner



nsManagedISP


Supported by

iPlanet Messaging Server 5.0

Definition
Tracks the number of sub-organizations that can be created under this object.


Superior Class
top


OID
2.16.840.1.113730.3.2.85


Required Attribute
objectClass


Allowed Attributes
nsNumDomains



nsManagedMailList


Supported by
iPlanet Messaging Server 5.0


Definition
Stores information for a mail list created by enabled users. A mail list must contain this object class in order to be managed by Delegated Administrator.


Superior Class
top


Object Class Type


OID
2.16.840.1.113730.3.2.90


Required Attributes
objectClass


Allowed Attributes
nsMaxUsers, nsNumUsers, nsdaModifiableBy, owner



nsManagedOrgUnit


Supported by
iPlanet Messaging Server 5.0


Definition
Stores information for a managed organizational unit.


Superior Class
top


OID
2.16.840.1.113730.3.2.87


Required Attributes
objectClass


Allowed Attributes
nsdaModifiableBy, owner



nsManagedPerson


Supported by
iPlanet Messaging Server 5.0


Definition
Stores information about a user. A user entry must contain this object class in order to be managed by Delegated Administrator.


Superior Class
top


Object Class Type


OID
2.16.840.1.113730.3.2.91


Required Attributes
objectClass


Allowed Attributes
memberOf, nsdaCapability, nsDefaultMaxDeptSize, nsdaModifiableBy, owner



nsUniquenessDomain


Supported by
iPlanet Messaging Server 5.0


Definition
This object class was used as a marker to identify the subtree where the uniqueness of uid should be enforced. The uid uniqueness plugin uses this to determine the scope or sphere of influence for enforcing uniqueness.


Superior Class
top


OID
2.16.840.1.113730.3.2.115


Required Attributes
objectClass


Allowed Attributes
N/A



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
description, un



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
description, memberOfPABGroup, nickName, un



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
N/A


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



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
N/A


Allowed Attributes
vacationEndDate, vacationStartDate


Previous     Contents     Index     Next     
Copyright © 2002 Sun Microsystems, Inc. All rights reserved.

Last Updated January 30, 2002