JDBC Driver for Microsoft Exchange

Build 25.0.9434

Contacts

Maintains contact information including names, email addresses, phone numbers, and job titles. It supports full Create, Read, Update, and Delete (CRUD) operations for managing a user's personal or shared address book.

Table Specific Information

Update and Delete

The driver will need the ItemChangeKey to update or delete an item. However, if you are unsure of the ItemChangeKey, the driver is able to retrieve it from the Exchange server automatically. Note that this may increase the time it takes to perform a query.

Columns

Name Type ReadOnly Description
ItemId [KEY] String True

Provides the unique identifier assigned by the Exchange store to a contact item. This value is required to retrieve or reference the contact and is immutable and read-only.

MimeContent String True

Contains the raw content of the contact item in Multipurpose Internet Mail Extensions (MIME) format, encoded as Base64. This field is used for interoperability with external systems that handle MIME-based message representations.

ItemChangeKey String True

Specifies a unique version identifier for the contact item. This key updates whenever the item is modified and helps to manage concurrency and track changes. It is read-only.

ParentFolderId String False

Identifies the folder in which the contact is stored. This ID is unique within the Exchange store and is used to trace the contact's hierarchy. It is read-only and primarily used for organizational queries.

ParentFolderChangeKey String True

Stores the unique change key for the folder containing the contact. This value updates when the folder is modified and is used to detect structural or content changes within the folder. It is read-only.

ItemClass String False

Indicates the type of the item based on Exchange classification. For contact items, this is typically set to 'IPM.Contact', but can vary if custom message classes are used.

Subject String False

Provides a short text summary or label for the contact item, often used as the display name or quick reference. The subject can contain up to 255 characters and is commonly visible in UI listings.

Sensitivity String True

Represents the sensitivity classification of the contact, such as Normal, Personal, Private, or Confidential. This field helps users and systems determine how the contact data should be handled.

Body String False

Contains the main text content associated with the contact, such as notes or background information. This can include user-entered freeform text and is often used to provide context or descriptions.

DateTimeReceived Datetime True

Captures the timestamp of when the contact item was received or created in the mailbox. This datetime value is useful for sorting or filtering contacts based on recency.

Size Integer True

Indicates the total size of the contact item in bytes, including metadata and body content. This value is useful for storage management and is automatically calculated by Exchange. It is read-only.

Categories String False

Holds a semicolon-separated list of category labels applied to the contact. These categories help organize and group contact items for easier retrieval or color-coding in the user interface.

Importance String False

Defines the priority level assigned to the contact. Typical values include Low, Normal, and High, allowing clients to rank or highlight contacts based on their relative significance.

IsSubmitted Boolean True

Specifies whether the contact item has been successfully submitted to the Outbox default folder, indicating it is in the process of being sent or has been queued for sending.

InReplyTo String True

Stores the identifier of the original item to which the current item is a response, enabling threaded conversation tracking in messaging systems.

IsDraft Boolean True

Indicates whether the contact item is currently saved as a draft, meaning it is incomplete or has not yet been finalized or sent.

IsFromMe Boolean True

Determines whether the item was sent by the user to themselves, which can occur in scenarios such as self-reminders or test messages.

IsResend Boolean True

Indicates whether this item is a re-sent version of a previously sent message, typically used in retry or correction workflows.

IsUnmodified Boolean True

Identifies whether the item has remained unchanged since it was created or last saved, useful for detecting edited or updated records.

InternetMessageHeaders String True

Contains the full set of Internet message headers associated with an item in a mailbox, including metadata such as Received, Subject, From, To, Date, Message-ID, MIME-Version, Content-Type, and other transmission-related fields.

DateTimeSent Datetime True

Records the exact date and time the contact-related item was sent from the user's mailbox, useful for chronological sorting and delivery auditing.

DateTimeCreated Datetime True

Captures the timestamp when the contact item was originally created in the mailbox, regardless of whether it was later modified or sent.

ReminderDueBy Datetime False

Specifies the date and time by which a reminder associated with the contact item is due, helping trigger alerts or notifications for follow-up actions.

ReminderIsSet Boolean False

Specifies whether a reminder notification is enabled for this Exchange item. A value of true means the user will receive a reminder prior to the start time of the associated event or task.

ReminderMinutesBeforeStart Integer False

Defines how many minutes before the scheduled start time a reminder should appear. Commonly used for appointments, tasks, or meeting requests.

DisplayCc String True

Contains the display-friendly, comma-separated list of recipients in the Cc (Carbon Copy) field. This string aggregates recipient display names for rendering in user interfaces.

DisplayTo String True

Contains the display-friendly, comma-separated list of recipients in the To field. This string aggregates recipient display names as shown in email clients or message previews.

