ews library
Classes
- Appointment
- Represents an appointment or a meeting. Properties available on appointments are defined in the AppointmentSchema class.
- AppointmentOccurrenceId
- Represents the Id of an occurrence of a recurring appointment.
- AppointmentSchema
- Represents the schema for appointment and meeting requests.
- ApprovalRequestData
- Represents approval request information.
- Attachment
- Represents an attachment to an item.
- AttachmentCollection
- Represents an item's attachment collection.
- Attendee
- Represents an attendee to a meeting.
- AttendeeCollection
- Represents a collection of attendees.
- BasicCredentials
- CalendarFolder
- Represents a folder containing appointments.
- CalendarView
- Represents a date range view of appointments in calendar folder search operations.
- Change
- Represents a change as returned by a synchronization operation.
-
ChangeCollection<
TChange extends Change> - Represents a collection of changes as returned by a synchronization operation.
- CompleteName
- Represents the complete name of a contact.
- ComplexProperty
- Represents a property that can be sent to or retrieved from EWS.
-
ComplexPropertyCollection<
TComplexProperty extends ComplexProperty> - Represents a collection of properties that can be sent to and retrieved from EWS.
- Contact
- Represents a contact. Properties available on contacts are defined in the ContactSchema class.
- ContactSchema
- Represents the schem for contacts.
- ContactsFolder
- Represents a folder containing contacts.
- ContainsSubString
- //
-
DictionaryEntryProperty<
TKey> - Represents an entry of a DictionaryProperty object.
-
DictionaryProperty<
TKey, TEntry extends DictionaryEntryProperty< TKey> > - Represents a generic dictionary that can be sent to or retrieved from EWS.
- EmailAddress
- Represents an e-mail address.
- EmailAddressCollection
- Represents a collection of e-mail addresses.
- EmailAddressDictionary
- Represents a dictionary of e-mail addresses.
- EmailAddressEntry
- Represents an entry of an EmailAddressDictionary.
- EmailMessage
- Represents an e-mail message. Properties available on e-mail messages are defined in the EmailMessageSchema class.
- EmailMessageSchema
- Represents the schema for e-mail messages.
- EnhancedLocation
- Represents Enhanced Location.
- EwsHttpClientFactory
- EwsHttpWebExceptionResponse
- EwsHttpWebRequest
- EwsHttpWebRequestFactory
- ExchangeCredentials
- Base class of Exchange credential types.
- ExchangeService
- Represents a binding to the Exchange Web Services.
- ExchangeServiceBase
- Represents an binding to an Exchange Service.
- ExcludesBitmask
- Represents a bitmask exclusion search filter. Applications can use ExcludesBitExcludesBitmaskFilter to define conditions such as "(OrdinalField and 0x0010) != 0x0010"
- Exists
- Represents a search filter checking if a field is set. Applications can use ExistsFilter to define conditions such as "Field IS SET".
- ExtendedProperty
- Represents an extended property.
- ExtendedPropertyCollection
- Represents a collection of extended properties.
- ExtendedPropertyDefinition
- Represents the definition of an extended property.
- FileAttachment
- Represents a file attachment.
- FindFoldersResults
- Represents the results of a folder search operation.
-
FindItemsResults<
TItem extends Item> - Represents the results of an item search operation.
- Flag
- Encapsulates information on the occurrence of a recurring appointment.
- Folder
- Represents a generic folder.
- FolderChange
- Represents a change on a folder as returned by a synchronization operation.
- FolderId
- Represents the Id of a folder.
- FolderIdCollection
- Represents a collection of folder Ids.
- FolderPermission
- Represents a permission on a folder.
- FolderPermissionCollection
- Represents a collection of folder permissions.
- FolderSchema
- Represents the schema for folders.
- FolderSchemaFieldUris
- FolderView
- Represents the view settings in a folder search operation.
-
GroupedFindItemsResults<
TItem extends Item> - Represents the results of an item search operation.
- Grouping
- Represents grouping options in item search operations.
- HighlightTerm
- Represents an AQS highlight term.
- IEwsHttpWebRequest
- HttpWebRequest proxy interface.
- IEwsHttpWebRequestFactory
- IEwsHttpWebResponse
- Interface representing HTTP web response.
- IHttpClientFactory
- IsEqualTo
- Represents a search filter that checks if a property is equal to a given value or other property.
- IsGreaterThan
- Represents a search filter that checks if a property is greater than a given value or other property.
- IsGreaterThanOrEqualTo
- Represents a search filter that checks if a property is greater than or equal to a given value or other property.
- IsLessThan
- Represents a search filter that checks if a property is less than a given value or other property.
- IsLessThanOrEqualTo
- Represents a search filter that checks if a property is less than or equal to a given value or other property.
- IsNotEqualTo
- Represents a search filter that checks if a property is not equal to a given value or other property.
- Item
- Represents a generic item. Properties available on items are defined in the ItemSchema class.
- ItemAttachment
- Represents an item attachment.
- ItemChange
- Represents a change on an item as returned by a synchronization operation.
-
ItemCollection<
TItem extends Item> - Represents a collection of items.
-
ItemGroup<
TItem extends Item> - Represents a group of items as returned by grouped item search operations.
- ItemId
- Represents the Id of an Exchange item.
- ItemSchema
- Represents the schema for generic items.
- ItemView
- Represents the view settings in a folder search operation.
- ITraceListener
- ITraceListener handles message tracing.
- Mailbox
- Represents a mailbox reference.
- MeetingCancellation
- Represents a meeting cancellation message. Properties available on meeting messages are defined in the MeetingMessageSchema class.
- MeetingMessage
- Represents a meeting-related message. Properties available on meeting messages are defined in the MeetingMessageSchema class.
- MeetingRequest
- Represents a meeting request that an attendee can accept or decline. Properties available on meeting requests are defined in the MeetingRequestSchema class.
- MeetingResponse
- Represents a response to a meeting request. Properties available on meeting messages are defined in the MeetingMessageSchema class.
- MeetingTimeZone
- Represents a time zone in which a meeting is defined.
- MessageBody
- Represents the body of a message.
- MimeContent
- Represents the MIME content of an item.
- MimeContentBase
- Represents the MIME content of an item.
- MonthlyPattern
- Represents a recurrence pattern where each occurrence happens on a specific day a specific number of months after the previous one.
- Not
- //
- OAuthCredentials
- OrderByCollection
- Represents an ordered collection of property definitions qualified with a sort direction.
- PagedView
- Represents a view settings that support paging in a search operation.
- PeopleQueryContextKeys
- Lists different keys that can be passed to the people query context dictionary
- PeopleQuerySource
- Lists the names of various sources of people
- PersonaPostalAddress
- Represents PersonaPostalAddress.
- PhysicalAddressEntry
- Represents an entry of an PhysicalAddressDictionary.
- PropertyBasedFilter
- Represents a search filter where an item or folder property is involved.
- PropertySet
- Represents a set of item or folder properties. Property sets are used to indicate what properties of an item or folder should be loaded when binding to an existing item or folder or when loading an item or folder's properties.
- RecurringAppointmentMasterId
- Represents the Id of an occurrence of a recurring appointment.
- ReferenceAttachment
- Represents an attachment by reference.
- RelationalFilter
- Represents the base class for relational filters (for example, IsEqualTo, IsGreaterThan or IsLessThanOrEqualTo).
- SearchFilter
- Represents the base search filter class. Use descendant search filter classes such as SearchFilter.IsEqualTo, SearchFilter.ContainsSubString and SearchFilter.SearchFilterCollection to define search filters.
- SearchFilterCollection
- Represents a collection of search filters linked by a logical operator. Applications can use SearchFilterCollection to define complex search filters such as "Condition1 AND Condition2".
- SearchFolder
- Represents a search folder.
- SearchFolderParameters
- Represents the parameters associated with a search folder.
- SearchFolderSchema
- Represents the schema for search folders.
- SeekToConditionItemView
- Represents the view settings in a folder search operation.
- ServiceId
- Represents the Id of an Exchange object.
- StreamingSubscription
- Represents a streaming subscription.
- StreamingSubscriptionConnection
- Represents a connection to an ongoing stream of events.
- StringList
- Represents a list of strings.
- Task
- Represents a Task item. Properties available on tasks are defined in the TaskSchema class.
- TaskSchema
- Represents the schema for task items.
- TasksFolder
- Represents a folder containing task items.
- TextBody
- Represents the body of a message.
- TimeChange
- Represents a change of time for a time zone.
- TimeChangeRecurrence
- Represents a recurrence pattern for a time change in a time zone.
- TimeSpan
- The Class TimeSpan.
- UniqueBody
- Represents the body part of an item that is unique to the conversation the item is part of.
- UserId
- Represents the Id of a user.
- ViewBase
- Represents the base view class for search operations.
Enums
- AffectedTaskOccurrence
- Indicates which occurrence of a recurring task should be deleted.
- AggregateType
- Defines the type of aggregation to perform.
- AppointmentType
- Defines the type of an appointment.
- AutodiscoverEndpoints
- Defines the types of Autodiscover endpoints that are available.
- AutodiscoverErrorCode
- Defines the error codes that can be returned by the Autodiscover service.
- AutodiscoverResponseType
- Defines the types of response the Autodiscover service can return.
- AvailabilityData
- Defines the type of data that can be requested via GetUserAvailability.
- BasePropertySet
- Defines base property sets that are used as the base for custom property sets.
- BodyType
- Defines the type of body of an item.
- ChangeType
- Defines the type of change of a synchronization event.
- ClientAccessTokenType
- Defines the type of ClientAccessTokenType
- ClientExtensionProvidedTo
- Defines the type of ClientExtensionProvidedTo.
- ComparisonMode
- Defines the way values are compared in search filters.
- ConflictResolutionMode
- Defines how conflict resolutions are handled in update operations.
- ConflictType
- Defines the conflict types that can be returned in meeting time suggestions.
- ConnectingIdType
- Defines the type of Id of a ConnectingId object.
- ConnectionFailureCause
- The ConnectionFailureCause enumeration
- ConsentState
- The consent states enumeration
- ContactSource
- Defines the source of a contact or group.
- ContainmentMode
- Defines the containment mode for Contains search filters.
- ConversationActionType
- Defines actions applicable to Conversation.
- ConversationFlagStatus
- Defines the flag status of a Conversation.
- ConversationQueryTraversal
- Defines the folder traversal depth in queries.
- ConversationSortOrder
- Defines the order in which conversation nodes should be returned by GetConversationItems.
- DateTimePrecision
- Defines the precision for returned DateTime values
- DayOfTheWeek
- Specifies the day of the week.
- DayOfTheWeekIndex
- Defines the index of a week day within a month.
- DefaultExtendedPropertySet
- Defines the default sets of extended properties.
- DelegateFolderPermissionLevel
- Defines a delegate user's permission level on a specific folder.
- DeleteMode
- Represents deletion modes.
- DomainSettingName
- Domain setting names.
- EffectiveRights
- Defines the effective user rights associated with an item or folder.
- ElcFolderType
- Defines the folder type of a retention policy tag.
- EmailAddressKey
- Defines e-mail address entries for a contact.
- EmailPosition
- Defines the email position of an extracted entity.
- EventType
- Defines the types of event that can occur in a folder.
- ExchangeVersion
- Defines the each available Exchange release version
- ExtensionInstallScope
- Defines the type of ExtensionInstallScope.
- ExtensionType
- Defines the type of ExtensionType.
- FileAsMapping
- Defines the way the FileAs property of a contact is automatically formatted.
- FlaggedForAction
- Defines the follow-up actions that may be stamped on a message.
- FolderPermissionLevel
- Defines permission levels for calendar folders.
- FolderPermissionReadAccess
- Defines a user's read access permission on items in a non-calendar folder.
- FolderTraversal
- Defines the scope of FindFolders operations.
- FreeBusyViewType
- Defines the type of free/busy information returned by a GetUserAvailability operation.
- GetUserPhotoStatus
- Defines the response types from a GetUserPhoto request
- HoldAction
- Defines the hold action.
- HoldStatus
- Defines the hold status.
- IconIndex
- The values indicate the types of item icons to display.
- IdFormat
- Defines supported Id formats in ConvertId operations.
- ImAddressKey
- Defines Instant Messaging address entries for a contact.
- Importance
- Defines the importance of an item.
- ItemFlagStatus
- Defines the flag status of an Item.
- ItemTraversal
- Defines the scope of FindItems operations.
- LegacyFreeBusyStatus
- Defines the legacy free/busy status associated with an appointment.
- LobbyBypass
- Online Meeting Lobby Bypass options.
- LocationSource
- Source of resolution.
- LogicalOperator
- Defines a logical operator as used by search filter collections.
- MailboxSearchLocation
- Defines the location for mailbox search.
- MailboxSearchScopeType
- Enum MailboxSearchScopeType
- MailboxType
- Defines the type of an EmailAddress object.
- MapiPropertyType
- Defines the MAPI type of an extended property.
- MeetingAttendeeType
- Defines the type of a meeting attendee.
- MeetingRequestsDeliveryScope
- Defines how meeting requests are sent to delegates.
- MeetingRequestType
- Defines the type of a meeting request.
- MeetingResponseType
- Defines the types of response given to a meeting request.
- MemberStatus
- Defines the status of group members.
- MessageDisposition
- Defines how messages are disposed of in CreateItem and UpdateItem operations.
- Month
- Defines months of the year.
- OffsetBasePoint
- Defines the offset's base point in a paged view.
- OnlineMeetingAccessLevel
- Online Meeting Access Level options.
- OofExternalAudience
- Defines the external audience of an Out of Office notification.
- OofState
- Defines a user's Out of Office Assistant status.
- OutlookProtocolType
- Defines supported Outlook protocls.
- PermissionScope
- Defines the scope of a user's permission on a folders.
- PhoneCallState
- The PhoneCallState enumeration
- PhoneNumberKey
- Defines phone number entries for a contact.
- PhysicalAddressIndex
- Defines a physical address index.
- PhysicalAddressKey
- Defines physical address entries for a contact.
- Presenters
- Online Meeting Presenters options.
- PreviewItemBaseShape
- Preview item base shape
- PrivilegedLogonType
- Defines the type of PrivilegedLogonType.
- PropertyDefinitionFlags
- Defines how a complex property behaves.
- ResolveNameSearchLocation
- Defines the location where a ResolveName operation searches for contacts.
- ResponseActions
- Defines the response actions that can be taken on an item.
- ResponseMessageType
- Defines the type of a ResponseMessage object.
- RetentionActionType
- Defines the action of a retention policy tag.
- RetentionType
- Defines the retention type.
- RuleErrorCode
- Defines the error codes identifying why a rule failed validation.
- RuleProperty
- Defines the available properties of a rule.
- SearchFolderTraversal
- Defines the scope of a search folder.
- SearchPageDirection
- Defines the page direction for mailbox search.
- SearchResultType
- Defines the type of search result.
- SendCancellationsMode
- Defines how meeting cancellations should be sent to attendees when an appointment is deleted.
- SendInvitationsMode
- Defines if/how meeting invitations are sent.
- SendInvitationsOrCancellationsMode
- Defines if/how meeting invitations or cancellations should be sent to attendees when an appointment is updated.
- SendPrompt
- The values indicate the types of item icons to display.
- Sensitivity
- Defines the sensitivity of an item.
- ServiceError
- Defines the error codes that can be returned by the Exchange Web Services.
- ServiceErrorHandling
- Defines the type of error handling used for service method calls.
- ServiceObjectType
- Defines the type of a service object.
- ServiceResult
- Defines the result of a call to an EWS method. Values in this enumeration have to be ordered from lowest to highest severity.
- SetClientExtensionActionId
- Defines the type of SetClientExtensionActionId.
- SortDirection
- Defines a sort direction
- StandardUser
- Defines a standard delegate user.
- SuggestionQuality
- Defines the quality of an availability suggestion.
- SyncFolderItemsScope
- Determines items to be included in a SyncFolderItems response.
- TaskDelegationState
- Defines the delegation state of a task.
- TaskMode
- Defines the modes of a Task.
- TaskStatus
- Defines the execution status of a task.
- TraceFlags
- Defines flags to control tracing details.
- ViewFilter
- Defines the view filter for queries.
- WellKnownFolderName
- Defines well known folder names.
- XmlNamespace
- Defines the namespaces as used by the EwsXmlReader, EwsServiceXmlReader, and EwsServiceXmlWriter classes.
Constants
Typedefs
- IComplexPropertyChangedDelegate = void Function(ComplexProperty complexProperty)
- The ComplexPropertyChangedDelegateInterface type.
- IServiceObjectChangedDelegate = void Function(ServiceObject serviceObject)
- NotificationEventDelegate = void Function(Object sender, NotificationEventArgs args)
- Represents a delegate that is invoked when notifications are received from the server
-
ReadAction
= Future<
bool> Function(EwsServiceXmlReader reader) - SubscriptionErrorDelegate = void Function(Object sender, SubscriptionErrorEventArgs args)
- Represents a delegate that is invoked when an error occurs within a streaming subscription connection.
Exceptions / Errors
- ServiceRequestException
- Represents an error that occurs when a service operation request fails (e.g. connection error).
- ServiceResponseException
- Represents a remote service exception that has a single response.
- WebException