User Guide Cancel

cfexchangecalendar

  1. CFML Reference User Guide
  2. ColdFusion functions
    1. ColdFusion functions by category
    2. Functions a-b
      1. Abs
      2. ACos
      3. AddSOAPRequestHeader
      4. AddSOAPResponseHeader
      5. AjaxLink
      6. AjaxOnLoad
      7. ApplicationStop
      8. ArrayAppend
      9. ArrayAvg
      10. ArrayClear
      11. ArrayContains
      12. ArrayContainsNoCase
      13. ArrayDelete
      14. ArrayDeleteAt
      15. ArrayDeleteNoCase
      16. ArrayEach
      17. ArrayFilter
      18. ArrayFind
      19. ArrayFindAll
      20. ArrayFindAllNoCase
      21. ArrayFindNoCase
      22. ArrayInsertAt
      23. ArrayIsDefined
      24. ArrayIsEmpty
      25. ArrayLen
      26. ArrayMap
      27. ArrayMax
      28. ArrayMin
      29. ArrayNew
      30. ArrayPrepend
      31. ArrayReduce
      32. ArrayResize
      33. ArraySet
      34. ArraySetMetadata
      35. ArraySlice
      36. ArraySort
      37. ArraySum
      38. ArraySwap
      39. ArrayToList
      40. Asc
      41. ASin
      42. Atn
      43. AuthenticatedContext
      44. AuthenticatedUser
      45. BinaryDecode
      46. BinaryEncode
      47. BitAnd
      48. BitMaskClear
      49. BitMaskRead
      50. BitMaskSet
      51. BitNot
      52. BitOr
      53. BitSHLN
      54. BitSHRN
      55. BitXor
      56. BooleanFormat
    3. Functions-c-d
      1. CacheGet
      2. CacheGetAllIds
      3. CacheGetMetadata
      4. CacheGetProperties
      5. CacheGetSession
      6. CacheIdExists
      7. CachePut
      8. CacheRegionExists
      9. CacheRegionNew
      10. CacheRegionRemove
      11. CacheRemove
      12. CacheRemoveAll
      13. CacheSetProperties
      14. CallStackDump
      15. CallStackGet
      16. CanDeSerialize
      17. Canonicalize
      18. CanSerialize
      19. Ceiling
      20. CharsetDecode
      21. CharsetEncode
      22. Chr
      23. CJustify
      24. Compare
      25. CompareNoCase
      26. Cos
      27. CreateDate
      28. CreateDateTime
      29. CreateObject
      30. CreateObject: .NET object
      31. CreateObject: COM object
      32. CreateObject: component object
      33. CreateObject: CORBA object
      34. CreateObject: Java or EJB object
      35. CreateObject: web service object
      36. CreateODBCDate
      37. CreateODBCDateTime
      38. CreateODBCTime
      39. CreateSignedJWT
      40. CreateEncryptedJWT
      41. CreateTime
      42. CreateTimeSpan
      43. CreateUUID
      44. CSRFGenerateToken
      45. CSRFVerifyToken
      46. DateAdd
      47. DateCompare
      48. DateConvert
      49. DateDiff
      50. DateFormat
      51. DatePart
      52. DateTimeFormat
      53. Day
      54. DayOfWeek
      55. DayOfWeekAsString
      56. DayOfYear
      57. DaysInMonth
      58. DaysInYear
      59. DE
      60. DecimalFormat
      61. DecodeForHTML
      62. DecodeFromURL
      63. DecrementValue
      64. Decrypt
      65. DecryptBinary
      66. DeleteClientVariable
      67. Deserialize
      68. DeserializeJSON
      69. DeserializeXML
      70. DirectoryCopy
      71. DirectoryCreate
      72. DirectoryDelete
      73. DirectoryExists
      74. DirectoryList
      75. DirectoryRename
      76. DollarFormat
      77. DotNetToCFType
      78. Duplicate
    4. Functions-e-g
      1. EncodeForCSS
      2. EncodeForDN
      3. EncodeForHTML
      4. EncodeForHTMLAttribute
      5. EncodeForJavaScript
      6. EncodeForLDAP
      7. EncodeForURL
      8. EncodeForXML
      9. EncodeForXMLAttribute
      10. EncodeForXpath
      11. Encrypt
      12. EncryptBinary
      13. EntityDelete
      14. EntityLoad
      15. EntityLoadByExample
      16. EntityLoadByPK
      17. EntityMerge
      18. EntityNew
      19. EntityReload
      20. EntitySave
      21. EntityToQuery
      22. Evaluate
      23. Exp
      24. ExpandPath
      25. FileClose
      26. FileCopy
      27. FileDelete
      28. FileExists
      29. FileGetMimeType
      30. FileIsEOF
      31. FileMove
      32. FileOpen
      33. FileRead
      34. FileReadBinary
      35. FileReadLine
      36. FileSeek
      37. FileSetAccessMode
      38. FileSetAttribute
      39. FileSetLastModified
      40. FileSkipBytes
      41. FileUpload
      42. FileUploadAll
      43. FileWrite
      44. FileWriteLine
      45. Find
      46. FindNoCase
      47. FindOneOf
      48. FirstDayOfMonth
      49. Fix
      50. Floor
      51. FormatBaseN
      52. GeneratePBKDFKey
      53. GenerateSecretKey
      54.  GetApplicationMetadata
      55. GetAuthUser
      56. GetBaseTagData
      57. GetBaseTagList
      58. GetBaseTemplatePath
      59. GetClientVariablesList
      60. GetComponentMetaData
      61. GetContextRoot
      62. GetCPUUsage
      63. GetCurrentTemplatePath
      64. GetDirectoryFromPath
      65. GetEncoding
      66. GetException
      67. GetFileFromPath
      68. GetFileInfo
      69. GetFreeSpace
      70. GetFunctionCalledName
      71. GetFunctionList
      72. GetGatewayHelper
      73. GetHttpRequestData
      74. GetHttpTimeString
      75. GetK2ServerDocCount
      76. GetK2ServerDocCountLimit
      77. GetLocale
      78. GetLocaleDisplayName
      79. GetLocalHostIP
      80. GetMetaData
      81. GetMetricData
      82. GetPageContext
      83. GetPrinterInfo
      84. GetPrinterList
      85. GetProfileSections
      86. GetProfileString
      87. GetReadableImageFormats
      88. GetSafeHTML
      89. GetSAMLAuthRequest
      90. GetSAMLLogoutRequest
      91. GenerateSAMLSPMetadata
      92. GetSOAPRequest
      93. GetSOAPRequestHeader
      94. GetSOAPResponse
      95. GetSOAPResponseHeader
      96. GetSystemFreeMemory
      97. GetSystemTotalMemory
      98. GetTempDirectory
      99. GetTempFile
      100. GetTemplatePath
      101. GetTickCount
      102. GetTimeZoneInfo
      103. GetToken
      104. GetTotalSpace
      105. GetUserRoles
      106. GetVFSMetaData
      107. GetWriteableImageFormats
    5. Functions-h-im
      1. Hash
      2. HMac
      3. Hour
      4. HQLMethods
      5. HTMLCodeFormat
      6. HTMLEditFormat
      7. IIf
      8. ImageAddBorder
      9. ImageBlur
      10. ImageClearRect
      11. ImageCopy
      12. ImageCreateCaptcha
      13. ImageCrop
      14. ImageDrawArc
      15. ImageDrawBeveledRect
      16. ImageDrawCubicCurve
      17. ImageDrawLine
      18. ImageDrawLines
      19. ImageDrawOval
      20. ImageDrawPoint
      21. ImageDrawQuadraticCurve
      22. ImageDrawRect
      23. ImageDrawRoundRect
      24. ImageDrawText
      25. ImageFlip
      26. ImageGetBlob
      27. ImageGetBufferedImage
      28. ImageGetEXIFMetadata
      29. ImageGetEXIFTag
      30. ImageGetHeight
      31. ImageGetIPTCMetadata
      32. ImageGetIPTCTag
      33. ImageGetMetadata
      34. ImageGetWidth
      35. ImageGrayscale
      36. ImageInfo
      37. ImageMakeColorTransparent
      38. ImageMakeTranslucent
      39. ImageNegative
      40. ImageNew
      41. ImageOverlay
      42. ImagePaste
      43. ImageRead
      44. ImageReadBase64
      45. ImageResize
      46. ImageRotate
      47. ImageRotateDrawingAxis
      48. ImageScaleToFit
      49. ImageSetAntialiasing
      50. ImageSetBackgroundColor
      51. ImageSetDrawingColor
      52. ImageSetDrawingStroke
      53. ImageSetDrawingTransparency
      54. ImageSharpen
      55. ImageShear
      56. ImageShearDrawingAxis
      57. ImageTranslate
      58. ImageTranslateDrawingAxis
      59. ImageWrite
      60. ImageWriteBase64
      61. ImageXORDrawingMode
    6. Functions-in-k
      1. IncrementValue
      2. InputBaseN
      3. Insert
      4. Int
      5. InvalidateOauthAccesstoken
      6. Invoke
      7. InitSAMLAuthRequest
      8. InitSAMLLogoutRequest
      9. InvokeCFClientFunction
      10. IsArray
      11. IsAuthenticated
      12. IsAuthorized
      13. IsBinary
      14. IsBoolean
      15. IsClosure
      16. IsCustomFunction
      17. IsDate
      18. IsDateObject
      19. IsDDX
      20. IsDebugMode
      21. IsDefined
      22. IsImage
      23. IsImageFile
      24. IsInstanceOf
      25. IsIPv6
      26. IsJSON
      27. IsK2ServerABroker
      28. IsK2ServerDocCountExceeded
      29. IsK2ServerOnline
      30. IsLeapYear
      31. IsLocalHost
      32. IsNull
      33. IsNumeric
      34. IsNumericDate
      35. IsObject
      36. isOnline
      37. IsPDFArchive
      38. IsPDFFile
      39. IsPDFObject
      40. IsProtected
      41. IsQuery
      42. isSamlLogoutResponse
      43. isSafeHTML
      44. IsSimpleValue
      45. IsSOAPRequest
      46. IsSpreadsheetFile
      47. IsSpreadsheetObject
      48. IsStruct
      49. IsUserInAnyRole
      50. IsUserInRole
      51. IsUserLoggedIn
      52. IsValid
      53. IsValidOauthAccesstoken
      54. IsWDDX
      55. IsXML
      56. IsXmlAttribute
      57. IsXmlDoc
      58. IsXmlElem
      59. IsXmlNode
      60. IsXmlRoot
      61. JavaCast
      62. JSStringFormat
    7. Functions-l
      1. LCase
      2. Left
      3. Len
      4. ListAppend
      5. ListChangeDelims
      6. ListContains
      7. ListContainsNoCase
      8. ListDeleteAt
      9. ListEach
      10. ListFilter
      11. ListFind
      12. ListFindNoCase
      13. ListFirst
      14. ListGetAt
      15. ListInsertAt
      16. ListLast
      17. ListLen
      18. ListMap
      19. ListPrepend
      20. ListQualify
      21. ListReduce
      22. ListRemoveDuplicates
      23. ListRest
      24. ListSetAt
      25. ListSort
      26. ListToArray
      27. ListValueCount
      28. ListValueCountNoCase
      29. LJustify
      30. Location
      31. Log
      32. Log10
      33. LSCurrencyFormat
      34. LSDateFormat
      35. LSDateTimeFormat
      36. LSEuroCurrencyFormat
      37. LSIsCurrency
      38. LSIsDate
      39. LSIsNumeric
      40. LSNumberFormat
      41. LSParseCurrency
      42. LSParseDateTime
      43. LSParseEuroCurrency
      44. LSParseNumber
      45. LSTimeFormat
      46. LTrim
    8. Functions-m-r
      1. Max
      2. Mid
      3. Min
      4. Minute
      5. Month
      6. MonthAsString
      7. Now
      8. NumberFormat
      9. ObjectEquals
      10. ObjectLoad
      11. ObjectSave
      12. OnWSAuthenticate
      13. ORMClearSession
      14. ORMCloseAllSessions
      15. ORMCloseSession
      16. ORMEvictCollection
      17. ORMEvictEntity
      18. ORMEvictQueries
      19. ORMExecuteQuery
      20. ORMFlush
      21. ORMFlushall
      22. ORMGetSession
      23. ORMGetSessionFactory
      24. ORMIndex
      25. ORMIndexPurge
      26. ORMReload
      27. ORMSearch
      28. ORMSearchOffline
      29. ParagraphFormat
      30. ParameterExists
      31. ParseDateTime
      32. Pi
      33. PrecisionEvaluate
      34. ProcessSAMLResponse
      35. ProcessSAMLLogoutRequest
      36. Quarter
      37. PreserveSingleQuotes
      38. QueryAddColumn
      39. QueryAddRow
      40. QueryConvertForGrid
      41. QueryExecute
      42. QueryFilter
      43. QueryGetResult
      44. QueryGetRow
      45. QueryKeyExists
      46. QueryMap
      47. QueryNew
      48. QueryReduce
      49. QuerySetCell
      50. QuotedValueList
      51. QueryEach
      52. Rand
      53. Randomize
      54. RandRange
      55. ReEscape
      56. REFind
      57. REFindNoCase
      58. ReleaseComObject
      59. REMatch
      60. REMatchNoCase
      61. RemoveCachedQuery
      62. RemoveChars
      63. RepeatString
      64. Replace
      65. ReplaceList
      66. ReplaceNoCase
      67. REReplace
      68. REReplaceNoCase
      69. RestDeleteApplication
      70. RestSetResponse
      71. RestInitApplication
      72. Reverse
      73. Right
      74. RJustify
      75. Round
      76. RTrim
    9. Functions-s
      1. Second
      2. SendGatewayMessage
      3. SendSAMLLogoutResponse
      4. Serialize
      5. SerializeJSON
      6. SerializeXML
      7. SessionInvalidate
      8. SessionRotate
      9. SessionGetMetaData
      10. SessionInvalidate
      11. SessionRotate
      12. SetDay
      13. SetEncoding
      14. SetHour
      15. SetLocale
      16. SetMonth
      17. SetProfileString
      18. SetVariable
      19. SetYear
      20. Sgn
      21. Sin
      22. Sleep
      23. SpanExcluding
      24. SpanIncluding
      25. SpreadsheetAddAutoFilter
      26. SpreadsheetAddColumn
      27. SpreadsheetAddFreezePane
      28. SpreadsheetAddImage
      29. SpreadsheetAddInfo
      30. SpreadsheetAddPageBreaks
      31. SpreadsheetAddRow
      32. SpreadsheetAddRows
      33. SpreadsheetAddSplitPane
      34. SpreadsheetCreateSheet
      35. SpreadsheetDeleteColumn
      36. SpreadsheetDeleteColumns
      37. SpreadsheetDeleteRow
      38. SpreadsheetDeleteRows
      39. SpreadsheetFormatCell
      40. SpreadsheetFormatColumn
      41. SpreadsheetFormatCellRange
      42. SpreadsheetFormatColumn
      43. SpreadsheetFormatColumns
      44. SpreadsheetFormatRow
      45. SpreadsheetFormatRows
      46. SpreadsheetGetCellComment
      47. SpreadsheetGetCellFormula
      48. SpreadsheetGetCellValue
      49. SpreadsheetGetColumnCount
      50. SpreadsheetInfo
      51. SpreadsheetMergeCells
      52. SpreadsheetNew
      53. SpreadsheetRead
      54. SpreadsheetReadBinary
      55. SpreadsheetRemoveSheet
      56. SpreadsheetSetActiveSheet
      57. SpreadsheetSetActiveSheetNumber
      58. SpreadsheetSetCellComment
      59. SpreadsheetSetCellFormula
      60. SpreadsheetSetCellValue
      61. SpreadsheetSetColumnWidth
      62. SpreadsheetSetFooter
      63. SpreadsheetSetHeader
      64. SpreadsheetSetRowHeight
      65. SpreadsheetShiftColumns
      66. SpreadsheetShiftRows
      67. SpreadsheetWrite
      68. Sqr
      69. StripCR
      70. StructAppend
      71. StructClear
      72. StructCopy
      73. StructCount
      74. StructDelete
      75. StructEach
      76. StructFilter
      77. StructFind
      78. StructFindKey
      79. StructFindValue
      80. StructGet
      81. StructGetMetadata
      82. StructInsert
      83. StructIsEmpty
      84. StructKeyArray
      85. StructKeyExists
      86. StructKeyList
      87. StructMap
      88. StructNew
      89. StructReduce
      90. StructSetMetadata
      91. StructSort
      92. StructToSorted
      93. StructUpdate
      94. StoreSetMetadata
      95. StoreGetACL
      96. StoreGetMetadata
      97. StoreAddACL
      98. StoreSetACL
    10. Functions-t-z
      1. Tan
      2. ThreadJoin
      3. ThreadTerminate
      4. Throw
      5. TimeFormat
      6. ToBase64
      7. ToBinary
      8. ToScript
      9. ToString
      10. Trace
      11. Transactionandconcurrency
      12. TransactionCommit
      13. TransactionRollback
      14. TransactionSetSavePoint
      15. Trim
      16. UCase
      17. URLDecode
      18. URLEncodedFormat
      19. URLSessionFormat
      20. Val
      21. ValueList
      22. VerifyClient
      23. Week
      24. Wrap
      25. WriteDump
      26. WriteLog
      27. WriteOutput
      28. WSGetAllChannels
      29. WSGetSubscribers
      30. WSPublish
      31. WSSendMessage
      32. XmlChildPos
      33. XmlElemNew
      34. XmlFormat
      35. XmlGetNodeType
      36. XmlNew
      37. XmlParse
      38. XmlSearch
      39. XmlTransform
      40. XmlValidate
      41. Year
      42. YesNoFormat
  3. 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
        1. cfexchangecalendar
        2. cfexchangeconnection
        3. cfexchangecontact
        4. cfexchangefilter
        5. cfexchangemail
        6. cfexchangetask
        7. cffeed
        8. cfmail
        9. cfmailparam
        10. cfmailpart
        11. cfpopcfimap
      3. Database manipulation tags
        1. cfdbinfo
        2. cfinsert
        3. cfobjectcache
        4. cfprocparam
        5. cfprocresult
        6. cfquery
        7. cfqueryparam
        8. cfstoredproc
        9. cftransaction
        10. cfupdate
      4. Data output tags
        1. cfchart
        2. cfchartdata
        3. cfchartseries
        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
        1. cflogin
        2. cfloginuser
        3. cflogout
        4. cfNTauthenticate
      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
      1. cfabort
      2. cfajaximport
      3. cfajaxproxy
      4. cfapplet
      5. cfapplication
      6. cfargument
      7. cfassociate
      8. cfauthenticate
      9. cfbreak
    4. Tags c
      1. cfcache
      2. cfcalendar
      3. cfcase
      4. cfcatch
      5. cfchart
      6. cfchartdata
      7. cfchartseries
      8. cfclient
      9. cfclientsettings
      10. cfcol
      11. cfcollection
      12. cfcomponent
      13. cfcontent
      14. cfcontinue
      15. cfcookie
      16. Tags d-e
    5. Tags f
      1. cffeed
      2. cffile
      3. cffile action = "append"
      4. cffile action = "copy"
      5. cffile action = "delete"
      6. cffile action = "move"
      7. cffile action = "read"
      8. cffile action = "readBinary"
      9. cffile action = "rename"
      10. cffile action = "upload"
      11. cffile action = "uploadAll"
      12. cffile action = "write"
      13. cffileupload
      14. cffinally
      15. cfflush
      16. cfform
      17. cfformgroup
      18. cfformitem
      19. cfftp
      20. cfftp: Connection: file and directory operations
      21. cfftp: Opening and closing FTP server connections
      22. cfftp : Opening and closing secure FTP server connections
      23. cfftp action = "listDir"
      24. cffunction
    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
      1. cfjava
      2. cflayout
      3. cflayoutarea
      4. cfldap
      5. cflocation
      6. cflock
      7. cflog
      8. cflogin
      9. cfloginuser
      10. cflogout
      11. cfloop
      12. cfloop : conditional loop
      13. cfloop : index loop
      14. cfloop : looping over a COM collection or structure
      15. cfloop : looping over a date or time range
      16. cfloop : looping over a list, a file, or an array
      17. cfloop : looping over a query
    9. Tags m-o
      1. cfmail
      2. cfmailparam
      3. cfmailpart
      4. cfmap
      5. cfmapitem
      6. cfmediaplayer
      7. cfmenu
      8. cfmenuitem
      9. cfmessagebox
      10. cfmodule
      11. cfNTauthenticate
      12. cfoauth
      13. cfobject
      14. cfobject: .NET object
      15. cfobject: COM object
      16. cfobject: component object
      17. cfobject: CORBA object
      18. cfobject: Java or EJB object
      19. cfobject: web service object
      20. cfobjectcache
      21. cfoutput
    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
  4. CFML Reference
    1. Reserved words and variables
      1. Reserved words and variables
      2. Reserved words
      3. Scope-specific built-in variables
      4. Custom tag variables
      5. ColdFusion tag-specific variables
      6. CGI environment (CGI Scope) variables
    2. Ajax JavaScript functions
      1. Ajax JavaScript functions
      2. Function summary Ajax
      3. ColdFusion.Ajax.submitForm
      4. ColdFusion.Autosuggest.getAutosuggestObject
      5. ColdFusion.Layout.enableSourceBind
      6. ColdFusion.MessageBox.getMessageBoxObject
      7. ColdFusion.ProgressBar.getProgressBarObject
      8. ColdFusion.MessageBox.isMessageBoxDefined
      9. JavaScriptFunctionsinColdFusion9Update1
    3. ColdFusion ActionScript functions
      1. ColdFusion ActionScript functions
      2. CF.http
      3. CF.query
    4. ColdFusion mobile functions
      1. ColdFusion Mobile Functions
      2. Accelerometer Functions
      3. Camera Functions
      4. Connection Functions
      5. Contact Functions
      6. Event Functions
      7. File System Functions
      8. Geolocation Functions
      9. Media and Capture Functions
      10. Notification Functions
      11. Splash Screen Functions
      12. Storage Functions
    5. Application.cfc reference
      1. Application.CFC reference
      2. Application variables
      3. Method summary
      4. onAbort
      5. onApplicationEnd
      6. onApplicationStart
      7. onMissingTemplate
      8. onCFCRequest
      9. onError
      10. onRequestEnd
      11. onRequest
      12. onRequestStart
      13. onServerStart
      14. onSessionEnd
      15. onSessionStart
    6. Script functions implemented as CFCs
      1. Script Functions Implemented as CFCs
      2. Accessing the functions
      3. Function summary
      4. ftp
      5. http
      6. mail
      7. pdf
      8. query
      9. Script functions implemented as CFCs in ColdFusion 9 Update 1
      10. storedproc
    7. ColdFusion Flash Form style reference
      1. Styles valid for all controls
      2. Styles for cfform
      3. Styles for cfformgroup with horizontal or vertical type attributes
      4. Styles for box-style cfformgroup elements
      5. Styles for cfformgroup with accordion type attribute
      6. Styles for cfformgroup with tabnavigator type attribute
      7. Styles for cfformitem with hrule or vrule type attributes
      8. Styles for cfinput with radio, checkbox, button, image, or submit type attributes
      9. Styles for cftextarea tag and cfinput with text, password, or hidden type attributes
      10. Styles for cfselect with size attribute value of 1
      11. Styles for cfselect with size attribute value greater than 1
      12. Styles for cfcalendar tag and cfinput with dateField type attribute
      13. Styles for the cfgrid tag
      14. Styles for the cftree tag
      15. ColdFusion Flash Form Style Reference
    8. ColdFusion event gateway reference
      1. ColdFusion Event Gateway reference
      2. addEvent
      3. CFEvent
      4. CFEventclass
      5. Constructor
      6. Gateway development interfaces and classes
      7. getStatus
      8. setCFCPath
      9. setCFCMethod
      10. getOriginatorID
      11. getLogger
      12. getBuddyList
      13. getBuddyInfo
      14. IM gateway message sending commands
      15. IM Gateway GatewayHelper class methods
      16. onIncomingMessage
      17. onIMServerMessage
      18. onBuddyStatus
      19. onAddBuddyResponse
      20. onAddBuddyRequest
      21. IM Gateway CFC incoming message methods
      22. IM gateway methods and commands
      23. CFML CFEvent structure
      24. warn
      25. info
      26. setOriginatorID
      27. data command
      28. submit Multi command
      29. submit command
      30. setGatewayType
      31. setGatewayID
      32. setData
      33. setCFCListeners
      34. outgoingMessage
      35. getStatusTimeStamp
      36. numberOfMessagesReceived
      37. numberOfMessagesSent
      38. removeBuddy
      39. removeDeny
      40. removePermit
      41. setNickName
      42. setPermitMode
      43. setStatus
      44. SMS Gateway CFEvent structure and commands
      45. SMS Gateway incoming message CFEvent structure
      46. getStatusAsString
      47. getProtocolName
      48. getPermitMode
      49. getPermitList
      50. getNickName
      51. getName
      52. getDenyList
      53. getCustomAwayMessage
      54. getQueueSize
      55. getMaxQueueSize
      56. getHelper
      57. getGatewayType
      58. getGatewayServices
      59. getGatewayID_1
      60. getGatewayID
      61. getData
      62. getCFCTimeout
      63. setCFCTimeout
      64. getCFCPath
      65. getCFCMethod
      66. GatewayServices class
      67. Gateway interface
      68. GatewayHelper interface
      69. addPermit
      70. addDeny
      71. addBuddy
      72. error
      73. debug
      74. Logger class
      75. stop
      76. start
      77. CFML event gateway SendGatewayMessage data parameter
      78. restart
      79. fatal
      80. SMS gateway message sending commands
    9. ColdFusion C++ CFX Reference
      1. C++ class overview
      2. Deprecated class methods
      3. CCFXException class
      4. CCFXQuery class
      5. CCFXRequest class
      6. CCFXStringSet class
      7. ColdFusion C++ CFX Reference
    10. ColdFusion Java CFX reference
      1. ColdFusion Java CFX reference
      2. Class libraries overview
      3. Custom tag interface
      4. Query interface
      5. Request interface
      6. Response interface
      7. Debugging classes reference
    11. WDDX JavaScript Objects
      1. WDDX JavaScript objects
      2. JavaScript object overview
      3. WddxRecordset object
      4. WddxSerializer object
  5. Cloud services
    1. ColdFusion and GCP Storage
    2. ColdFusion and GCP Firestore
    3. ColdFusion and GCP PubSub
    4. ColdFusion and Amazon S3
    5. ColdFusion and DynamoDB
    6. ColdFusion and Amazon SQS
    7. ColdFusion and Amazon SNS
    8. ColdFusion and MongoDB
    9. ColdFusion and Azure Blob
    10. ColdFusion and Azure Service Bus
    11. Multi-cloud storage services
    12. Multi-cloud RDS databases
    13. ColdFusion and Azure Cosmos DB

 

