diff --git a/docs/api/davical/VCard.html b/docs/api/davical/VCard.html new file mode 100644 index 00000000..63a619a7 --- /dev/null +++ b/docs/api/davical/VCard.html @@ -0,0 +1,206 @@ + + + + + + Docs For Class VCard + + + + +
+

Class VCard

+ + +
+
Description
+
+ Description | + Methods (details) + +
+
+ +

+ Located in /inc/vcard.php (line 9) +

+ + + 
vComponent
+   |
+   --VCard
+ +
+
+ + + + + +
+
Method Summary
+
+ Description | + Methods (details) +
+
+
+
+ + void + Write + ( $dav_id, [ $exists = true]) +
+
+ + void + WriteAddresses + ( $dav_id) +
+
+ + void + WriteEmails + ( $dav_id) +
+
+ + void + WritePhones + ( $dav_id) +
+
+
+
+ + + +
+
Methods
+
+ Description | + Methods (details) + +
+
+ + +
+ +
+ + Write (line 26) +
+ + + +
+ void + + Write + + ( $dav_id, [ $exists = true]) +
+ +
    +
  • + + $dav_id
    • +
  • + + $exists
    • +
+ + +
+ +
+ +
+ + WriteAddresses (line 82) +
+ + + +
+ void + + WriteAddresses + + ( $dav_id) +
+ +
    +
  • + + $dav_id
    • +
+ + +
+ +
+ +
+ + WriteEmails (line 149) +
+ + + +
+ void + + WriteEmails + + ( $dav_id) +
+ +
    +
  • + + $dav_id
    • +
+ + +
+ +
+ +
+ + WritePhones (line 120) +
+ + + +
+ void + + WritePhones + + ( $dav_id) +
+ +
    +
  • + + $dav_id
    • +
+ + +
+ +
+
+ + +

+ Documentation generated on Tue, 21 Sep 2010 12:13:35 +1200 by phpDocumentor 1.4.3 +

+
+ \ No newline at end of file diff --git a/docs/api/davical/_htdocs---well-known.php.html b/docs/api/davical/_htdocs---well-known.php.html new file mode 100644 index 00000000..2b32aa16 --- /dev/null +++ b/docs/api/davical/_htdocs---well-known.php.html @@ -0,0 +1,139 @@ + + + + + + Docs for page well-known.php + + + + +
+

File/htdocs/well-known.php

+ + +
+
Description
+
+ Description | + Includes + | Functions +
+
+ + +
+
+ + + +
+
Includes
+
+ Description | + Includes + | Functions +
+
+ +
+ +
+ + + include + (iSchedule.php) + (line 36) + +
+ + + +
+ +
+ +
+ + + require_once + ('./always.php') + (line 3) + +
+ + + +
+ +
+ +
+ + + require_once + (CalDAVRequest.php) + (line 12) + +
+ + + +
+ +
+ +
+ + + require_once + (HTTPAuthSession.php) + (line 7) + +
+ + + +
+
+
+ + + + +
+
Functions
+
+ Description | + Includes + | Functions +
+
+ +
+ +
+ + ischedule_get (line 50) +
+ + +
+ void + + ischedule_get + + () +
+ + + +
+
+
+ +

+ Documentation generated on Tue, 21 Sep 2010 12:13:35 +1200 by phpDocumentor 1.4.3 +

+
+ \ No newline at end of file diff --git a/docs/api/davical/_inc---caldav-REPORT-cardquery.php.html b/docs/api/davical/_inc---caldav-REPORT-cardquery.php.html new file mode 100644 index 00000000..15336983 --- /dev/null +++ b/docs/api/davical/_inc---caldav-REPORT-cardquery.php.html @@ -0,0 +1,134 @@ + + + + + + Docs for page caldav-REPORT-cardquery.php + + + + +
+

File/inc/caldav-REPORT-cardquery.php

+ + +
+
Description
+
+ Description | + Includes + | Functions +
+
+ + +
+
+ + + +
+
Includes
+
+ Description | + Includes + | Functions +
+
+ +
+ +
+ + + require_once + ('vcard.php') + (line 3) + +
+ + + +
+
+
+ + + + +
+
Functions
+
+ Description | + Includes + | Functions +
+
+ +
+ +
+ + get_address_properties (line 6) +
+ + +
+ void + + get_address_properties + + ( $address_data_xml) +
+ +
    +
  • + + $address_data_xml
    • +
+ + +
+ +
+ +
+ + SqlFilterCardDAV (line 83) +
+ + +

Process a filter fragment returning an SQL fragment

