TimeZoneAndEmailSettingsCollectionTimeZone Property |
Determines the time zone of a document collection.
Namespace: OpenDiscoverSDK.Interfaces.SettingsAssembly: OpenDiscoverSDK.Interfaces (in OpenDiscoverSDK.Interfaces.dll) Version: 2025.4.4.0 (2025.4.4)
Syntax[DataMemberAttribute]
[JsonConverterAttribute(typeof(JsonTimeZoneInfoConverter))]
public TimeZoneInfo CollectionTimeZone { get; set; }Property Value
TimeZoneInfo
Remarks
A document collection is the set of documents to be content extracted.
This time zone property is only used by Open Discover SDK for 2 purposes:
-
Displaying the UTC dates in email extracted text such as email sent dates, appointment start/end dates, task dates, and journal dates in a
desired local time zone. For example, the local time zone of the email sender or a chosen time zone if processing email from parties in different
time zones. This property setting is ignored for email extracted text if property EmailDateTimeFormat is set to RFC1123,
as this date/time format always expresses time as Coordinated Universal Time (UTC).
-
Optionally, if property ApplyTimeZoneToMetadata is true, to convert extracted DateTime metadata that have Kind equal to
Unspecified to UTC DateTime (Utc) values by assuming the metadata DateTime value is a local time in the
specified timezone. Note: most document formats already store all DateTime metadata as UTC (and SDK extracts them that way) but some formats, mostly legacy formats,
can have DateTime metadata not stored as UTC.
If the document or document collection to process is of unknown origin and of unknown time zone(s) then consider keeping CollectionTimeZone time zone to Utc
and setting ApplyTimeZoneToMetadata to false, their default values.
Default property value: TimeZoneInfo.Utc
Value cannot be null.
See Also