Description

Creates, deletes, modifies, gets, and responds to Microsoft Exchange calendar events, and gets calendar event attachments.

History

  • ColdFusion (2023 release) Update 5: Added the attributes usernamepassword, and server.
  • ColdFusion (2018 release): Added the optional attribute timeZone for action="create".
  • ColdFusion 11: Added three new optional attributes to the cfexchangecalendar tag for managing secondary calendars. These attributes are applicable for get and create actions only and valid for exchange server version starting from 2010. Secondary calendars can be specified in the exchangecalendar tag either using secondary calendar folder ID or using the calendar folder path 
  • ColdFusion 10: getUserAvailability, getRooms, getRoomsList
    • Added the attribute serverVersion.
  • ColdFusion 8: Added this tag.

Category

Communications tags

Syntax

<cfexchangecalendar
required
action = "create"
event = "#event information structure#"
optional
connection = "connection ID"
result = "variable for event UID"

timeZone="Time Zone for the event">


delete
<cfexchangecalendar
required
action = "delete"
uid = "event UID,event UID, ..."
optional
connection = "connection ID"
message = "string"
notify = "yes|no">

deleteAttachments
<cfexchangecalendar
required
action = "deleteAttachments"
uid = "event UID"
optional
connection = "connection ID">

get
<cfexchangecalendar
required
action = "get"
name = "query identifier"
optional
connection = "connection ID">