HasAttachments Boolean True

Indicates whether the item includes one or more visible file attachments. This flag is set to true if attachments are present and accessible by users.

Culture String False

Specifies the locale or cultural setting applied to the item, such as 'en-US' or 'fr-FR'. This can affect date formats, regional settings, and language display.

EffectiveRights_CreateAssociated Boolean True

Indicates whether the user or client application has permission to create associated contents for the item, typically used for hidden or metadata-bound items within a folder.

EffectiveRights_CreateContents Boolean True

Indicates whether the user or client application has permission to add new content items (such as messages or events) to the folder.

EffectiveRights_CreateHierarchy Boolean True

Indicates whether the user or client application is allowed to create subfolders within the current folder, forming part of the folder hierarchy.

EffectiveRights_Delete Boolean True

Indicates whether the user or client application has permission to delete the folder or individual item.

EffectiveRights_Modify Boolean True

Indicates whether the user or client application can update or change the contents of the folder or item, including properties or data values.

EffectiveRights_Read Boolean True

Indicates whether the user or client application is permitted to view the contents of the folder or item, including metadata and body content.

EffectiveRights_ViewPrivateItems Boolean True

Indicates whether the user or client has visibility into private items—typically calendar events or tasks marked as private by another user.

LastModifiedName String True

Specifies the display name of the user who most recently modified the contact item. This helps track changes and determine ownership of updates.

LastModifiedTime Datetime True

Captures the timestamp of the most recent modification to the contact item. This field is maintained automatically and is read-only.

IsAssociated Boolean False

Indicates whether the contact item is associated with a specific folder, such as a system or hidden folder used for metadata or conversation tracking.

WebClientReadFormQueryString String True

Provides a URL query string that, when appended to the Outlook Web App endpoint, allows users to view the contact item directly in the browser.

WebClientEditFormQueryString String True

Provides a URL query string that enables users to open the contact item in edit mode using the Outlook Web App interface.

ConversationId String True

Stores the identifier that links the contact item to a broader conversation thread in the Exchange environment. Useful for conversation grouping and tracking.

UniqueBody String True

Contains the unique portion of the message body that is specific to the current contact item, excluding any redundant or quoted content. This can be formatted as HTML or plain text.

UniqueBodyType String True

Indicates the format used to store the unique body content, such as HTML or TEXT, to assist in rendering or parsing the message body appropriately.

FileAs String False

Defines how the contact or distribution list should be sorted and displayed within the Contacts folder. Common formats include Last Name, First Name or Company Name.

FileAsMapping String False

Determines the logic used to construct the 'File As' value for the contact, typically based on selected fields like first name, last name, or company.

DisplayName String False

Represents the display name shown for the contact, distribution list, rule, delegate user, or location. This value is typically user-friendly and used in UI listings.

GivenName String False

Stores the first name or given name of the contact, which can be used in sorting, searching, or composing personalized messages.

Initials String False

Stores the abbreviated initials of the contact's full name, commonly derived from the first letter of each part of the name (for example, J.D. for John Doe).

MiddleName String False

Contains the middle name or initial of the contact, used for full name representation and identity disambiguation.

Nickname String False

Holds the informal or familiar name by which the contact is commonly known, distinct from their legal first name.

CompleteName_Title String True

Specifies the contact's formal title or honorific (such as Mr., Mrs., Dr., or Prof.), often used for professional or formal correspondence.

CompleteName_FirstName String True

Represents the given name or first name of the contact, used in full name formatting and indexing.

CompleteName_MiddleName String True

Contains the contact's middle name component, supporting full name rendering and cultural name structures.

CompleteName_LastName String True

Stores the contact's family name or surname, which is often used for sorting and official identification.

CompleteName_Suffix String True

Indicates any generational or academic suffix associated with the contact's name, such as Jr., Sr., III, or Ph.D.

CompleteName_Initials String True

Captures the initials derived from the complete name of the contact, typically used for concise display or indexing.

CompleteName_FullName String True

Stores the contact's full name as a single string, constructed from title, first, middle, last name, and suffix, depending on availability.

CompleteName_Nickname String True

Represents the nickname associated with the contact's full name, used for personalization in informal communications.

CompleteName_YomiFirstName String True

Contains the Yomi phonetic representation of the contact's first name, used for proper pronunciation and sorting in Japanese systems.

CompleteName_YomiLastName String True

Contains the Yomi phonetic representation of the contact's last name, used for proper pronunciation and sorting in Japanese systems.

CompanyName String False

Stores the name of the company or organization with which the contact is affiliated, useful for business context and categorization.

EmailAddress1 String False

Stores the primary email address associated with the contact. This address is typically used as the main point of electronic communication.

