AddressBookEntry

Describes an entry in an address book. A subtype of Address. Allows you to modify the properties of an address book entry.

Properties

The following table lists properties along with their access and descriptions.

Property	Access	Description
Application	R/O	Application. The Application object.
Categories	R/O	Categories Collection. The collection of Category objects on this Mail, Appointment, Document Reference, Note, Phone Message, Task, or AddressBookEntry.
DisplayName	R/W	String. The descriptive name to be displayed to users. This is a required field. If there are entries in the Address Book without a display name, running "GWCHECK Contents/Fix" against the user database will generate a diplay name for each entry. It will first attempt to generate the display name by using the First and Last name. If these fields are blank, it will use the email address.
DefaultMailingAddress	R/W	AddressBookDefaultMailingAddressConstants. Which postal mailing address to use as the default. Foe example, use the bussiness address for this contact as the default when sending mail.
EmailAddress	R/W	DEFAULT. String. The email address the system uses to deliver mail. The format is determined by EmailType.
EMailAddresses	R/O	EMailAddresses Collection. The collection of Email Addresses on this Address Book Entry. This property should be used only for personal address books. Using it for the System Address Book results in an error.
EmailType	R/W	String. The type of email address. "NGW" indicates an internal GroupWise address. Anything else is an external address. External addresses are submitted to the operating system’s default email transport. (In Windows, for example, this property would be MAPI.)
Fields	R/O	Fields collection. The fields for this entry. GroupWise supports fields on simple address book entries. Address book entries that are groups do not support the Fields collection.
HasThumbnailImageToJPGFile	R/O	Boolean. True if this AddressBook has an associated JPG Thumbnail image; FALSE otherwise.
IMAddresses	R/O	IMAddresses Collection. The collection of Instant Messaging Addresses on this Address Book Entry.
MapiEntryID	R/O	Safe array inside a variant structure. This property is available only using C. The internal C++ code takes a pointer to a variant. Once the variant is received, the calling code must check the variant type and then access the appropriate piece of the variant structure to retrieve the data. In C++, this property calls SafeArrayAccessData and SafeArrayUnaccessData.
MasterRevisionNumber	R/O	Long. The revision number of this entry when it was downloaded to remote.
Members	R/O	GroupMembers collection. If this entry is for a group (ObjType = egwGroup), this object returns the members of the group. Otherwise, it returns an empty collection.
ObjType	R/W	Enum (AddressTypeConstants). Type of entity this entry represents.
Parent	R/O	AddressBookEntries collection. The AddressBookEntries collection that owns this object.
RevisionNumber	R/O	Long. The number of times this entry has been changed.

Methods

Delete(): Deletes this address book entry from the parent AddressBookEntries collection, and from the address book. Deleting an AddressBookEntry from certain address book providers is not allowed and may throw an exception. The GroupWise system address book does not allow deletions.

Refresh()

Forces this AddressBookEntry object, and associated Fields, to reread property values from the message database. An AddressBookEntry object is refreshed when its refresh method is called or its parent object is refreshed.

RemoveThumbnailImage()

If this AddressBookEntry has an associated thumbnail, removes the image from the AddressBookEntry.

SetImageAsJPGThumbnail(String strFileName)

Takes the image file given in strFileName anf converts it to a JPG Thumbnail image, then stores the thumbnail in the AddressBookEntry.

Image files may be a JPG, GIF, BMP, PNG, TIFF, WMF, or ICON type.

SaveThumbnailImageToJPGFile(String strFileName)

If this AddressBookENtry has an associated thumbnail, it saves the image to the given file name.

NOTE:All thumbnail images are stored in JPG format. It is strongly suggested that the given file name end with a “.jpg” extension.

Fields

There are three birthday fields:

BIRTHDAY_DAY
BIRTHDAY_MONTH
BIRTHDAY_YEAR

These statements are numeric filter expressions. For example, BIRTHDAY_MONTH=4 finds all Address Book entries with a birthday in the month of April. To allow for broader searching capabilities, these fields were purposely split into the three sections.