getAttachments
<cfexchangecalendar
required
action = "getAttachments"
name = "query identifier"
uid = "event UID"
optional
attachmentPath = "directory path"
connection = "connection ID">
generateUniqueFilenames = "no|yes"
getRooms
<cfexchangecalendar
action = "getRooms"
emailAddress = "e-mail_ address"
name = "name"
connection = "connection_ID"/>
getRoomsList
<cfexchangecalendar
action = "getRoomList"
name = "name"
connection = "connection_ID"/>
getUserAvailability
<cfexchangecalendar
action = "getUserAvailability"
attendees = "attendee_list"
connection = "connection_ID"
startDate = "date"
endDate = "date"
dataRequestType = "freeBusy|suggestions|freeBusyandSuggestions"
name = "name" />
modify
<cfexchangecalendar
required
action = "modify"
event = "#event information structure#"
uid = "event UID"
optional
connection = "connection ID">

respond
<cfexchangecalendar
required
action = "respond"
responseType = "accept|decline|tentative"
uid = "event UID"
optional
connection = "connection ID"
message = "string">
notify = "yes|no">

Note: For all actions, see cfexchangeconnection for additional attributes that you use if you do not specify the connection attribute. If you omit the connection attribute, create a temporary connection by specifying cfexchangeconnection tag attributes in the cfexchangecalendar tag. In this case, ColdFusion closes the connection when the tag completes. For details, see the cfexchangeconnection tag open action.

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.

