users.tpryan.exchange.exchange
Component exchange


Provides functionality for sending appointment HTTP requests via the WebDav protocol


hierarchy: WEB-INF.cftags.component
      [Redacted].exchange
path: [Redacted]Exchange.cfc
properties:
methods: CreateUpdateExchangeAppointment, CreateUpdateExchangeContact, GetExchangeHomeServer, https_socket*, init
* - private method

CreateUpdateExchangeAppointment
public string CreateUpdateExchangeAppointment ( required string exchangeUsername, uuid GUID="[runtime expression]", required string Subject, string Description="", string Location="", required date StartTime, required date EndTime, boolean AllDay="false", string RecurrenceRule="", string ExceptionDates="", boolean Busy="false", boolean ReminderOn="false", numeric ReminderOffset="15", string exchangeHomeServer="", numeric TimeZoneId="49", string TimeZoneOffset="-04:00" )

Output: enabled
Parameters:
   exchangeUsername: string, required, exchangeUsername - Username to export to.
   GUID: uuid, optional, GUID - Unique identifier
   Subject: string, required, Subject - Subject/Title of Appointment
   Description: string, optional, Description - Description/Body of Appointment
   Location: string, optional, Location - Location of Appointment
   StartTime: date, required, StartTime - Start Time of Appointment
   EndTime: date, required, EndTime - End Time of Appointment
   AllDay: boolean, optional, AllDay - Flag for setting appointment to all day event
   RecurrenceRule: string, optional, RecurrenceRule - Recurrence Rule for appointment. MUST be properly formatted. See http://www.faqs.org/rfcs/rfc2445.html for RRULE formatting. For example FREQ=DAILY;UNTIL=20060524T000000Z is daily until May 24th, 2006. FREQ=WEEKLY;UNTIL=20060524T000000Z;WKST=SU;BYDAY=TU,TH is Weekly on Tuesday and Thursday until May 24th,2006.
   ExceptionDates: string, optional, ExceptionDates - Comma delimited list of dates as exceptions to the Recurrence Rule.
   Busy: boolean, optional, Busy - Busy flag of appointment. Defaults to false.
   ReminderOn: boolean, optional, ReminderOn - Flag to set reminder. Defaults to false.
   ReminderOffset: numeric, optional, ReminderOffset - Number of minutes prior to event to activate reminder.
   exchangeHomeServer: string, optional, exchangeHomeServer - The homeserver of the user. If you know this you can speed up execution by passing it in.
   TimeZoneId: numeric, optional, TimeZoneId - The TimeZoneId of the location of the appointment. Defaults to EST New York. See http://e-docs.fatwire.com/spark/6.0/SPARK/TimeZones.html for reference.
   TimeZoneOffset: string, optional, TimeZoneOffset - The Offset from Zulu written as +/-0:00. Again defaults to EST.

CreateUpdateExchangeContact
public string CreateUpdateExchangeContact ( required string exchangeUsername, uuid GUID="[runtime expression]", required string FirstName, string MiddleName="", required string LastName, required string OfficeNumber, string HomeNumber="", string MobileNumber="", string PagerNumber="", required string PrimaryEmail, string SecondaryEmail="", string OfficeAddress="", string categories="", string company="", string notes="", string displayNamePrimaryEmail="[runtime expression]", string displayNameSecondaryEmail="[runtime expression]", string exchangeHomeServer="" )

Creates, or updates a single contact entry in a single users address list. The user's address list is identified by username, the contact entry is identified by GUID.

Output: enabled
Parameters:
   exchangeUsername: string, required, exchangeUsername - Username to export to.
   GUID: uuid, optional, GUID - Unique identifier
   FirstName: string, required, FirstName - First name of the contact.
   MiddleName: string, optional, MiddleName - Middle name of the contact.
   LastName: string, required, LastName - Last name of the contact.
   OfficeNumber: string, required, OfficeNumber - OfficeNumber of the contact.
   HomeNumber: string, optional, HomeNumber - HomeNumber of the contact.
   MobileNumber: string, optional, MobileNumber - MobileNumber of the contact.
   PagerNumber: string, optional, PagerNumber - PagerNumber of the contact.
   PrimaryEmail: string, required, PrimaryEmail - PrimaryEmail of the contact.
   SecondaryEmail: string, optional, SecondaryEmail - SecondaryEmail of the contact.
   OfficeAddress: string, optional, OfficeAddress - OfficeAddress of the contact.
   categories: string, optional, categories - List of categories to assoiciate with contact.
   company: string, optional, company - Company of the contact.
   notes: string, optional, notes - Notes to associate with the contact.
   displayNamePrimaryEmail: string, optional, displayNamePrimaryEmail - displayName for the PrimaryEmail of the contact.
   displayNameSecondaryEmail: string, optional, displayNameSecondaryEmail - displayName for the SecondaryEmail of the contact.
   exchangeHomeServer: string, optional, exchangeHomeServer - The homeserver of the user. If you know this you can speed up execution by passing it in.

GetExchangeHomeServer
public string GetExchangeHomeServer ( required string UserName )

Output: suppressed
Parameters:
   UserName: string, required, UserName - The username for whom we are getting the home server.

https_socket*
private string https_socket ( required string host, required string message, numeric port="443" )

Allows socket communication over https to occur.

Output: enabled
Parameters:
   host: string, required, host - The host to send message to.
   message: string, required, message - The message to send to the host.
   port: numeric, optional, port - The port to connect to.

init
exchange init ( )

Output: suppressed