EmailAddress2 String False

Stores an alternative email address for the contact. This is useful when the contact has more than one email account for different purposes such as personal or secondary work use.

EmailAddress3 String False

Stores a third email address for the contact, allowing users to track multiple active addresses, such as temporary, external, or archived accounts.

BusinessAddress_Street String False

Contains the street component of the business address where the contact works. This can include building number, street name, and suite or office details.

BusinessAddress_City String False

Indicates the city portion of the contact's business address, often used for filtering or grouping contacts by location in organizational directories.

BusinessAddress_State String False

Captures the state or province associated with the business address of the contact. This can be useful in regional reporting or compliance processes.

BusinessAddress_Country String False

Specifies the country or region in which the contact's business address is located. Used in cross-border communications and location-based filtering.

BusinessAddress_PostalCode String False

Stores the postal or ZIP code for the contact's business address. This field supports geographic sorting and mailing list generation.

HomeAddress_Street String False

Holds the street information for the contact's residential address. May include house number, street name, and apartment or unit number.

HomeAddress_City String False

Indicates the city associated with the contact's home address, often used in demographic profiling or personal contact organization.

HomeAddress_State String False

Specifies the state or province of the contact's residential location. This can assist in regional segmentation or mail delivery validation.

HomeAddress_Country String False

Stores the country or region of the contact's home address, providing context for time zone, language, and cultural preferences.

HomeAddress_PostalCode String False

Captures the postal or ZIP code related to the home address of the contact. This can aid in delivery services or local search filtering.

OtherAddress_Street String False

Contains the street address for an additional contact location, such as a vacation home, alternate office, or temporary residence.

OtherAddress_City String False

Specifies the city name associated with the secondary (Other) address of the contact. This is typically used when a contact has more than one address.

OtherAddress_State String False

Indicates the state, province, or administrative region corresponding to the Other address of the contact.

OtherAddress_Country String False

Captures the name of the country or region for the Other address associated with the contact. This is used when the contact maintains an alternate or secondary location.

OtherAddress_PostalCode String False

Holds the postal or ZIP code corresponding to the Other address of the contact, which can be used for location-based filtering or mail delivery purposes.

AssistantPhone String False

Stores the phone number of the contact's assistant. This field is often used in organizational contexts to reach someone who manages the contact's schedule or communications.

BusinessFax String False

Contains the fax number for the contact's primary place of business. This field supports legacy communication methods still used in some industries.

BusinessPhone String False

Lists the primary business phone number for the contact, typically used during standard work hours or for professional communication.

BusinessPhone2 String False

Provides a secondary business phone number for the contact, allowing for alternate professional contact options if the primary line is unavailable.

Callback String False

Designates a specific phone number the contact has requested to be called back on. This can differ from their primary or business numbers.

CarPhone String False

Stores the contact's car phone number, used in contexts where in-vehicle communication is supported and relevant.

CompanyMainPhone String False

Captures the main switchboard or general phone number of the company with which the contact is affiliated. Often used when individual extensions are not known.

HomeFax String False

Specifies the fax number associated with the contact's home address. This value is typically used for sending documents to a personal fax line.

HomePhone String False

Indicates the primary landline telephone number at the contact's home residence. Commonly used for personal or non-business-related communication.

HomePhone2 String False

Captures an additional home phone number for the contact, allowing for multiple residential contact options.

Isdn String False

Contains the Integrated Services Digital Network (ISDN) number for the contact, used in environments where digital telecommunication is supported.

MobilePhone String False

Stores the contact's primary mobile or cell phone number, generally used for direct and immediate personal communication.

OtherFax String False

Provides an alternative fax number not associated with the home address, potentially linked to another residence or secondary location.

OtherTelephone String False

Holds a secondary phone number for the contact that does not fall under home, business, or mobile categories. Useful for less common communication channels.

Pager String False

Stores the contact's pager number, which can be used in legacy systems or industries that still rely on pager communication.

PrimaryPhone String False

Defines the contact's main telephone number for general communication, regardless of whether it is mobile, home, or business.

RadioPhone String False

Captures the contact's radio telephone number, typically used in industries like maritime, aviation, or emergency services that rely on radio communication devices.

Telex String False

Specifies the telex number for the contact, supporting international text-based communication in legacy messaging networks.

TtyTddPhone String False

Contains the telephone number used with TTY (Text Telephone) or TDD (Telecommunication Device for the Deaf) devices to facilitate communication for individuals with hearing or speech impairments.

AssistantName String False

Specifies the full name of the contact's personal assistant, if applicable. This can be used for coordination or communication purposes.

Birthday Datetime False

Indicates the contact's date of birth. This field supports date-based reminders and personalization features in calendar or CRM systems.