See also

cfexchangeconnectioncfexchangecontactcfexchangefiltercfexchangemailcfexchangetaskWorking with meetings and appointments in the Developing ColdFusion Applications

Attributes

Attribute

Action

Req/Opt

Default

Description

action

N/A

Required

 

The action to take. Must be one of the following values:

  • create
  • delete
  • deleteAttachments
  • get
  • getAttachments
  • getRooms
  • getRoomsList
  • getUserAvailability
  • modify
  • respond
username all Optional   The Exchange user ID.
password all Optional   The password for accessing the Exchange server.
server all Optional   The IP address or URL of the server that is providing access to Exchange.

attachmentPath

getAttachments

Optional

 

The filepath of the on-disk or in-memory directory in which to put the attachments. If an on-disk directory does not exist, ColdFusion creates it.
Note: If you omit this attribute, ColdFusion does not save any attachments. If you specify a relative path, the path root is the ColdFusion temporary directory, which is returned by the GetTempDirectory function.

attendees

getUserAvailability

Required

 

Comma-separated list of all attendees.

connection

all

Optional

 

The name of the connection to the Exchange server, as specified in the cfexchangeconnection tag. If you omit this attribute, you must create a temporary connection by specifying cfexchangeconnection tag connection attributes in the cfexchangecalendar tag.

dataRequestType

getUserAvailability

Required

 

  • freeBusy: Returns an array of availability details.
  • Suggestions: Returns an array of struct that contains suggestion details.
  • freeBusyandSuggestions: Returns both the array of suggestions and an array of attendeeavailability.
    See the sections on suggestion struct and attendeeavailability struct for details.

