User Guide Cancel

cfexchangefilter

Last updated on Feb 25, 2025 | Also applies to ColdFusion

CFML Reference User Guide
ColdFusion functions
ColdFusion tags
1. ColdFusion tag summary
2. ColdFusion tags by category
  1. Application framework tags
    1. cfapplication
    2. cfassociate
    3. cferror
    4. cfimport
    5. cfinterface
    6. cflock
    7. cfscript
    8. cfthread
  2. Communications tags
  3. Database manipulation tags
  4. Data output tags
    1. cfchart
    1. cfchartdata
    2. cfchartseries
    3. cfchartset
    4. cfcol
    5. cfcontent
    6. cfdocument
    7. cfdocumentitem
    8. cfdocumentsection
    9. cfflush
    10. cfheader
    11. cflog
    12. cfoutput
    13. cfpresentation
    14. cfpresentationslide
    15. cfpresenter
    16. cfprocessingdirective
    17. cfprint
    18. cfreport
    19. cfreportparam
    20. cfsilent
    21. cftable
  5. Debugging tags
    1. cfdump
    2. cftimer
    3. cftrace
  6. Exception handling tags
    1. cfcatch
    2. cferror
    3. cffinally
    4. cfrethrow
    5. cfthrow
    6. cftry
  7. Extensibility tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcollection
    5. cfcomponent
    6. cfexecute
    7. cfftp
    8. function
    9. cfindex
    10. cfinterface
    11. cfinvoke
    12. cfinvokeargument
    13. cfobject
    14. cfproperty
    15. cfreport
    16. cfreportparam
    17. cfreturn
    18. cfsearch
    19. cfsharepoint
    20. cfspreadsheet
    21. cfwddx
    22. cfxml
  8. File management tags
    1. cfdirectory
    2. cffile
    3. cffileupload
    4. cfftp
    5. cfzip
    6. cfzipparam
  9. Flow-control tags
    1. cfabort
    2. cfbreak
    3. cfcase
    4. cfcontinue
    5. cfdefaultcase
    6. cfelse
    7. cfelseif
    8. cfexecute
    9. cfexit
    10. cfif
    11. cfinclude
    12. cflocation
    13. cfloop
    14. cfrethrow
    15. cfswitch
    16. cfthrow
    17. cftry
  10. Forms tags
    1. cfapplet
    2. cfcalendar
    3. cffileupload
    4. cfform
    5. cfformgroup
    6. cfformitem
    7. cfgrid
    8. cfgridcolumn
    9. cfgridrow
    10. cfgridupdate
    11. cfinput
    12. cfpdf
    13. cfpdfform
    14. cfpdfformparam
    15. cfpdfparam
    16. cfpdfsubform
    17. cfselect
    18. cfslider
    19. cftextarea
    20. cftree
    21. cftreeitem
  11. Internet Protocol tags
    1. cfajaximport
    2. cfajaxproxy
    3. cfftp
    4. cffeed
    5. cfimap
    6. cfhttp
    7. cfhttpparam
    8. cfldap
    9. cfmail
    10. cfmailparam
    11. cfmailpart
    12. cfpop
    13. cfsprydataset
  12. Page processing tags
    1. cfcache
    2. cfcontent
    3. cfflush
    4. cfheader
    5. cfhtmlhead
    6. cfinclude
    7. cfprocessingdirective
    8. cfsetting
    9. cfsilent
  13. Security tags
  14. Variable manipulation tags
    1. cfcookie
    2. cfdump
    3. cfparam
    4. cfregistry
    5. cfsavecontent
    6. cfschedule
    7. cfset
    8. cfsetting
  15. Other tags
    1. cfimage
    2. cflog
    3. cfregistry
3. Tags a-b
4. Tags c
5. Tags f
6. Tags g-h
  1. cfgraph
  2. cfgraphdata
  3. cfgrid
  4. cfgridcolumn
  5. cfgridrow
  6. cfgridupdate
  7. cfheader
  8. cfhtmlhead
  9. cfhtmltopdf
  10. cfhtmltopdfitem
  11. cfhttp
  12. cfhttpparam
7. Tags i
  1. cfif
  2. cfimage
  3. cfimap
  4. cfimapfilter
  5. cfimpersonate
  6. cfimport
  7. cfinclude
  8. cfindex
  9. cfinput
  10. cfinsert
  11. cfinterface
  12. cfinvoke
  13. cfinvokeargument
8. Tags j-l
9. Tags m-o
10. Tags p-q
  1. cfparam
  2. cfpdf
  3. cfpdfform
  4. cfpdfformparam
  5. cfpdfparam
  6. cfpdfsubform
  7. cfpod
  8. cfpop
  9. cfpresentation
  10. cfpresentationslide
  11. cfpresenter
  12. cfprint
  13. cfprocessingdirective
  14. cfprocparam
  15. cfprocresult
  16. cfprogressbar
  17. cfproperty
  18. cfquery
  19. cfqueryparam
