For the complete experience, please enable JavaScript in your browser. Thank you!

  • Creative Cloud
  • Photoshop
  • Illustrator
  • InDesign
  • Premiere Pro
  • After Effects
  • Lightroom
  • See all
  • See plans for: businesses photographers students
  • Document Cloud
  • Acrobat DC
  • eSign
  • Stock
  • Elements
  • Marketing Cloud
  • Analytics
  • Audience Manager
  • Campaign
  • Experience Manager
  • Media Optimizer
  • Target
  • See all
  • Acrobat Reader DC
  • Adobe Flash Player
  • Adobe AIR
  • Adobe Shockwave Player
  • All products
  • Creative Cloud
  • Individuals
  • Photographers
  • Students and Teachers
  • Business
  • Schools and Universities
  • Marketing Cloud
  • Document Cloud
  • Stock
  • Elements
  • All products
  • Get Support
    Find answers quickly. Contact us if you need to.
    Start now >
  • Learn the apps
    Get started or learn new ways to work.
    Learn now >
  • Ask the community
    Post questions and get answers from experts.
    Start now >
    • About Us
    • Careers At Adobe
    • Investor Relations
    • Privacy  |  Security
    • Corporate Responsibility
    • Customer Showcase
    • Events
    • Contact Us
News
    • 3/22/2016
      Adobe Summit 2016: Are You An Experience Business?
    • 3/22/2016
      Adobe Announces Cross-Device Co-op to Enable People-Based Marketing
    • 3/22/2016
      Adobe and comScore Advance Digital TV and Ad Measurement
    • 3/22/2016
      Adobe Marketing Cloud Redefines TV Experience
CFML Reference / 

Contacts Searching Functions

Adobe Community Help


Applies to

  • ColdFusion

Contact support

 
By clicking Submit, you accept the Adobe Terms of Use.
 

Searching a contact

You can use the find function to search through the contacts list with a criterion.

Method summary

Purpose

Method summary

Find contacts based on the filter options

 

find(String filter, Array fields)

  • Returns – An array of Contact objects. If the fields are specified, the returned Contact object will contain values for only those fields.
  • Params
    • filter – A string to specify the filter for search.
    • fields - Array of fields to include in the returned Contact Object. Note that the search will be performed only for the specified fields. Valid values include name, displayName, phoneNumbers, and *.

An example

To find a contact “Rob” matching the name and displayName:

<cfset cntlst=cfclient.contacts.find("Rob",["name","displayName"])>
<cfscript>
for (i = 1; i <= #arrayLen(cntlst)#; i = i + 1) {
/*Populating the content of the <div> with the ID divId*/
document.getElementById('divId').innerHTML=cntlst[i]. displayName;

}
</cfscript>

Getting all contact information

To quickly get a list of all contacts, use the getAllContacts function as shown in the following example:

Method summary

Remove the contact matching filter

Method summary

Get all the stored contacts

getAllContacts

  • Returns – an array of Contact objects. If the fields are specified, the returned contact object contains values only for those fields.
  • Params
    • fields – an array of fields to include in the returned Contact Object. The valid values include name, displayName, phoneNumbers, and *(indicates all fields).

An example

To enumerate all the contacts:

<cfset cntlst=cfclient.contacts.getAllContacts(["name"])>
<cfscript>
for (i = 1; i <= #ArrayLen(cntlst)#; i = i + 1) {
/*Populating the content of the <div> with the ID divId*/
document.getElementById('divId').innerHTML=
cntlst[i].name.givenName;

}
</cfscript>

The Contact object

The following list describes the properties available for the Contact object:

  • id
  • displayName
  • name (ContactName)
  • nickName
  • phoneNumbers (ContactField [])
  • emails (ContactField [])
  • ims (ContactField [])
  • organizations
  • birthday
  • note
  • photos (ContactField [])
  • categories (ContactField [])
  • urls (ContactField [])


The following APIs are supported only on Android devices. Some of these APIs may not work on iOS devices.

The following list describes the functions available for the Contacts object:

  • getMobileNumber()
  • getHomeNumber()
  • getWorkNumber()
  • getPreferredNumber
  • addPhoneNumber(value,type,pref)
  • addEmail(value,type,pref)
  • addAddress(ContactAddress )
  • addOrganization(ContactOrganization )
  • addIm(value,type,pref)
  • addPhoto(value,type,pref)
  • addCategory(value,type,pref)
  • addURL(value,type,pref)

 

The Contact Object supports a few additional methods. For more information about the supported methods, read this document.

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy

Choose your region United States (Change)   Products   Downloads   Learn & Support   Company
Choose your region Close

Americas

Europe, Middle East and Africa

Asia Pacific

  • Brasil
  • Canada - English
  • Canada - Français
  • Latinoamérica
  • México
  • United States
  • Africa - English
  • Österreich - Deutsch
  • Belgium - English
  • Belgique - Français
  • België - Nederlands
  • България
  • Hrvatska
  • Cyprus - English
  • Česká republika
  • Danmark
  • Eesti
  • Suomi
  • France
  • Deutschland
  • Greece - English
  • Magyarország
  • Ireland
  • Israel - English
  • ישראל - עברית
  • Italia
  • Latvija
  • Lietuva
  • Luxembourg - Deutsch
  • Luxembourg - English
  • Luxembourg - Français
  • Malta - English
  • الشرق الأوسط وشمال أفريقيا - اللغة العربية
  • Middle East and North Africa - English
  • Moyen-Orient et Afrique du Nord - Français
  • Nederland
  • Norge
  • Polska
  • Portugal
  • România
  • Россия
  • Srbija
  • Slovensko
  • Slovenija
  • España
  • Sverige
  • Schweiz - Deutsch
  • Suisse - Français
  • Svizzera - Italiano
  • Türkiye
  • Україна
  • United Kingdom
  • Australia
  • 中国
  • 中國香港特別行政區
  • Hong Kong S.A.R. of China
  • India - English
  • 日本
  • 한국
  • New Zealand
  • Southeast Asia (Includes Indonesia, Malaysia, Philippines, Singapore, Thailand, and Vietnam) - English
  • 台灣

Commonwealth of Independent States

  • Includes Armenia, Azerbaijan, Belarus, Georgia, Moldova, Kazakhstan, Kyrgyzstan, Tajikistan, Turkmenistan, Ukraine, Uzbekistan

Copyright © 2016 Adobe Systems Incorporated. All rights reserved.

Terms of Use | Privacy | Cookies

AdChoices