emailAddress

getRooms

Optional

 

Defines the Simple Mail Transfer Protocol (SMTP) address of a mailbox user.

endDate

getUserAvailability

Required

 

A string that ColdFusion can interpret as a date-time value.

event

createmodify

Required

 

A reference to the structure that contains the event properties to be set or changed, and their values. Specify this attribute in number signs (#). The event attribute also supports the categories key.
For more information on the event structure, see Usage.

getOccurrence

TrueFalse

Optional

 

If True, retrieves all occurrences of a recurring event between specified startDate and EndDate values and also, any single events. You can not use cfExchangeFilter tag if you specify getOccurrence as True.

generateUnique Filenames

getAttachments

Optional

no

A Boolean value that specifies whether to generate unique filenames if multiple attachments have the same filenames. If two or more attachments have the same filename and this option is yes, ColdFusion appends a number to the filename body (before the extension) of any conflicting filenames. Thus, if three attachments have the name myfile.txt, ColdFusion saves the attachments as myfile.txt, myfile1.txt, and myfile2.txt.

message

deleterespond

Optional

 

The text of an optional message to send in the response or deletion notification.

name

getAttachments

getUserAvailability

getRoomsListgetRooms

Required

 

The name of the ColdFusion query variable that contains the retrieved events or information about the attachments that were retrieved. For more information on the returned data, see Usage.

notify

deleterespond

Optional

true

Boolean value that specifies whether to notify others of the changes made to the event.

responseType

respond

Required

 

Must be one of the following values:

  • accept
  • decline
  • tentative

result

create

Optional

 

The name of a variable that contains the UID of the event that is created. You use the UID value in the uid attribute of actions other than create to identify the event to be acted on.

serverVersion

 

Optional

2007

Specifies the Microsoft Exchange Server version. The values are:

  • 2003
  • 2007
  • 2010
    If you do not specify the details, 2007 is taken by default.
    The value you specify overrides the value that you specify at the application level.

startDate

getUserAvailability

Required

 

A string that ColdFusion can interpret as a date-time value.

timeZone   Optional  

Specify the time zone for the event as a struct in the format- key.timeZone="UTC+05:30".

For example,  UTC+02:30, UTC-05:00 , or UTC+00:00.

uid

delete

getAttachments

modify

respond

Required

 

Case-sensitive Exchange UID value or values that uniquely identify the event or events on which to perform the action. For the delete action, this attribute can be a comma-delimited list of UID values. The deleteAttachments, getAttachments, modify, and respond actions allow only a single UID value.

folderid   Optional   Specify the calendar folder ID from which the calendar items need to be managed. If the  folder ID is not a valid calendar, an error will be reported.
folderpath   Optional  

Full path to the calendar folder in the mailbox store. Path delimiter also can be specified in the tag by using the pathdelimiter attribute.

If both folderid and folderpath are not specified, cfexchangecalendar tag manages the default user calendar. If both folderid and folderpath are specfied, folderid will be considered.

pathdelimiter   Optional /

Lets you specify the delimiter that is used to separate the folders in the folderpath attribute.

Usage

The cfexchangecalendar tag manages calendar events on the Exchange server. Use the cfexchangecalendar to do the following actions:

  • Create an appointment or meeting event. You can create all-day events.
  • Delete one or more events.
  • Get one or more events that conform to an optional set of filter specifications, such as the subject, sender or recipient ID, time received, and so on.
  • Get the attachments for a specific event.
  • Modify an existing event.
  • Respond to an event.
    To use this tag, you must have a connection to an Exchange server. If you are using multiple tags that interact with the Exchange server, such as if you are creating several contact records, use the cfexchangeconnection tag to create a persistent connection. Then specify the connection identifier in each cfexchangecalendar tag, or in any other ColdFusion Exchange tag, if you are also accessing tasks, contacts, or mail. Doing this eliminates the overhead of creating and closing the connection for each tag. Alternatively, you can create a temporary connection that lasts only for the time that ColdFusion processes the single cfexchangecalendar tag. To do this, specify the connection attributes directly in the cfexchangecontact tag. For details on the connection attributes, see the cfexchangeconnection tag.

    Note: To create an Exchange calendar appointment, create a calendar event and do not specify any required or optional attendees.

The create action

When you specify the create action, the event attribute must specify a structure that contains the information that defines the events. The structure can have the following entries:

Element

Default

Description

AllDayEvent

no

A Boolean value that indicates whether this is an all-day event.

Attachments

 

One or more paths to the files to send as attachments. Separate filepaths with semicolons (;) for Windows, and colons (:) for UNIX and Linux. Paths to the attachments must be absolute.
If you specify one or more attachments for a modify action, the specified attachments are added to any existing attachments; the pre-existing attachments are not deleted.

Categories

 

A comma-delimited list of categories. The filter searches for events that match all the categories in the list.

Duration

 

The duration of the event in minutes.

EndTime

 

The end time of the event, in any valid ColdFusion date-time format.

Importance

normal

One of the following values:

  • high
  • normal
  • low.

IsRecurring

A Boolean value that indicates whether this event repeats. If yes, specify a RecurrenceType element and elements to specify the recurrence details. For information on the recurrence fields, see the next table.

Location

 

A string that specifies the location of the event.

Message

 

A string that contains a message about the event. The string can include HTML formatting.

OptionalAttendees

 

A comma-delimited list of mail IDs.

Organizer

 

A string that specifies the name of the meeting organizer.

Reminder

 

The time, in minutes before the event, at which to display a reminder message.

RequiredAttendees

 

A comma-delimited list of mail IDs.

Resources

 

A comma-delimited list of mail IDs for Exchange scheduling resources, such as conference rooms and display equipment.

Sensitivity

The valid values are normal, company-confidential, personal, and private.

StartTime

 

The start time of the event, in any valid ColdFusion date-time format.
If you specify a date and time in this attribute and specify a YEARLY RecurrenceType with no other recurrence attributes, the event recurs yearly at the day and time specified in this attribute.

Subject

 

A string that describes the event subject.

The following table lists the elements that you use to specify the event recurrence if you set the IsRecurring field to a yes value. For a detailed description of how to specify event recurrence, see Specifying Calendar recurrence in Working with meetings and appointments in the Developing ColdFusion Applications.

Element

Type

Default

Description

RecurrenceType

all

DAILY

Used only if the structure has a yes IsRecurring element. Must be one of the following values:

  • DAILY
  • WEEKLY
  • MONTHLY
  • YEARLY

RecurrenceNoEndDate

all

yes

Boolean value; if yes, the event recurs until you change or delete the event. Cannot be used with RecurrenceCount or RecurrenceEndDate.

RecurrenceCount

all

 

The number of times the event recurs. Cannot be used with RecurrenceEndDate or RecurrenceNoEndDate.

RecurrenceEndDate

all

 

The date of the last recurrence. Cannot be used with RecurrenceCount or RecurrenceNoEndDate.

RecurrenceFrequency

DAILY, WEEKLY, MONTHLY

1

The frequency of the recurrence in days, weeks, or months, depending on the type. For example, for DAILY recurrence, a RecurrenceFrequency of 3 schedules the event every three days.

RecurEveryWeekDay

DAILY

 

The recurrence of the event on every week day, but not on Saturday or Sunday. Cannot be used with RecurrenceFrequency.

RecurrenceDays

WEEKLY

 

The day or days of the week on which the event occurs. Must be one or more of the following values in a comma-delimited list :MON , TUE, WED, THU, FRI, SAT, {{SUN}}If you omit this field for a weekly recurrence, the event recurs on the day of the week that corresponds to the specified start date.

RecurrenceDay

MONTHLY, YEARLY

 

The day of the week on which the event occurs. Must be one of the following values:

  • MON
  • TUE
  • WED
  • THU
  • FRI
  • SAT
  • SUN

RecurrenceWeek

MONTHLY, YEARLY

 

The week of the month or year on which the event recurs. The valid values are:

  • first
  • second
  • third
  • fourth
  • last

RecurrenceMonth

YEARLY

 

The month of the year on which the event recurs. The valid values are JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, and DEC.

The delete action

When you specify the delete action, specify a uid attribute with a comma-delimited list of one or more Exchange UIDs that identify the events to delete. Use the get action, with an appropriate filter expression, to determine the UID values to specify.
If all UIDs that you specify are invalid, the cfexchangecalendar tag generates an error. If at least one UID is valid, the tag ignores any invalid UIDs and deletes the items specified by the valid UID.

The get action

When you specify the get action, use child cfexchangefilter tags to specify the messages to get. For detailed information on filters, see cfexchangefilter.
When the tag completes processing, the query object specified by the name attribute contains one record for each retrieved message. Each record has the following columns:

AllDayEvent

Duration

EndTime

From

HasAttachment

HtmlMessage

Importance

IsRecurring

Location

Message

OptionalAttendees

Organizer

Reminder

RequiredAttendees

Resources

Sensitivity

StartTime

Subject

UID

Categories

The following table describes the From, HtmlMessage, Message, and UID fields. For detailed information on the other fields, see the table in the create action description.

Column

Description

From

The Exchange ID of the person who created the event.

HtmlMessage

An HTML-formatted version of the message about the event.

Message

A plain-text version of the message about the event.

UID

The Exchange unique identifier for the mail event. Use this value to identify the event in the delete, getAttachments, and modify actions.

The getAttachments action

When you use the getAttachments action, specify a single UID and a name attribute. The cfexchangecalendar tag populates a query object with the specified name. Each record has the following information about an attachment to the event specified by the UID:

Column

Description

attachmentFileName

The filename of the attachment.

attachmentFilePath

The absolute path of the attachment file on the server. If you omit the attachmentPath attribute, this column contains the empty string.

CID

The content-ID of the attachment. Typically used in HTML img tags to embed images in a message.

mimeType

The MIME type of the attachment, such as text/html.

isMessage

A Boolean value that specifies whether the attachment is a message.

size

The attachment size in bytes.

The tag places the attachments in the directory specified by the attachmentPath attribute. If you omit the attachmentPath attribute, ColdFusion does not get any attachments, it gets the information about the attachments. This lets you determine the event's attachments without incurring the overhead of getting the attachment files .Use the following syntax to specify an in-memory attachmentPath directory. In-memory files are not written to disk and speed processing of transient data.

attachmentpath = "ram:///path"

The path can include multiple directories, for example ram:///petStore/orders/messageAttachments. Create all directories in the path before you specify the file. For more information on using in-memory files, see Working with in-memory files in Optimizing ColdFusion applications in the Developing ColdFusion Applications.
The getAttachments action works only if authentication for EWS (Exchange Web Services) is set to basic in the server setup of Exchange. IWA (Integrated Windows Authentication) is not supported.

The modify action

When you specify the modify action, you select the event to modify by specifying a uid attribute with single event UID; multiple UIDs are not allowed. You populate the event structure with only the fields that you are changing. For a detailed description of the fields and their valid values, see the table in the create action.
If an event has attachments and you specify attachments when you modify the event, the new attachments are added to the previous attachments; they do not replace them. Use the deleteAttachments action to remove any attachments.

The respond action

You use the  respond  action to respond to a meeting notification that you received by using the cfexchangemail tag. A meeting does not appear in your calendar, and cannot be accessed by using the cfexchangecalendar  tag, until you respond to the mail message and accept or tentatively accept the request.
When you specify the  respond  action, specify the UID, from the notification mail message, of the event to which you are responding. Also specify the response type; that is, whether you are accepting, rejecting, or tentatively accepting the event. You can optionally specify a message to include in the response and set a flag whether to notify the creator of the event of your response. For detailed information on using the  respond  action, see Working with meetings and appointments in the Developing ColdFusion Applications.

Suggestions struct values

Struct values

Description

date

Suggested day for the meeting.

quality

The quality of the suggested day, if Excellent, Good, Fair or Poor.

TimeSuggestion

An array of struct that contains the following values:

  • MeetingDate: Suggested meeting time.
  • Quality: The quality of the time. It can be Excellent, Good, Fair, or Poor.
  • array of conflicts: The conflicts at the suggested time. This is a struct that contains the following values: ConflictType (the type of conflict, which can be individualAttendeeConflict, which is a conflict with an attendee, GroupConflict which is a conflict with at least one member of a group, GroupTooBigConflict which is a conflict with at least one member of a group, but the group was too big for detailed information to be returned, and UnknownAttendeeConflict which is a conflict with an unresolvable attendee or an attendee that is not a user, group, or contact).
  • FreeBusyStatus: Gets the free/busy status of the conflicting attendee. Only meaningful when ConflictType is equal to IndividualAttendee. The values are Free, Tentative, Busy, OOF (time slot associated with the appointment appears as Out of Office) or NoData (no free/busy status is associated with the appointment).
  • NoOfMembers: Gets the number of users, resources, and rooms in the conflicting group. Only meaningful when ConflictType is equal to ConflictType GroupConflict.
  • NoOfMembersAvailable: Gets the number of available members (whose status is Free) in the conflicting group. Only meaningful when ConflictType is equal to ConflictType GroupConflict.
  • NoOfMembersWithConflict: Gets the number of members who have a conflict (whose status is Busy, OOF, or Tentative) in the conflicting group. Only meaningful when ConflictType is equal to ConflictType GroupConflict.
  • NoOfMembersWithNoData: Gets the number of members who do not have published free/busy data in the conflicting group. Only meaningful when ConflictType is equal to ConflictType GroupConflict.
  • isWorkTime: If the suggested meeting happens in the work hours.

Values of the struct attendeeavailability

Struct values

Description

CalendarEvent

A struct that contains the following values:

  • startTime: The start date and time of the event.
  • endTime: The end date and time of the event.
  • freeBusyStatus: The free/busy status associated with the event. It can have following values: Free, tentative, busy , OOF (Out of Office), or NoData (no free/busy status is associated with the appointment).
  • details: The details of the calendar event; details is null if the user who requests for details does not have the appropriate rights. details is a struct that contains the following values: location (calendar location), eventstoreId (store ID of the calendar event), and Subject (can be isException which is a boolean value that indicates if the calendar event is an exception in a recurring series, isMeeting which is a boolean value that indicates if the calendar event is a meeting, isPrivate which is a boolean value that indicates if the calendar event is private, isRecurring which is a boolean value that indicates if the calendar event is recurring, and isRemainderSet which is a boolean value that indicates if the calendar event has a reminder set).

mergedFreeBusyStatus

An array of struct that contains status. The status can be

  • Free : The time slot associated with the appointment appears as Free.
  • Tentative : The time slot associated with the appointment appears as Tentative.
  • Busy : The time slot associated with the appointment appears as Busy
  • OOF: The time slot associated with the appointment appears as Out of Office.
  • NoData: No free/busy status is associated with the appointment.
  • result: The result associated with the response. This can be success , warning, or error.

viewType

The free/busy view type retrieved for the attendee. It can have the following values:

  • None: No view is returned. This value cannot be specified in a call to GetUserAvailability.
  • MergedOnly: An aggregated free/busy stream. If the target user in one forest does not have an Availability service configured, the Availability service of the requestor retrieves the target user's free/busy information from the free/busy public folder. Because public folders only stores free/busy information in merged form, MergedOnly is the only available information.
  • FreeBusy: The legacy status information (free, busy, tentative, and OOF). This also includes the start/end times of the appointments. This view is comprehensive than the legacy free/busy view because individual meeting start and end times are provided instead of an aggregated free/busy stream.
  • FreeBusyMerged: All the properties in FreeBusy with a stream of merged free/busy availability information.
  • Detailed: The legacy status information (free, busy, tentative, and OOF, the start/end times of the appointments; and various properties of the appointment such as subject, location, and importance). This requested view returns the maximum amount of information for which the requesting user is privileged. If merged free/busy information only is available, as with requesting information for users in a Microsoft Exchange Server 2003 forest, MergedOnly is returned. Otherwise, FreeBusy or Detailed are returned.
  • DetailedMerged: Represents all the properties in Detailed with a stream of merged free/busy availability information. If, only merged free/busy information is available, for example if the mailbox exists on a computer running Exchange 2003, MergedOnly is returned. Otherwise, FreeBusyMerged or DetailedMerged is returned.

workingHours

A struct that contains the following details:

  • startTime: The start date and time of the event.
  • endTime: The end date and time of the event.
  • daysOfTheWeek: An array of struct. The working days of the attendees. It can have the following values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Weekday, and WeekEndDayDay.
  • Timezone: A struct that contains the following fields: id (ID of the time zone definition) and name (name of this time zone definition).

Exchange UID value

For all the cfexchangecalendar actions, the value of the attribute uid is as follows:

  • If exchangeServerVersion is set to 2003 or 2007: The uid indicates the ID of the appointment in the mailbox of the organizer.
  • If exchangeServerVersion is set to 2010: The uid indicates the ID of the received appointment in the mailbox of the attendee.
    In the case of interaction with Microsoft Exchange server 2003 or 2007, whenever an appointment is created, the UID of the organizer can be used by the attendee for any operation such as responding, deleting, or getting attachments. In the case of Microsoft Exchange server 2010, the behavior is different. If attendees have to perform appointment-related actions, they have to first search for the appointment in their mailbox and then use the UID of that appointment.

Example 1

The following example lets you create, and then modify a calendar event. When you first submit the form, ColdFusion creates the calendar event and redisplays the form with the data you entered. Accept the event before you modify the form and resubmit it. When you submit the form a second time, ColdFusion sends the modification information. For more information, see Working with meetings and appointments in the Developing ColdFusion Applications.
This example resends all the event data (to limit the example length), but you could change the example so that it only sends modified data.

<!--- A self-submitting form for the event information --->
<!--- This example omits recurrence to keep the code relatively simple --->
<cfparam name="form.eventID" default="0">

<!--- If the form was submitted, populate the event structure from it. --->
<cfif isDefined("Form.Submit")>
<cfscript>
sEvent.AllDayEvent="no";
sEvent=StructNew();
sEvent.Subject=Form.subject;
if (IsDefined("Form.allDay")) {
sEvent.AllDayEvent="yes";
sEvent.StartTime=createDateTime(Year(Form.date), Month(Form.date),
Day(Form.date), 8, 0, 0);
}
else {
sEvent.StartTime=createDateTime(Year(Form.date), Month(Form.date),
Day(Form.date), Hour(Form.startTime), Minute(Form.startTime), 0);
sEvent.EndTime=createDateTime(Year(Form.date), Month(Form.date),
Day(Form.date), Hour(Form.endTime), Minute(Form.endTime), 0);
}
sEvent.Location=Form.location;
sEvent.RequiredAttendees=Form.requiredAttendees;
sEvent.OptionalAttendees=Form.optionalAttendees;
//sEvent.Resources=Form.resources;
if (Form.reminder NEQ "") {
sEvent.Reminder=Form.reminder;
}
else {
sEvent.Reminder=0;
}
sEvent.Importance=Form.importance;
sEvent.Sensitivity=Form.sensitivity;
sEvent.message=Form.Message;
</cfscript>

<!--- If this is the first time the form is being submitted
Create a new event. --->
<cfif form.eventID EQ 0>
<!--- Create the event in Exchange --->
<cfexchangecalendar action="create"
username ="#user1#"
password="#password1#"
server="#exchangeServerIP#"
event="#sEvent#"
result="theUID">
<!--- Output the UID of the new event. --->
<cfif isDefined("theUID")>
<cfoutput>Event Added. UID is#theUID#</cfoutput>
<cfset Form.eventID = theUID >
</cfif>
<cfelse>
<!--- The form is being resubmitted with new data, so update the event. --->
<cfexchangecalendar action="modify"
username ="#user1#"
password="#password1#"
server="#exchangeServerIP#"
event="#sEvent#"
uid="#Form.eventID#">
<cfoutput>Event ID #Form.eventID# Updated.</cfoutput>

</cfif>
</cfif>

<cfform format="xml" preservedata="yes" style="width:500" height="600">
<cfinput type="text" label="Subject" name="subject" style="width:435"><br />
<cfinput type="checkbox" label="All Day Event" name="allDay">
<cfinput type="datefield" label="Date" name="date" validate="date" style="width:100">
<cfinput type="text" label="Start Time" name="startTime" validate="time"
style="width:100">
<cfinput type="text" label="End Time" name="endTime" validate="time"
style="width:100"><br />
<cfinput type="text" label="Location" name="location" style="width:435"><br />
<cfinput type="text" label="Required Attendees" name="requiredAttendees"
style="width:435"><br />
<cfinput type="text" label="Optional Attendees" name="optionalAttendees"
style="width:435"><br />
<cfinput type="text" label="Resources" name="resources" style="width:435"><br />
<cfinput type="text" label="Reminder (minutes)" validate="integer" name="reminder"
style="width:200">
<cfselect name="importance" label="Importance" style="width:100">
<option value="normal">Normal</option>
<option value="high">High</option>
<option value="low">Low</option>
</cfselect>
<cfselect name="sensitivity" label="Sensitivity" style="width:100">
<option value="normal">Normal</option>
<option value="company-confidential">Confidential</option>
<option value="personal">Personal</option>
<option value="private">Private</option>
</cfselect>
<cfinput type="textarea" label="Message" name="message" style="width:435;
height:100">
<cfinput type="hidden" name="eventID" value="#Form.EventID#">
<cfinput type="Submit" name="submit" value="Submit">
</cfform>

Example 2

The following example shows how you can get UserAvailability action:Application.cfm

<cfset todayDate = #Now()#>
<cfset fromDate = #DateFormat(todayDate, "mm/dd/yyyy")# & ' ' & #TimeFormat(todayDate, "HH:MM:SS")#>
<!--- Adding one day to present date--->
<cfset toDate1 = DateAdd("d", "1", "#fromDate#")>
<!--- <cfset toDate = #DateFormat(toDate, "mm/dd/yyyy")#&' '&#TimeFormat(toDate,
"HH:MM:SS")#>--->
<cfset toDate1 = #DateFormat(toDate1, "mm/dd/yyyy")# & ' ' & #TimeFormat(toDate1, "HH:MM:SS")#>
<!---Creating a calendar event --->
<cffunction name="constructCalendarStruct" returntype="struct">
<cfargument name="AllDayEvent" type="string"/>
<cfargument name="Duartion" type="string"/>
<cfargument name="EndTime" type="string"/>
<cfargument name="From" type="string"/>
<cfargument name="HasAttachment" type="string"/>
<cfargument name="HtmlMessage" type="string"/>
<cfargument name="Importance" type="string"/>
<cfargument name="IsRecurring" type="string"/>
<cfargument name="Location" type="string"/>
<cfargument name="Message" type="string"/>
<cfargument name="OptionalAttendees" type="string"/>
<cfargument name="Organizer" type="string"/>
<cfargument name="Reminder" type="string"/>
<cfargument name="RequiredAttendees" type="string"/>
<cfargument name="Resources" type="string"/>
<cfargument name="Sensitivity" type="string"/>
<cfargument name="StartTime" type="string"/>
<cfargument name="Subject" type="string"/>
<cfargument name="UID" type="string"/>
<cfscript>
var eventInfo = structNew();
if(isdefined("AllDayEvent") EQ 1)
eventInfo.AllDayEvent = AllDayEvent;
if(isdefined("Duration") EQ 1)
eventInfo.Duration = Duration;
if(isdefined("EndTime") EQ 1)
eventInfo.EndTime = EndTime;
if(isdefined("From") EQ 1)
eventInfo.From = From;
if(isdefined("HasAttachment") EQ 1)
eventInfo.HasAttachment = HasAttachment;
if(isdefined("HtmlMessage") EQ 1)
eventInfo.HtmlMessage = HtmlMessage;
if(isdefined("Importance") EQ 1)
eventInfo.Importance = Importance;
if(isdefined("IsRecurring") EQ 1)
eventInfo.IsRecurring = IsRecurring;
if(isdefined("Message") EQ 1)
eventInfo.Message = Message;
if(isdefined("OptionalAttendees") EQ 1)
eventInfo.OptionalAttendees = OptionalAttendees;
if(isdefined("Organizer") EQ 1)
eventInfo.Organizer = Organizer;
if(isdefined("Reminder") EQ 1)
eventInfo.Reminder = Reminder;
if(isdefined("RequiredAttendees") EQ 1)
eventInfo.RequiredAttendees = RequiredAttendees;
if(isdefined("Resources") EQ 1)
eventInfo.Resources = Resources;
if(isdefined("Sensitivity") EQ 1)
eventInfo.Sensitivity = Sensitivity;
if(isdefined("StartTime") EQ 1)
eventInfo.StartTime = StartTime;
if(isdefined("Subject") EQ 1)
eventInfo.Subject = Subject;
if(isdefined("UID") EQ 1)
eventInfo.UID = UID;
if(isdefined("Location") EQ 1)
eventInfo.Location = Location;
</cfscript>
<cfreturn eventInfo>
</cffunction>
<!--- Function to delete calendar events --->
<cffunction name="deleteAllEvents">
<cfargument name="convariable" type="any"/>
<cfexchangecalendar action="get" name="deleteQuery" connection="convariable">
</cfexchangecalendar>
<cfloop query="deleteQuery">
<cfexchangecalendar action="delete" connection=convariable uid=#deleteQuery.uid#>
</cfloop>
</cffunction>