11. Tags r-s
  1. cfregistry
  2. cfreport
  3. cfreportparam
  4. cfrethrow
  5. cfreturn
  6. cfsavecontent
  7. cfschedule
  8. cfscript
  9. cfsearch
  10. cfselect
  11. cfservlet
  12. cfservletparam
  13. cfset
  14. cfsetting
  15. cfsharepoint
  16. cfsilent
  17. cfslider
  18. cfspreadsheet
  19. cfsprydataset
  20. cfstoredproc
  21. cfswitch
12. Tags t
  1. cftable
  2. cftextarea
  3. cftextinput
  4. cfthread
  5. cfthrow
  6. cftimer
  7. cftooltip
  8. cftrace
  9. cftransaction
  10. cftree
  11. cftreeitem
  12. cftry
13. Tags u-z
  1. cfupdate
  2. cfwddx
  3. cfwebsocket
  4. cfwindow
  5. cfxml
  6. cfzip
  7. cfzipparam
CFML Reference
1. Reserved words and variables
2. Ajax JavaScript functions
3. ColdFusion ActionScript functions
4. ColdFusion mobile functions
5. Application.cfc reference
6. Script functions implemented as CFCs
7. ColdFusion Flash Form style reference
8. ColdFusion event gateway reference
9. ColdFusion C++ CFX Reference
10. ColdFusion Java CFX reference
11. WDDX JavaScript Objects
Cloud services

Description

Specifies filter parameters that control the actions of cfexchangemail, cfexchangecalendar, cfexchangetask, and cfexchangecontact, get operations.

History

ColdFusion (2025 release):
- Changes:
  - Calendar filtering: Filtering by duration, message, and requiredAttendees is not supported in Exchange Online.
  - Contact filtering: hasAttachment filtering is not supported because attachments are no longer part of contact resources.
  - Task filtering: Filtering by actualWork, billingInfo, companies, mileage, percentageCompleted, and totalWork is not supported.
- Deviation:
  - Filters that were previously available are now restricted in Exchange Online.
ColdFusion 8: Added this tag.

Syntax

Note: You can specify this tag's attributes in an attributeCollection attribute whose value is a structure. Specify the structure name in the attributeCollection attribute and use the tag's attribute names as structure keys.

Attributes

Attribute	Req/Opt	Description
name	Required	The type of filter to use.
from	Optional	The start date or date/time combination of the range to use for filtering. Cannot be used with the value attribute. If you specify a from attribute without a to attribute, the filter selects for all entries on or after the specified date or time. The value can be in any date/time format recognized by ColdFusion, but must correspond to a value that is appropriate for the filter type.
to	Optional	The end date or date/time combination for the range used for filtering. Cannot be used with the value attribute. If you specify a to attribute without a from attribute, the filter selects for all entries on or before the specified date or time. The value can be in any date/time format recognized by ColdFusion, but must correspond to a value that is appropriate for the filter type.
value	Optional	The filter value for all filters that do not take a date or time range. Cannot be used with the from and to attributes.ColdFusion generates an error if you specify this attribute with an empty contents. Therefore, you cannot use the empty string to search for empty values. If you set this attribute to the empty string (""), ColdFusion searches for entries where the specified field is empty. 6.07

The cfexchangeCalendar tag filters can have the following name attributes and associated value, or to and from attributes that you use to specify the filter parameters for the specified action:

name attribute	Specification attributes	Valid specification attribute values
maxRows	value	A positive integer specifying the maximum number of matching rows to return. By default, the maximum number of rows is 100. You can also specify -1; to return all matching rows.
allDayEvent	value	A Boolean value.
duration	value	An integer number of minutes.
endTime	from to	A string that ColdFusion can interpret as a date-time value.
fromID	value	An Exchange user ID.
hasAttachment	value	A Boolean value.
importance	value	One of the following values: high normal low
isRecurring	value	A Boolean value.
location	value	A string.
message	value	A string.
optionalAttendees	value	A comma-delimited list of Exchange user IDs.
organizer	value	A string that identifies the organizer. This value does not need to be an Exchange ID or e-mail address.
requiredAttendees	value	A comma-delimited list of Exchange user IDs.
sensitivity	value	One of the following values: normal personal private confidential
startTime	from to	A string that ColdFusion can interpret as a date-time value.
subject	value	A string.
UID	value	A case-sensitive Exchange message UID that uniquely identifies one calendar entry.

The cfexchangecontact tag filters can have the following name attributes and associated value attributes. Unlike other tags, you do not use from or to attributes.

name attribute	value attribute
maxRows	A positive integer that specifies the maximum number of matching rows to return. By default, the maximum number of rows is 100. You can also specify -1; to return all matching rows.
assistant	A string.
businessAddress	A structure with the following fields: Street, City, State, Zip, Country.
businessFax	A string.
businessPhoneNumber	A string.
categories	A comma-delimited list of categories. The filter searches for contacts that match all the categories in the list.
company	A string.
description	A string.
displayAs	A string.
email1	A string.
email2	A string.
email3	A string.
firstName	A string.
hasAttachment	A Boolean value.
homeAddress	A structure with the following fields: Street, City, State, Zip, Country.
homePhoneNumber	A string.
jobTitle	A string.
lastName	A string.
mailingAddressType	One of the following values: Home, Business, Other.
manager	A string.
middleName	A string.
mobilePhoneNumber	A string.
nickName	A string.
office	A string.
otherAddress	A structure with the following fields: Street, City, State, Zip, Country.
otherPhoneNumber	A string.
pager	A string.
profession	A string.
spouseName	A string.
webPage	A string.