+
+ void + + SqlFilterCardDAV + + ( $filter,  $components, [ $property = null], [ $parameter = null]) +
+ +
    +
  • + + $filter
    • +
  • + + $components
    • +
  • + + $property
    • +
  • + + $parameter
    • +
+ + +
+
+
+ +

+ Documentation generated on Tue, 21 Sep 2010 12:13:33 +1200 by phpDocumentor 1.4.3 +

+
+ \ No newline at end of file diff --git a/docs/api/davical/_inc---freebusy-functions.php.html b/docs/api/davical/_inc---freebusy-functions.php.html new file mode 100644 index 00000000..0b497109 --- /dev/null +++ b/docs/api/davical/_inc---freebusy-functions.php.html @@ -0,0 +1,124 @@ + + + + + + Docs for page freebusy-functions.php + + + + +
+

File/inc/freebusy-functions.php

+ + +
+
Description
+
+ Description | + Includes + | Functions +
+
+ + +
+
+ + + +
+
Includes
+
+ Description | + Includes + | Functions +
+
+ +
+ +
+ + + include_once + ('iCalendar.php') + (line 9) + +
+ + +

Function to include which handles building a free/busy response to be used in either the REPORT, response to a POST, or response to a a freebusy GET request.

+ +
+ +
+ +
+ + + include_once + ('RRule-v2.php') + (line 10) + +
+ + + +
+
+
+ + + + +
+
Functions
+
+ Description | + Includes + | Functions +
+
+ +
+ +
+ + get_freebusy (line 13) +
+ + +
+ void + + get_freebusy + + ( $path_match,  $range_start,  $range_end, [ $bin_privs = null]) +
+ +
    +
  • + + $path_match
    • +
  • + + $range_start
    • +
  • + + $range_end
    • +
  • + + $bin_privs
    • +
+ + +
+
+
+ +

+ Documentation generated on Tue, 21 Sep 2010 12:13:35 +1200 by phpDocumentor 1.4.3 +

+
+ \ No newline at end of file diff --git a/docs/api/davical/_inc---vcard.php.html b/docs/api/davical/_inc---vcard.php.html new file mode 100644 index 00000000..eacf9d30 --- /dev/null +++ b/docs/api/davical/_inc---vcard.php.html @@ -0,0 +1,107 @@ + + + + + + Docs for page vcard.php + + + + +
+

File/inc/vcard.php

+ + +
+
Description
+
+ Description | + Classes + | Includes +
+
+ + +
+
+ + +
+
Classes
+
+ Description | + Classes + | Includes +
+
+ + + + + + + + + +
ClassDescription
+ class + VCard + + +
+
+
+ + +
+
Includes
+
+ Description | + Classes + | Includes +
+
+ +
+ +
+ + + require_once + ('AwlQuery.php') + (line 6) + +
+ + +

Extend the vComponent to specifically handle VCARD resources

+ +
+ +
+ +
+ + + require_once + ('vComponent.php') + (line 7) + +
+ + + +
+
+
+ + + + +

+ Documentation generated on Tue, 21 Sep 2010 12:13:35 +1200 by phpDocumentor 1.4.3 +

+
+ \ No newline at end of file diff --git a/docs/api/davical/caldav/_inc---caldav-PUT-vcard.php.html b/docs/api/davical/caldav/_inc---caldav-PUT-vcard.php.html new file mode 100644 index 00000000..cf211ee3 --- /dev/null +++ b/docs/api/davical/caldav/_inc---caldav-PUT-vcard.php.html @@ -0,0 +1,82 @@ + + + + + + Docs for page caldav-PUT-vcard.php + + + + +
+

File/inc/caldav-PUT-vcard.php

+ + +
+
Description
+
+ Description | + Includes +
+
+ +

CalDAV Server - handle PUT method on VCARD content-types

+ + +
+
+ + + +
+
Includes
+
+ Description | + Includes +
+
+ +
+ +
+ + + require_once + ('DAVResource.php') + (line 13) + +
+ + + +
+ +
+ +
+ + + require_once + ('vcard.php') + (line 87) + +
+ + + +
+
+
+ + + + +

+ Documentation generated on Tue, 21 Sep 2010 12:13:33 +1200 by phpDocumentor 1.4.3 +

+
+ \ No newline at end of file diff --git a/docs/api/davical/iSchedule/_inc---iSchedule.php.html b/docs/api/davical/iSchedule/_inc---iSchedule.php.html new file mode 100644 index 00000000..b20f09e5 --- /dev/null +++ b/docs/api/davical/iSchedule/_inc---iSchedule.php.html @@ -0,0 +1,122 @@ + + + + + + Docs for page iSchedule.php + + + + +
+