Availability.cfm

action="open"
username = "user1"
password="Password"
server="IP_Address"
serverversion="2010"
connection="conn1">
<cfexchangeConnection
action="open"
username = "user2"
password="Password"
server="IP_Address"
serverversion="2010"
connection="conn2">
<cfset deleteAllEvents(conn1)>
<cfset deleteAllEvents(conn2)>
<!--- Creating All day event for user1 --->
<cfset eventInfo = constructCalendarStruct
(AllDayEvent="yes",Importance="High",
Subject="Testplan1",StartTime="#fromDate#")>
<cfset eventInfo1 = constructCalendarStruct
(AllDayEvent="yes",Importance="High",
Subject="Testplan",StartTime="#fromDate#")>
<cfexchangeCalendar
action="create"
connection="conn1"
event="#eventInfo#"
result="UID">
<cfscript>sleep(15000);</cfscript>
<cfexchangeCalendar
action="create"
connection="conn2"
event="#eventInfo1#"
result="UID1">
<cfscript>sleep(15000);</cfscript>
<cfexchangeCalendar
attendees="a@cfadobe.com"
action="getuseravailability"
connection="conn1"
datarequesttype="freebusyandsuggestions"
startDate="#fromDate#"
endDate="#toDate1#"
name="result">
<cfdump var="#result#">
<cfset deleteAllEvents(conn1)>
<cfset deleteAllEvents(conn2)>

