Description
Specifies filter parameters that control the actions of cfimap, get operations.
History
ColdFusion 11: Added this tag.
Category
Syntax
<cfimapfilter name = "filter type" value = "filter value"> OR <cfimapfilter name = "filter type" from = "date/time" to = "date/time">
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.
See also
cfimap, Getting Exchange items and attachments in the Developing ColdFusion Applications
Attributes
Attribute |
Req/Opt |
Default |
Description |
|||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name |
Required |
|
The type of filter to use. The supported filters in ColdFusion are:
|
|||||||||||||||||||||||||||||||||||||||||||||||||
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. |
|||||||||||||||||||||||||||||||||||||||||||||||||
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. |
|||||||||||||||||||||||||||||||||||||||||||||||||
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 empty contents. Therefore, you cannot use the empty string to search for empty values. |
Example
<cfimap action="getall" connection = "imapConnection" name = "emailTable" > <cfimapfilter name="subject" value="meeting"> </cfimap>
Sign in to your account