BusinessHomePage String False

Provides the URL of the contact's professional or business-related home page. This could be a company website or a professional profile.

Children_1 String False

Stores the name of the first child associated with the contact. Used to personalize interactions or for recordkeeping in directory-based systems.

Children_2 String False

Stores the name of the second child associated with the contact. This field is optional and complements Children_1 and Children_3.

Children_3 String False

Stores the name of the third child associated with the contact. Intended for contacts with multiple dependents to support family-related tracking.

Companies_1 String False

Contains the name of the first company the contact is affiliated with. Useful for professional context and organizational relationships.

Companies_2 String False

Contains the name of the second company associated with the contact. Helps capture multiple business affiliations if they exist.

Companies_3 String False

Contains the name of the third company linked to the contact. Supports scenarios where the contact is involved in several organizations.

ContactSource String False

Specifies the origin of the contact data, such as whether it is sourced from the Exchange mailbox store or from Active Directory Domain Services.

Department String False

Captures the internal department or organizational unit the contact is part of. Commonly used to group or filter contacts in enterprise directories.

Generation String False

Includes generational suffixes such as Jr., Sr., II, III that appear after the contact's full name to distinguish between family members.

ImAddress1 String False

Stores the primary instant messaging address used by the contact for real-time communications through chat platforms.

ImAddress2 String False

Stores an additional instant messaging address for the contact. Useful if the contact uses multiple messaging platforms.

ImAddress3 String False

Stores a third instant messaging address for the contact, supporting multiple IM channels for redundancy or alternative communications.

JobTitle String False

Stores the professional title or designation of the contact within their organization, such as 'Project Manager' or 'Senior Analyst'.

Manager String False

Indicates the name or identifier of the contact's manager or direct supervisor within an organizational hierarchy.

Mileage String False

Captures mileage information associated with the contact, typically used for tracking travel distance or expenses related to meetings or visits.

OfficeLocation String False

Provides the specific location or address of the contact's office, which can include a room number, building name, or geographic location.

PostalAddressIndex String False

Defines the preferred postal address type for the contact, such as Home, Business, or Other, to determine how mailing-related functions prioritize addresses.

Profession String False

Describes the field of expertise or occupation of the contact, such as 'Engineer', 'Attorney', or 'Educator'.

SpouseName String False

Contains the name of the contact's spouse or partner, useful for personalizing communication and maintaining relationship context.

Surname String False

Stores the last name or family name of the contact, used in formal correspondence and identification.

WeddingAnniversary Datetime False

Records the wedding anniversary date of the contact, which can be used to personalize messages or reminders.

HasPicture Boolean False

Indicates whether the contact entry includes an associated image or profile picture file attachment.

PhoneticFullName String False

Contains the full name of the contact—first and last—spelled using phonetic characters or conventions for pronunciation support.

PhoneticFirstName String False

Represents the phonetic spelling of the contact's first name to assist with proper pronunciation, especially in multilingual environments.

PhoneticLastName String False

Represents the phonetic spelling of the contact's last name to assist with pronunciation, often used in speech recognition and automated systems.

Alias String False

Contains the contact's email alias, typically a simplified or alternative email identifier used in place of the full address.

Notes String False

Stores additional, free-form information about the contact, such as meeting notes, personal preferences, or context not captured in structured fields.

Photo String False

Contains encoded image data or a file reference that visually represents the contact, commonly displayed in address books or messaging applications.

UserSMIMECertificate String False

Contains a Base64-encoded representation of the contact's S/MIME (Secure/Multipurpose Internet Mail Extensions) certificate, used for encrypting and signing email communications.

MSExchangeCertificate String False

Holds a serialized value representing the contact's Microsoft Exchange-specific certificate, typically used for secure messaging and client authentication within an Exchange environment.

DirectoryId String False

Stores the unique identifier assigned to the contact in the directory service (such as Active Directory), which enables lookups and integration with enterprise identity systems.

ManagerMailbox String False

Contains the SMTP email address associated with the mailbox of the contact's manager. This is used in organizational hierarchies to identify supervisory relationships.

DirectReports String False

Holds a comma-separated list of SMTP email addresses for the contact's direct reports, enabling navigation and mapping of reporting structures within a directory or address book.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ImpersonationUser String

Specifies the identifier of the user account to impersonate when performing operations under delegated access. This is commonly used in service scenarios to act on behalf of another user.

ImpersonationType String

Indicates the type of identifier used to locate the impersonation target. Accepted values include PrincipalName, SID, PrimarySmtpAddress, and SmtpAddress.

SharedMailboxEmail String

The SMTP address of a shared mailbox whose contact list should be accessed. This allows retrieval of contact records stored in shared or team mailboxes.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434