The following example shows how you can use the actions getRooms and getRoomList.

action="open"
username = "sample"
password="Password"
server="IP_Address"
serverversion="2010"
connection="conn1">
<cfexchangecalendar action="getroomlist" name="roomList" connection="conn1">
<cfdump var="#roomList#">
<cfexchangecalendar action="getrooms"
emailaddress="groundfloor1@cfadobe.com" name="rooms" connection="conn1">
<cfdump var="#rooms#">

Example 3

Creating and getting an appointment in a secondary calendar using the folderId attribute:


<cfexchangeconnection action="open" connection="conn1" server="<server hostname/IP>" username="<username>" password="<password>" serverversion="2010" protocol="<protocol>" >

<cfscript>
eventStruct = structnew();
eventStruct.AllDayEvent = "yes";
eventStruct.Importance = "low";
eventstruct.RequiredAttendees = "testing@abc.com";
eventstruct.Subject = "Test Message";
eventStruct.StartTime = now();
</cfscript>
<!-- -Get Calendar Folder Id using exchangefolder tag -->
<cfexchangefolder action="GETEXTENDEDINFO" name="familyCalendar" connection="conn1" folderpath="Calendar/family" >
<!--- Must be a calendar folder--->
<cfexchangecalendar action="create" event="#eventStruct#" connection="conn1" result="createdId" folderid="#familyCalendar.uid#">
<cfoutput >
Created Appointment Successfully in the given calendar
</cfoutput>
<!--- getting appointments from the specified calendar using folderId
<cfexchangecalendar action="get" name="familyItems" connection="conn1" folderid="#familyCalendar.uid#">
<cfexchangefilter name="subject" value="Test Message" >
</cfexchangecalendar>
<cfdump var="#familyItems#" >