File/inc/iSchedule.php

+ + +
+
Description
+
+ Description | + Classes + | Includes +
+
+ +

Functions that are needed for iScheduling requests

+

  • verifying Domain Key signatures
  • delivering remote scheduling requests to local users inboxes
  • Utility functions which we can use to decide whether this + is a permitted activity for this user.

+ + +
+
+ + +
+
Classes
+
+ Description | + Classes + | Includes +
+
+ + + + + + + + + +
ClassDescription
+ class + iSchedule + + A class for handling iScheduling requests. +
+
+
+ + +
+
Includes
+
+ Description | + Classes + | Includes +
+
+ +
+ +
+ + + include + ('caldav-POST.php') + (line 343) + +
+ + + +
+ +
+ +
+ + + require_once + ("XMLDocument.php") + (line 17) + +
+ + +

Functions that are needed for iScheduling requests

+

  • verifying Domain Key signatures
  • delivering remote scheduling requests to local users inboxes
  • Utility functions which we can use to decide whether this + is a permitted activity for this user.

+ + +
+
+
+ + + + +

+ Documentation generated on Tue, 21 Sep 2010 12:13:35 +1200 by phpDocumentor 1.4.3 +

+
+ \ No newline at end of file diff --git a/docs/api/davical/iSchedule/iSchedule.html b/docs/api/davical/iSchedule/iSchedule.html new file mode 100644 index 00000000..0cdffcb7 --- /dev/null +++ b/docs/api/davical/iSchedule/iSchedule.html @@ -0,0 +1,517 @@ + + + + + + Docs For Class iSchedule + + + + +
+

Class iSchedule

+ + +
+
Description
+
+ Description | + Vars (details) + | Methods (details) + +
+
+ +

A class for handling iScheduling requests.

+

+ Located in /inc/iSchedule.php (line 25) +

+ + + 

+	
+			

+

+
+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+																																								

+					 
+					mixed
+					$domain
+				

+																

+					 
+					mixed
+					$parsed
+				

+																

+					 
+					mixed
+					$selector
+				

+											

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																																																																																								

+					 
+											iSchedule
+										__construct
+										()
+									

+																

+					 
+											void
+										getCapabilities
+										()
+									

+																

+					 
+											void
+										getServer
+										()
+									

+																

+					 
+											void
+										getTxt
+										()
+									

+																

+					 
+											void
+										parseDKIM
+											(string $sig)
+									

+																

+					 
+											void
+										parseTxt
+										()
+									

+																

+					 
+											void
+										parseURI
+											( $uri)
+									

+																

+					 
+											void
+										signDKIM
+											(string $body, array $headers)
+									

+																

+					 
+											void
+										validateKey
+										()
+									

+																

+					 
+											void
+										validateRequest
+										()
+									

+																

+					 
+											void
+										verifySignature
+										()
+									

+											

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+
+

+
+	

+		
+		
+			mixed
+			$domain
+						(line 29)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			mixed
+			$parsed
+						(line 27)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			mixed
+			$selector
+						(line 28)
+		
+	

+
+	
+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+						
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+															Vars (details)
+														Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor __construct (line 38)
+	
 
+	
+	
+	
+	

+		iSchedule
+		
+			__construct
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getCapabilities (line 158)
+	
 
+	
+	
+
get capabilities from remote server

+	
+	

+		void
+		
+			getCapabilities
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getServer (line 123)
+	
 
+	
+	
+
finds a remote calender server via DNS SRV records

+	
+	

+		void
+		
+			getServer
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		getTxt (line 48)
+	
 
+	
+	
+
gets the domainkey TXT record from DNS

+	
+	

+		void
+		
+			getTxt
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		parseDKIM (line 197)
+	
 
+	
+	
+
parses and validates DK header

+	
+	

+		void
+		
+			parseDKIM
+		
+					(string $sig)
+			

+	
+			
    
+					
  • 
+				string
+				$sig: the value of the DKIM-Signature header			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		parseTxt (line 65)
+	
 
+	
+	
+
parses DNS TXT record from domainkey lookup

+	
+	

+		void
+		
+			parseTxt
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		parseURI (line 268)
+	
 
+	
+	
+
split up a mailto uri into domain and user components

+	
+	

+		void
+		
+			parseURI
+		
+					( $uri)
+			

+	
+			
    
+					
  • 
+				
+				$uri			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		signDKIM (line 176)
+	
 
+	
+	
+
signs a POST body and headers

+	
+	

+		void
+		
+			signDKIM
+		
+					(string $body, array $headers)
+			

+	
+			
    
