IEWSClient

IEWSClient class

Inherits: Aspose::Email::Clients::Exchange::IExchangeClientBase

Represents the interface for Exchange client.

Methods

NameDescription
AddHeaderAdds name and value to WebHeaderCollection in EWS request.
AddToDistributionListAppends the members to Distribution List.
AppendMessage (5 overloads)Uploads the mail message to the Inbox folder
AppendMessages (5 overloads)Uploads the mail message to the specified folder
ArchiveItem (4 overloads)The ArchiveItem operation moves an item into the mailbox user’s archive mailbox.
Backup (2 overloads)Backups the content of the specified folders
CancelAppointment (6 overloads)Cancels appointment.
CheckUserAvailability (2 overloads)Checks users availability within the specified time window.
CloseAccess (4 overloads)Closes access on the specified mailbox for the specified user.
CopyConversationItems (2 overloads)Copies the conversation items, which are located in the specified folder, into the specified target folder
CopyItemCopies the item to specified folder
CreateAppointment (3 overloads)Creates appointment.
CreateCalendarSharingInvitationMessageCreate calendar sharing invitation message.
CreateContact (2 overloads)Creates a contact item in the Exchange store.
CreateDistributionListCreates the private Distribution List.
CreateFolder (6 overloads)Fetch the specified appointment from server.
CreateInboxRule (2 overloads)Creates the specified inbox rule
CreateItem (2 overloads)Creates the given item in the default item folder.
CreateItemsCreates the specified items in the speciifed folder
CreatePublicFolder (3 overloads)Creates the specified public folder in the root public folder
CreateTask (2 overloads)Creates the given task in the default task folder.
CreateUserConfigurationCreates the specified user configuration
DelegateAccess (3 overloads)Delegates access on the specified mailbox to the specified user.
DeleteConversationItems (2 overloads)Deletes all items of the specified conversation
DeleteDistributionListDeletes the Distribution List.
DeleteFolder (2 overloads)Deletes the folder
DeleteFolders (4 overloads)Deletes the specified folders
DeleteFromDistributionListDeletes the members from Distribution List.
DeleteInboxRule (2 overloads)Deletes the specified inbox rule
DeleteItemDeletes specified item
DeleteItemsDeletes specified items
DeleteUserConfigurationDeletes the specified user configuration
DisconnectPhoneCallDisconnects a phone call specified by id.
EmptyFolder (2 overloads)Empties the specified folder. Subfolders will not be deleted; deleted items will be moved into DeletedItems folder
ExpandDistributionListExpands the public Distribution List members.
ExportItemsExports the specified items from mailbox
FetchAppointment (2 overloads)Fetch the specified appointment from server.
FetchAttachmentFetches the attachment
FetchConversationMessagesFetches the specified conversation messages
FetchDistributionListFetches the private Distribution List members.
FetchItem (2 overloads)Retrieves the item as MapiMessage .
FetchMapiCalendar (2 overloads)Fetch array of MapiCalendar objects.
FetchMapiMessages (2 overloads)Fetches the speciifed messages
FetchMapiNotes (2 overloads)Fetch array of MapiNote objects.
FetchMapiTasks (2 overloads)Fetch array of MapiTask objects.
FetchMessage (2 overloads)Fetches the message.
FetchMessages (4 overloads)Fetches the speciifed messages
FetchTaskFetches the specified task.
FindConversationsFinds conversations in the specified folder
FindMessageTrackingReportFinds messages that meet the specified criteria.
FindPeople (2 overloads)Find contacts located in the specified user’s personal mailbox on server.
FolderExists (2 overloads)Checks whether the specified folder exists.
ForwardForward a message.
get_CalendarFolderEventFilterSpecifies event types for Calendar folder
get_ContactsFolderEventFilterSpecifies event types for Contacts folder
get_CurrentCalendarFolderUriGets current calendar folder uri
get_DeletedItemsFolderEventFilterSpecifies event types for DeletedItems folder
get_DraftsFolderEventFilterSpecifies event types for Drafts folder
get_EnableDecompressionGets a value that indicates whether decompression is enabled
get_HeadersGets array of name value pairs wich are added to WebHeaderCollection in EWS request.
get_InboxFolderEventFilterSpecifies event types for Inbox folder
get_JournalFolderEventFilterSpecifies event types for Journal folder
get_MailboxInfoGets the mailbox info.
get_NotesFolderEventFilterSpecifies event types for Notes folder
get_NotificationsCheckIntervalDefines interval for notification check
get_NotificationTimeoutDefines timeout for server notifications
get_OutboxFolderEventFilterSpecifies event types for Outbox folder
get_ReconnectCountGets the number of reconnect attempts at connection breaks.
get_ReturnClientRequestIdGets a flag to indicate whether the client requires the server side to return the request id.
get_RootFolderEventFilterSpecifies event types for Root folder
get_SentItemsFolderEventFilterSpecifies event types for SentItems folder
get_ServerVersionGets the information about the current version of MS Exchange .
get_TasksFolderEventFilterSpecifies event types for Tasks folder
get_TimezoneIdGets timezone id
get_UseSlashAsFolderSeparatorGets value that determines whether the slash ‘/’ is used as folder separator.
GetCallInfoRetrieves phone call information by call id
GetContact (4 overloads)Retrieves contact information according to specified identifier.
GetContacts (2 overloads)Lists contacts located in the specified folder on server
GetExchangeTypeGets the information about the current version of MS Exchange .
GetFolderInfoGets the folder information
GetFolderPermissionsGets the folder permissions.
GetInboxRules (2 overloads)Gets inbox rules
GetMailboxesLists mailboxes having smtp addresses. Note: the maximum count of returned contacts is 100. This is a restriction of used EWS operation.
GetMailboxInfo (2 overloads)Gets the mailbox info.
GetMailboxSizeGets the size of the mailbox. Please, note this operation is performed recursively for all subfolders and make take some time
GetMailboxSizeExGets the size of the mailbox Please, note this operation is performed recursively for all subfolders and make take some time
GetMailTipsGets mail tips
GetMessageTrackingReportGets message tracking report
GetServerTimeZoneIds (3 overloads)The GetServerTimeZoneIds returns information from time zone id that are available on an Exchange server.
GetUMConfigurationRetrieves unified messaging configuration
GetUserConfigurationGets the specified user configuration
GetVersionInfoReturns exchange server version info
ImpersonateUserImpersonates the user.
ListAppointments (8 overloads)Retrieves list of appointments for default calendar folder
ListAppointmentsByPage (8 overloads)Retrieves page with appointments for calendar folder
ListContacts (2 overloads)Lists contacts located in the specified folder on server
ListDelegatesLists the users who are granted access on the specified mailbox.
ListDistributionListsList the private Distribution Lists.
ListItems (6 overloads)Retrieve list of item uries in specified folder
ListMailboxes (2 overloads)Lists mailboxes.
ListMessages (14 overloads)List the messages in the inbox folder.
ListMessagesByPage (7 overloads)List the messages in the specified folder.
ListMessagesFromPublicFolder (2 overloads)Get collection of messages from public folder
ListPublicFoldersGets collection of public folders from root public folder
ListSubFolders (3 overloads)Gets collection of child public folders from parent
ListSubFoldersByPage (3 overloads)Searches the specified folder in the given parent folder with paging Method supports paging. Invokes for the first time in paging cycle.
ListTasks (6 overloads)Retrieves lists of exchange tasks for default folder.
LoadContactPhotoLoads contact photo binary data
MailDisablePublicFolderMail-disable a public folder
MailEnablePublicFolderMail-enable a public folder
MarkAllItems (3 overloads)Marks all items in specified folders.
MarkAllItemsAsRead (3 overloads)Marks all items in inbox folder as read without receipts.
MarkAllItemsAsUnread (3 overloads)Marks all items in inbox folder as unread.
MarkAsJunk (5 overloads)The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.
MoveConversationItems (2 overloads)Moves the conversation items, which are located in the specified folder, into the specified target folder
MoveItemMoves the item to specified folder
PlayOnPhoneThe PlayOnPhone operation initiates an outbound call and plays a message over the telephone.
RemoveHeaderRemove WebHeader from WebHeaderCollection in EWS request.
ReplyReply to the sender’s message.
ReplyAllReply to the sender and all recipients of a message.
ResetImpersonationMakes the impersonation reset.
ResetSubscriptionReset all subscriptions
ResolveContactResolves ambiguous mailbox names.
ResolveContacts (2 overloads)Resolves ambiguous mailbox display names. Note: the maximum count of returned contacts is 100. This is a restriction of used exchange command.
RestoreRestores the specified exchange folders from the given personal storage.
SaveMessage (2 overloads)Saves the message.
Send (3 overloads)Sends the specified message.
set_CalendarFolderEventFilterSpecifies event types for Calendar folder
set_ContactsFolderEventFilterSpecifies event types for Contacts folder
set_CurrentCalendarFolderUriSets current calendar folder uri
set_DeletedItemsFolderEventFilterSpecifies event types for DeletedItems folder
set_DraftsFolderEventFilterSpecifies event types for Drafts folder
set_EnableDecompressionSets a value that indicates whether decompression is enabled
set_InboxFolderEventFilterSpecifies event types for Inbox folder
set_JournalFolderEventFilterSpecifies event types for Journal folder
set_NotesFolderEventFilterSpecifies event types for Notes folder
set_NotificationsCheckIntervalDefines interval for notification check
set_NotificationTimeoutDefines timeout for server notifications
set_OutboxFolderEventFilterSpecifies event types for Outbox folder
set_ReconnectCountSets the number of reconnect attempts at connection breaks.
set_ReturnClientRequestIdSets a flag to indicate whether the client requires the server side to return the request id.
set_RootFolderEventFilterSpecifies event types for Root folder
set_SentItemsFolderEventFilterSpecifies event types for SentItems folder
set_TasksFolderEventFilterSpecifies event types for Tasks folder
set_TimezoneIdSets timezone id
set_UseSlashAsFolderSeparatorSets value that determines whether the slash ‘/’ is used as folder separator.
SetConversationReadState (2 overloads)Set read state of the conversation items to the specified value
SetReadFlag (2 overloads)Sets the read flag.
SyncFolder (5 overloads)Retrieves changes of the items in a specified folder.
UpdateAppointment (4 overloads)Updates appointment.
UpdateContact (2 overloads)Updates a contact item in the Exchange store.
UpdateDelegateUpdates the delegate user settings who is granted access on the specified mailbox.
UpdateDelegatesUpdates the delegate users settings who are granted access on the specified mailbox.
UpdateInboxRule (2 overloads)Updates the specified inbox rule
UpdateItemsUpdates the specified items in to a mailbox
UpdateNote (3 overloads)Updates the specified note.
UpdateSubscriptionUpdates subscriptions
UpdateTask (5 overloads)Updates the specified task.
UpdateUserConfigurationUpdates the specified user configuration
CalendarFolderServerNotificationsOccurs when arises specified event type for Calendar folder.
ContactsFolderServerNotificationsOccurs when arises specified event type for Contacts folder.
DeletedItemsFolderServerNotificationsOccurs when arises specified event type for DeletedItems folder.
DraftsFolderServerNotificationsOccurs when arises specified event type for Drafts folder.
InboxFolderServerNotificationsOccurs when arises specified event type for Inbox folder.
ItemSentRaised when an item is sent and save in Sent Items folder.
JournalFolderServerNotificationsOccurs when arises specified event type for Journal folder.
NotesFolderServerNotificationsOccurs when arises specified event type for Notes folder.
OutboxFolderServerNotificationsOccurs when arises specified event type for Outbox folder.
RootFolderServerNotificationsOccurs when arises specified event type for Root folder.
SentItemsFolderServerNotificationsOccurs when arises specified event type for SentItems folder.
TasksFolderServerNotificationsOccurs when arises specified event type for Tasks folder.