VCard and ICal support - Revision history

Martin.schneider: Move to https://documentation.open-xchange.com/

2016-06-29T13:46:06Z

Move to https://documentation.open-xchange.com/

← Older revision		Revision as of 13:46, 29 June 2016
Line 40:		Line 40:
	* If no specific type is defined, the "business" fields are preferred against "home" and "other" fields.		* If no specific type is defined, the "business" fields are preferred against "home" and "other" fields.

	This is how we map VCard fields to [[HTTP_API~~#DetailedContactData\|~~OX contact fields]]:		This is how we map VCard fields to [https://documentation.open-xchange.com/ HTTP_API (OX contact fields)]:
	{\|		{\|
	! VCard type		! VCard type

Tobias.friedrich: /* TEL */

2014-04-25T12:04:39Z

TEL

← Older revision		Revision as of 12:04, 25 April 2014
Line 31:		Line 31:

	In practice this is usually not much of a problem, for people do not have that many, but for all who are interested in the details:		In practice this is usually not much of a problem, for people do not have that many, but for all who are interested in the details:
	* The basic idea is that the first candidate for a field is stored there, ~~the second one is~~		* The basic idea is that the first candidate for a field is stored there, and further ones are
	** either moved into the available fallback field		** either moved into the next available fallback field
	** or dropped in case ~~the~~ is no fallback field		** or dropped in case there is no fallback field
	* The marker "pref" in VCards, denoting a preferred number, is ~~ignored~~		* The marker "pref" in VCards, denoting a preferred number, is taken into account during that process
	* If no type is given, the number is stored as 542, ''work1''
	* If type is voice and fax (confusing), we consider it ''voice''		* If type is voice and fax (confusing), we consider it ''voice''
	* OX does not distinguish between ''work'' and ''home'' cellphones, pagers, idsn ~~oder~~ car phones.		* OX does not distinguish between ''work'' and ''home'' cellphones, pagers, idsn, car or text phones.
			* The types ''home'', ''work'' and ''dom'' are used to differentiate between the ''home'', ''business'' and ''other'' fax- and phone numbers
			* If no specific type is defined, the "business" fields are preferred against "home" and "other" fields.

	This is how we map VCard fields to [[HTTP_API#DetailedContactData\|OX contact fields]]:		This is how we map VCard fields to [[HTTP_API#DetailedContactData\|OX contact fields]]:
Line 44:		Line 45:
	! OX column number		! OX column number
	! OX field name		! OX field name
	! Fallback OX ~~field~~		! Fallback OX fields
	! Fallback OX field ~~name~~		! Fallback OX field names
	\|-		\|-
	~~\| work~~
	~~\| 542~~
	~~\| telephone_business1~~
	~~\| 543~~
	~~\| telephone_business2~~
	\|-		\|-
	\| ~~work,fax~~		\| pager
	\| ~~544~~		\| 560
	\| ~~fax_business~~		\| telephone_pager
	\|\|		\| 553
			\| telephone_other
	\|-		\|-
	\| ~~home~~		\| textphone
	\| ~~548~~		\| 564
	\| ~~telephone_home1~~		\| telephone_ttytdd
	~~\| 589~~
	~~\| telephone_home2~~
	\|-
	~~\| home,fax~~
	~~\| 550~~
	~~\| fax_home~~
	\|\|
	\|-
	~~\| dom~~
	\| 553		\| 553
	\| telephone_other		\| telephone_other
	\|\|
	\|-
	~~\| dom,fax~~
	~~\| 554~~
	~~\| fax_other~~
	\|\|
	\|-		\|-
	\| car		\| car
	\| 546		\| 546
	\| telephone_car		\| telephone_car
	\|\|		\| 553
			\| telephone_other
	\|-		\|-
	\| isdn		\| isdn
	\| 559		\| 559
	\| telephone_isdn		\| telephone_isdn
	\|\|		\| 553
	\|-		\| telephone_other
	~~\| pager~~
	~~\| 560~~
	\| ~~telephone_pager~~
	\|\|
	\|-		\|-
	\| cell		\| cell
	\| 551		\| 551
	\| cellular_telephone1		\| cellular_telephone1
	\| 552		\| 552, 553
	\| cellular_telephone2		\| cellular_telephone2, telephone_other
			\|-
			\| voice,work
			\| 542
			\| telephone_business1
			\| 543, 547, 553
			\| telephone_business2, telephone_company, telephone_other
			\|-
			\| voice,home
			\| 548
			\| telephone_home1
			\| 589, 553
			\| telephone_home2, telephone_other
			\|-
			\| voice,dom
			\| 553
			\| telephone_other
			\|-
			\| voice
			\| 542
			\| telephone_business1
			\| 543, 547, 548, 589, 553
			\| telephone_business2, telephone_company, telephone_home1, telephone_home2, telephone_other
			\|-
			\| fax,work
			\| 544
			\| fax_business
			\| 554
			\| fax_other
			\|-
			\| fax,home
			\| 550
			\| fax_home
			\| 554
			\| fax_other
			\|-
			\| fax,dom
			\| 554
			\| fax_other
			\|-
			\| fax
			\| 544
			\| fax_business
			\| 550, 554
			\| fax_home, fax_other
	\|}		\|}

Tierlieb at 19:27, 22 August 2013

2013-08-22T19:27:43Z

← Older revision		Revision as of 19:27, 22 August 2013
Line 100:		Line 100:
	\| cellular_telephone2		\| cellular_telephone2
	\|}		\|}

			== Distribution lists ==
			Distribution lists are specific to OX. VCards do not really have a functional equivalent. So the export of distribution lists is not supported.

	== Other unsupported fields ==		== Other unsupported fields ==

Tierlieb at 13:34, 9 August 2013

2013-08-09T13:34:30Z

← Older revision		Revision as of 13:34, 9 August 2013
Line 1:		Line 1:
	<div ~~style~~="title">VCard and ICal support</div>		<div class="title">VCard and ICal support</div>

	__TOC__		__TOC__

Tierlieb: style

2013-08-09T13:34:21Z

style

← Older revision		Revision as of 13:34, 9 August 2013
Line 1:		Line 1:
	VCard and ICal are definitions of text-based PIM information in files. In OX terms, VCard defines ''contact'' data, while ICal defines both ''Tasks'' and ''Appointments''. ICal internally identifies itself as VCalendar 2.0, which illustrates who closely related both protocols are. That is why questions on both formats are answered in one article.		<div style="title">VCard and ICal support</div>

			__TOC__

			'''Abstract''': VCard and ICal are definitions of text-based PIM information in files. In OX terms, VCard defines ''contact'' data, while ICal defines both ''Tasks'' and ''Appointments''. ICal internally identifies itself as VCalendar 2.0, which illustrates who closely related both protocols are. That is why questions on both formats are answered in one article.

	This article deals with features that are in VCard and ICal but are problematic within the OX. This also applies to CardDAV and CalDAV, because those services are also based on these two formats.		This article deals with features that are in VCard and ICal but are problematic within the OX. This also applies to CardDAV and CalDAV, because those services are also based on these two formats.

Tierlieb: ...because of Bug 25872

2013-08-09T13:33:25Z

...because of Bug 25872

← Older revision		Revision as of 13:33, 9 August 2013
Line 1:		Line 1:
	VCard and ICal are definitions of text-based PIM information in files. In OX terms, VCard defines ''contact'' data, while ICal defines both ''Tasks'' and ''Appointments''. ICal internally identifies itself as VCalendar 2.0, which illustrates who closely related both protocols are. That is why questions on both formats are answered in one article.		VCard and ICal are definitions of text-based PIM information in files. In OX terms, VCard defines ''contact'' data, while ICal defines both ''Tasks'' and ''Appointments''. ICal internally identifies itself as VCalendar 2.0, which illustrates who closely related both protocols are. That is why questions on both formats are answered in one article.

	This article deals with features that are in VCard and ICal but are problematic within the OX.		This article deals with features that are in VCard and ICal but are problematic within the OX. This also applies to CardDAV and CalDAV, because those services are also based on these two formats.

	== RRULE: "The second last sunday in a month" ==		== RRULE: "The second last sunday in a month" ==
Line 17:		Line 17:
	Reference: [http://tools.ietf.org/html/rfc2445#section-4.8.6.2 RFC 2445, 4.8.6.2 Repeat count]		Reference: [http://tools.ietf.org/html/rfc2445#section-4.8.6.2 RFC 2445, 4.8.6.2 Repeat count]

	== ~~TEL:~~ Limited amount of fields ==		== Limited amount of fields ==
	The basic problem: Open-Xchange only supports a fixed set of phone number fields, all of which have a semantic meaning (so they are not used to store other phone numbers even if space is needed). VCards, on the other hand, allow for a theoretically unlimited amount of phone numbers via different type combinations (~~and~~ repeating the same one, too).		The basic problem: Open-Xchange only supports a fixed set of fields. VCards and ICals, on the other hand, allow for a theoretically unlimited amount of fields, sometimes by adding different types (thereby changing the semantic information, e.g. home and business addresses), sometimes by simply something (e.g. exceptions to an appointment series). This works in most cases (e.g. for appointment series) but not in others (see below).

			=== URL ===
			Open-Xchange only supports one URL per user. VCards allow several. URL is not supported.

			=== TEL ===
			As said, Open-Xchange only supports a fixed set of phone number fields, all of which have a semantic meaning (so they are not used to store other phone numbers even if space is needed). VCards, on the other hand, allow for a theoretically unlimited amount of phone numbers via different type combinations (or repeating the same one, too).

	In practice this is usually not much of a problem, for people do not have that many, but for all who are interested in the details:		In practice this is usually not much of a problem, for people do not have that many, but for all who are interested in the details:
Line 91:		Line 97:
	\|}		\|}

	== Other fields ~~not supported~~ ==		== Other unsupported fields ==
			These are just the field names as given the the RFCs, since we are unable to guess what they will be called in the client app.

	=== Appointments ===		=== Appointments ===
	ATTACH, COMMENT, CONTACT, CREATED, DTSTAMP, EXRULE, GEO, ORGANIZER, PRIORITY, RDATE, REQUEST-STATUS, STATUS		ATTACH, COMMENT, CONTACT, CREATED, DTSTAMP, EXRULE, GEO, ORGANIZER, PRIORITY, RDATE, REQUEST-STATUS, STATUS
Line 104:		Line 112:

	[[Category: OX6]]		[[Category: OX6]]
			[[Category: AppSuite]]

			[[Category: Backend]]

			[[Category: ICal]]
			[[Category: VCard]]
			[[Category: CalDAV]]
			[[Category: CardDAV]]

Tierlieb: /* TEL */

2013-04-30T10:08:58Z

TEL

← Older revision		Revision as of 10:08, 30 April 2013
Line 17:		Line 17:
	Reference: [http://tools.ietf.org/html/rfc2445#section-4.8.6.2 RFC 2445, 4.8.6.2 Repeat count]		Reference: [http://tools.ietf.org/html/rfc2445#section-4.8.6.2 RFC 2445, 4.8.6.2 Repeat count]

	== TEL ==		== TEL: Limited amount of fields ==
	The basic problem: Open-Xchange only supports a fixed set of phone number fields, all of which have a semantic meaning (so they are not used to store other phone numbers even if space is needed). VCards, on the other hand, allow for a theoretically unlimited amount of phone numbers via different type combinations (and repeating the same one, too).		The basic problem: Open-Xchange only supports a fixed set of phone number fields, all of which have a semantic meaning (so they are not used to store other phone numbers even if space is needed). VCards, on the other hand, allow for a theoretically unlimited amount of phone numbers via different type combinations (and repeating the same one, too).

Line 27:		Line 27:
	* If no type is given, the number is stored as 542, ''work1''		* If no type is given, the number is stored as 542, ''work1''
	* If type is voice and fax (confusing), we consider it ''voice''		* If type is voice and fax (confusing), we consider it ''voice''
			* OX does not distinguish between ''work'' and ''home'' cellphones, pagers, idsn oder car phones.

			This is how we map VCard fields to [[HTTP_API#DetailedContactData\|OX contact fields]]:
	~~For all other cases~~
	{\|		{\|
	! VCard type		! VCard type
Line 43:		Line 43:
	\| telephone_business2		\| telephone_business2
	\|-		\|-
	\| work;fax		\| work,fax
	\| 544		\| 544
	\| fax_business		\| fax_business
Line 54:		Line 54:
	\| telephone_home2		\| telephone_home2
	\|-		\|-
	\| home;fax		\| home,fax
	\| 550		\| 550
	\| fax_home		\| fax_home
Line 64:		Line 64:
	\|\|		\|\|
	\|-		\|-
	\| dom;fax		\| dom,fax
	\| 554		\| 554
	\| fax_other		\| fax_other

Tierlieb: /* TEL */

2013-04-30T10:04:25Z

TEL

← Older revision		Revision as of 10:04, 30 April 2013
Line 24:		Line 24:
	** either moved into the available fallback field		** either moved into the available fallback field
	** or dropped in case the is no fallback field		** or dropped in case the is no fallback field
	* The marker "pref" in VCards, denoting a preferred number, is ignored.		* The marker "pref" in VCards, denoting a preferred number, is ignored
	* If no type is given, the number is stored as 542, ''work1''		* If no type is given, the number is stored as 542, ''work1''
	* If type is voice and fax (confusing), we consider it ''voice''		* If type is voice and fax (confusing), we consider it ''voice''
Line 31:		Line 31:
	For all other cases		For all other cases
	{\|		{\|
	\| VCard type		! VCard type
	\| OX column number		! OX column number
	\| OX field name		! OX field name
	\| Fallback OX field		! Fallback OX field
	\| Fallback OX field name		! Fallback OX field name
	\|-		\|-
	\| work		\| work

Tierlieb: /* TEL */

2013-04-30T10:02:20Z

TEL

← Older revision		Revision as of 10:02, 30 April 2013
Line 35:		Line 35:
	\| OX field name		\| OX field name
	\| Fallback OX field		\| Fallback OX field
			\| Fallback OX field name
	\|-		\|-
	\| work		\| work

Tierlieb: /* TEL */

2013-04-30T10:01:56Z

TEL

← Older revision		Revision as of 10:01, 30 April 2013
Line 26:		Line 26:
	* The marker "pref" in VCards, denoting a preferred number, is ignored.		* The marker "pref" in VCards, denoting a preferred number, is ignored.
	* If no type is given, the number is stored as 542, ''work1''		* If no type is given, the number is stored as 542, ''work1''
			* If type is voice and fax (confusing), we consider it ''voice''


	For all other cases		For all other cases
	{\|		{\|
	\| VCard type		\| VCard type
	\| OX field		\| OX column number
			\| OX field name
	\| Fallback OX field		\| Fallback OX field
	\|-		\|-
	\| work		\| work
	\| 542		\| 542
	\| 543		\| telephone_business1
			\| 543
			\| telephone_business2
	\|-		\|-
	\| work;fax		\| work;fax
	\| 544		\| 544
	\|		\| fax_business
			\|\|
	\|-		\|-
	\| home		\| home
	\| 548		\| 548
			\| telephone_home1
	\| 589		\| 589
			\| telephone_home2
	\|-		\|-
	\| home;fax		\| home;fax
	\| 550		\| 550
	\|		\| fax_home
			\|\|
	\|-		\|-
	\| dom		\| dom
	\| 553		\| 553
	\|		\| telephone_other
			\|\|
	\|-		\|-
	\| dom;fax		\| dom;fax
	\| 554		\| 554
	\|		\| fax_other
			\|\|
	\|-		\|-
	\| car		\| car
	\| 546		\| 546
	\|		\| telephone_car
			\|\|
	\|-		\|-
	\| isdn		\| isdn
	\| 559		\| 559
	\|		\| telephone_isdn
			\|\|
	\|-		\|-
	\| pager		\| pager
	\| 560		\| 560
	\|		\| telephone_pager
			\|\|
	\|-		\|-
	\| cell		\| cell
	\| 551		\| 551
			\| cellular_telephone1
	\| 552		\| 552
			\| cellular_telephone2
	\|}		\|}