The cfexchangemail tag filters can have the following name attributes and associated value, or to and from attributes that you use to specify the filter parameters for the specified action:

name attribute	Specification attributes	Specification attribute values
maxRows	value	A positive integer that specifies the maximum number of matching rows to return. By default, the maximum number of rows is 100. You can also specify -1; to return all matching rows.
bcc	value	A comma-delimited list of Exchange or web e-mail addresses.
cc	value	A comma-delimited list of Exchange or web e-mail addresses.
folder	value	The forward slash delimited path from the root of the Exchange mailbox to the folder to search. By default, the filter searches the top level of the Inbox. The cfexchangemail tag searches only the specified folder, and does not search any subfolders. If a folder name contains a forward slash, use the xF8FF escape sequence to specify the character in the name. For the get and move actions, you can use the cfexchangemail tag folder attribute instead of this field; however, this field takes precedence over the value specified in the folder attribute.
fromID	value	An Exchange or web e-mail address.
hasAttachment	value	A Boolean value
importance	value	One of the following values: high normal low
isRead	value	A Boolean value.
message	value	A string.
MessageType	value	One of the following values: Mail, Meeting, Meeting_Cancel, Meeting_Request, Meeting_Response, or All. If you omit this attribute, the filter gets messages of all types. The Meeting attribute gets messages with Meeting_Cancel, Meeting_Request, and Meeting_Response types.
MeetingUID	value	A case-sensitive Exchange calendar event UID. Meeting UIDs are used in Meeting_request or Meeting_response message types only. Do not specify this field if you specify a MessageType field value of Mail.
sensitivity	value	One of the following values: normal personal private confidential
subject	value	A string.
timeReceived	from to	A string that ColdFusion can interpret as a date-time value.
timeSent	from to	A string that ColdFusion can interpret as a date-time value.
toID	value	A comma-delimited list of Exchange or web e-mail addresses.
uid	value	A case-sensitive Exchange message UID.

The cfexchangetask tag filters can have the following name attributes and associated value, or to and from attributes that you use to specify the filter parameters for the specified action:

name attribute	Specification attributes	Specification attribute values
maxRows	value	A positive integer specifying the maximum number of matching rows to return. By default, the maximum number of rows is 100. You can also specify -1; to return all matching rows.
actualWork	value	A number representing the number of hours. Use decimal numbers to specify minutes.
billingInfo	value	A string.
companies	value	A string.
dateCompleted	value	A string that ColdFusion can interpret as a date-time value.
dueDate	from to	A string that ColdFusion can interpret as a date-time value.
mail_ID	value	A comma-delimited list of Exchange mail IDs. This filter value is useful if the connection user has delegate rights for multiple users and you want to select the tasks of a limited number of those users.
message	value	A string.
mileage	value	A string.
percentCompleted	value	A number between 0 and 100.
priority	value	One of the following values: high normal low
reminderDate	value	A string that ColdFusion can interpret as a date-time value.
startDate	from to	A string that ColdFusion can interpret as a date-time value.
status	value	Must be one of the following values: NOT_STARTED IN_PROGRESS COMPLETED WAITING DEFERRED
subject	value	A string.
totalWork	value	A number that represents the number of hours. Use decimal numbers to specify minutes.
UID	value	A case-sensitive Exchange UID.

Usage

The cfexchangefilter tag specifies the conditions to match when ColdFusion gets mail messages, calendar entries, tasks, or contacts. Only those entries that match the specified filter conditions are returned in the structure specified by the parent tag's name attribute. If the filter specifies a field that takes a text string, such as Message and or Subject, ColdFusion returns items that contain the exact phrase that you specify in the value attribute.
The cfexchangefilter tag must be a child tag of a cfexchangecalendar, cfexchangecontact, cfexchangemail, or cfexchangetask tag with an action attribute value of get. If you specify multiple cfexchangefilter tags in the body of a ColdFusion exchange tag, such as cfexchangemail, the specified filters are cumulative, and the selected records match the conditions specified in all the cfexchangefilter tags. If you specify multiple cfexchangefilter tags with the same name attribute value, the last tag with that attribute specifies the filter conditions.

Example

The following example gets the mail messages that were sent to a user during the last week from any e-mail address that includes adobe.com. To focus on getting messages, rather than on displaying data, the example uses the cfdump tag to show the results.

Get help faster and easier

New user?

cfexchangefilter

Description

History

Category

Syntax

See also

Attributes

Usage

Example

Get help faster and easier

Share this page

Ask the Community

Contact Us