+					
  • 
+				string
+				$body: the body of the POST			
    • 
+					
  • 
+				array
+				$headers: the headers to sign as passed to header ();			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		validateKey (line 86)
+	
 
+	
+	
+
validates that domainkey is acceptable for the current request

+	
+	

+		void
+		
+			validateKey
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		validateRequest (line 317)
+	
 
+	
+	
+
checks that current request has a valid DKIM signature signed by a currently valid key from DNS

+	
+	

+		void
+		
+			validateRequest
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		verifySignature (line 282)
+	
 
+	
+	
+
verifies parsed DKIM header is valid for current message with a signature from the public key in DNS

+	
+	

+		void
+		
+			verifySignature
+		
+				()
+			

+	
+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Tue, 21 Sep 2010 12:13:35 +1200 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/api/davical/pwauth/_inc---drivers_pwauth_pam.php.html b/docs/api/davical/pwauth/_inc---drivers_pwauth_pam.php.html
new file mode 100644
index 00000000..e016187d
--- /dev/null
+++ b/docs/api/davical/pwauth/_inc---drivers_pwauth_pam.php.html
@@ -0,0 +1,151 @@
+
+
+  
+		
+			
+			Docs for page drivers_pwauth_pam.php
+			
+			
+		
+		
+			
			
+
File/inc/drivers_pwauth_pam.php

+
+
+

+	
Description

+	

+					Description |
+							Classes
+			|							Includes
+			|											Functions
+			

+	
	
+		
+
Manages PAM repository connection with pwauth

+	
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+			|							Includes
+				|																Functions
+					

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						pwauthPamDrivers
+					
+											
+										

+		

+	

+
+		
+	

+		
Includes

+		

+			Description |
+							Classes
+				|						Includes
+			|													Functions
+					

+		
	
+			
+

+	
+	

+		 
+		
+			require_once
+			("auth-functions.php")
+			(line 16)
+		
+	

+
+	
+
Manages PAM repository connection with pwauth

+	
+	
+

+		

+	

+	
+	
+	
+		
+	

+		
Functions

+		

+			Description |
+							Classes
+				|										Includes
+				|												Functions
+		

+		
	
+			
+

+	
+	

+		
+		PWAUTH_PAM_check (line 57)
+	
 
+
+	
+
Check the username / password against the PAM system

+	

+		void
+		
+			PWAUTH_PAM_check
+		
+					( $username,  $password)
+			

+
+			
    
+					
  • 
+				
+				$username			
    • 
+					
  • 
+				
+				$password			
    • 
+				

+		
+	
+

+		

+	

+	
+	

+		Documentation generated on Tue, 21 Sep 2010 12:13:34 +1200 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file
diff --git a/docs/api/davical/pwauth/pwauthPamDrivers.html b/docs/api/davical/pwauth/pwauthPamDrivers.html
new file mode 100644
index 00000000..10447c73
--- /dev/null
+++ b/docs/api/davical/pwauth/pwauthPamDrivers.html
@@ -0,0 +1,139 @@
+
+
+  
+		
+			
+			Docs For Class pwauthPamDrivers
+			
+			
+		
+		
+			
			
+
 Class pwauthPamDrivers

+
+
+

+	
Description

+	

+					Description |
+															Methods (details)
+						
+					

+	

+        		
+		

+			Located in /inc/drivers_pwauth_pam.php (line 18)
+		

+		
+				
+		

+	
+			

+

+
+
+
+
+	
+	

+		
Method Summary

+		

+			Description |
+												Methods (details)
+		

+		
			
+			

+																																

+					 
+											pwauthPamDrivers
+										__construct
+											(string $config)
+									

+																

+					 
+											pwauthPamDrivers
+										pwauthPamDrivers
+											(string $config)
+									

+											

+		

+	
		
+
+	
+	
+	

+		
Methods

+		

+			Description |
+													Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor __construct (line 41)
+	
 
+	
+	
+
The constructor

+	
+	

+		pwauthPamDrivers
+		
+			__construct
+		
+					(string $config)
+			

+	
+			
    
+					
  • 
+				string
+				$config: path where pwauth is			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		Constructor pwauthPamDrivers (line 31)
+	
 
+	
+	
+
Constructor.

+	
+	

+		pwauthPamDrivers
+		
+			pwauthPamDrivers
+		
+					(string $config)
+			

+	
+			
    
+					
  • 
+				string
+				$config: path where pwauth is			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

+		Documentation generated on Tue, 21 Sep 2010 12:13:34 +1200 by phpDocumentor 1.4.3
+	

+	

+
\ No newline at end of file