Creating and getting an appointment in a secondary calendar using the folderpath attribute:

<cfexchangeconnection action="open" connection="conn1" server="<server hostname/IP>" username="<username>" password="<password>" serverversion="2010" protocol="<protocol>" >

<cfscript>
eventStruct = structnew();
eventStruct.AllDayEvent = "yes";
eventStruct.Importance = "low";
eventstruct.RequiredAttendees = "testing@cfadobe.com";
eventstruct.Subject = "This is from coldfusion just testing after the test " & rand("CFMX_COMPAT" );
eventStruct.StartTime = now();
</cfscript>
<!--- Default path delimiter is / no need to specify-->
<cfexchangecalendar action="create" event="#eventStruct#" connection="conn1" result="createdId" folderpath="Calendar/family">

<cfoutput >
Created Appointment Successfully in the given calendar
</cfoutput>

<cfexchangecalendar action="get" name="familyItems" connection="conn1" folderpath="Calendar/family" pathDelimiter="/">
<cfexchangefilter name="subject" value="This is from coldfusion just testing after the test" >
</cfexchangecalendar>

<cfdump var="#familyItems#" >

Example with username and password

<cfscript>
    eventStruct = structnew();
    eventStruct.AllDayEvent = "yes";
    eventStruct.Importance = "low";
    eventstruct.RequiredAttendees = "user@example.com";
    eventstruct.Subject = "This is any subject " & rand("CFMX_COMPAT" );
    eventStruct.StartTime = now();
</cfscript>

<cfexchangecalendar 
	action="create"
	username ="user1"
    password="password"
    server="exchangeServerIP"
    serverversion="version"
    protocol="protocol" 
	event="eventStruct"
	result="theUID" />

<cfscript>sleep(1000);</cfscript> 

<cfexchangeCalendar action="get" username ="user1"
    password="password"
    server="exchangeServerIP"
    serverversion="version"
    protocol="protocol"  name="getEvent">
        <CFExchangeFilter name="subject" value="calendar">
</cfexchangeCalendar>

<cfset myArray = ArrayNew(1)>
<cfloop query="getEvent">
<cfset temp = ArrayAppend(myArray, "UID")>
</cfloop>
<cfset myList = ArrayToList(myArray, ",")>
<cfset myLen = ListLen(myList)>


<cfoutput query="getEvent">
	  <cfif getEvent.subject contains "calendar">
		<cfexchangeCalendar action="delete"
		username ="user1"
    password="password"
    server="exchangeServerIP"
    serverversion="version"
    protocol="protocol" 
		uid="myList">  
	   Successful!<br>
	  </cfif>  
</cfoutput>

 Adobe

Get help faster and easier

New user?

Adobe MAX 2024

Adobe MAX
The Creativity Conference

Oct 14–16 Miami Beach and online

Adobe MAX

The Creativity Conference

Oct 14–16 Miami Beach and online

Adobe MAX 2024

Adobe MAX
The Creativity Conference

Oct 14–16 Miami Beach and online

Adobe MAX

The Creativity Conference

Oct 14–16 Miami Beach and online