Aspose::Email::Clients::Exchange::WebService Namespace Reference

Classes

class  CalendarDeletionOptions
 Defines parameters for item deletion More...
 
class  CallInformation
 Phone call information More...
 
class  DateRange
 Represents the date range More...
 
class  DeletionOptions
 Defines parameters for item deletion More...
 
class  EWSClient
 Provides access to MS Exchange Server by using Exchange Web Services (EWS). More...
 
class  ExchangeCalendarEvent
 Represents the event in the user's calendar More...
 
class  ExchangeCalendarEventCollection
 Represents the collection of ExchangeCalendarEvent More...
 
class  ExchangeConversation
 Represents a single conversation. More...
 
class  ExchangeDelegatePermissions
 Represents the folder permissions for the delegate user More...
 
class  ExchangeDelegateUser
 Represents a user who is granted access to the principal mailbox More...
 
class  ExchangeDelegateUserCollection
 Represents the collection of ExchangeDelegateUser More...
 
class  ExchangeStreamedItem
 Represents the item received in ExportItems response More...
 
class  ExchangeTask
 Represents the exchange task information. More...
 
class  ExchangeUploadItemResult
 Represents a result of updating or creating a streamed item More...
 
class  ExchangeUserAvailability
 Represents user availability information More...
 
class  ExchangeUserAvailabilityCollection
 Represents the collection of ExchangeUserAvailability More...
 
class  ExchangeUserWorkingHours
 Represents the user working hours. More...
 
class  ExchangeUserWorkingHoursCollection
 Represents the collection of ExchangeUserWorkingHours More...
 
class  FindMessageTrackingReportOptions
 Represents options for FindMessageTrackingReport operation More...
 
class  GetMailTipsOptions
 Represents options for GetMailTips More...
 
class  GetMessageTrackingReportOptions
 Represents options for GetMessageTrackingReport operation More...
 
class  IEWSClient
 Represents the interface for Exchange client. More...
 
class  MailTips
 Represents values for the Mail Tips More...
 
class  MessageTrackingReport
 Represents the information to be included in the report. More...
 
class  MessageTrackingReportInfo
 Represents an information about the message that was found by using the FindMessageTrackingReport More...
 
class  OutOfOfficeMailTip
 Represents OOF mail tip More...
 
class  RecipientTrackingEvent
 Represents details for a specific event in the tracking report. More...
 
class  ReplyBody
 Represents the OOF message response. More...
 
class  RestoreSettings
 The settings for the IEWSClient.Restore method More...
 
class  SentItemEventArgs
 Containing data for SentItem event. More...
 
class  ServerNotificationEventArgs
 Contains event data for server notification. More...
 
class  SyncFolderResult
 Result for SyncFolder operation More...
 
class  SyncState
 Synchronization object for folder synchronization operation. More...
 
class  TaskRegeneratingPattern
 Represents the regenerating recurrence pattern that specifies how many days, weeks, months or years after the completion of the current task the next occurrence will be due. More...
 
class  UnifiedMessagingConfiguration
 Unified messaging configuration More...
 
class  UserConfiguration
 Represents user configuration More...
 
class  UserConfigurationName
 Represents user configuration name More...
 

Enumerations

enum  KnownFolders {
  KnownFolders::NotDefined = 0, KnownFolders::Root, KnownFolders::Calendar, KnownFolders::Contacts,
  KnownFolders::DeletedItems, KnownFolders::Drafts, KnownFolders::Inbox, KnownFolders::Journal,
  KnownFolders::Notes, KnownFolders::Outbox, KnownFolders::SentItems, KnownFolders::Tasks
}
 Specifies the known Exchange server folders. More...
 
enum  KnownFolderTypes {
  KnownFolderTypes::Unknown = 0, KnownFolderTypes::Root, KnownFolderTypes::Calendar, KnownFolderTypes::Contacts,
  KnownFolderTypes::DeletedItems, KnownFolderTypes::Drafts, KnownFolderTypes::Inbox, KnownFolderTypes::Journal,
  KnownFolderTypes::Notes, KnownFolderTypes::Outbox, KnownFolderTypes::SentItems, KnownFolderTypes::Tasks
}
 Specifies the known Exchange server folders. More...
 
enum  CalendarItemCreateOrDeleteOperation { CalendarItemCreateOrDeleteOperation::NotSpecified, CalendarItemCreateOrDeleteOperation::SendToNone, CalendarItemCreateOrDeleteOperation::SendOnlyToAll, CalendarItemCreateOrDeleteOperation::SendToAllAndSaveCopy }
 Represents options for create and delete operations More...
 
enum  ExchangeConversationFlagStatus { ExchangeConversationFlagStatus::Undefined = -1, ExchangeConversationFlagStatus::NotFlagged, ExchangeConversationFlagStatus::Flagged, ExchangeConversationFlagStatus::Complete }
 Enumerates the flag status for conversation. More...
 
enum  ExchangeVersion {
  ExchangeVersion::Exchange2007, ExchangeVersion::Exchange2007_SP1, ExchangeVersion::Exchange2010, ExchangeVersion::Exchange2010_SP1,
  ExchangeVersion::Exchange2010_SP2, ExchangeVersion::Exchange2013, ExchangeVersion::Exchange2013_SP1, ExchangeVersion::Exchange2016
}
 Exchange server versions More...
 
enum  ItemChoice { ItemChoice::PrimarySmtpAddress, ItemChoice::PrincipalName, ItemChoice::SID, ItemChoice::SmtpAddress }
 Specifies property type which should be used for Exchange impersonation. More...
 
enum  ExchangeDelegateFolderPermissionLevel {
  ExchangeDelegateFolderPermissionLevel::NotSpecified = -1, ExchangeDelegateFolderPermissionLevel::None, ExchangeDelegateFolderPermissionLevel::Reviewer, ExchangeDelegateFolderPermissionLevel::Author,
  ExchangeDelegateFolderPermissionLevel::Editor, ExchangeDelegateFolderPermissionLevel::Custom
}
 Enumerates the permissions levels which a delegate user can have on folder More...
 
enum  ExchangeDelegateOptions { ExchangeDelegateOptions::None = 0, ExchangeDelegateOptions::ReceiveCopiesOfMeetingMessages = 1, ExchangeDelegateOptions::ViewPrivateItems = 2 }
 Enumerates delegation options More...
 
enum  EmptyFolderOptions { EmptyFolderOptions::None = 0, EmptyFolderOptions::DeleteSubfolders = 1, EmptyFolderOptions::DeletePermanently = 2 }
 Enumerates the empty folder options More...
 
enum  DeletionType { DeletionType::Default = 0, DeletionType::MoveToDeletedItems, DeletionType::Permanently }
 Type of deletion More...
 
enum  ExchangeListContactsOptions { ExchangeListContactsOptions::None = 0, ExchangeListContactsOptions::FetchPhoto = 1, ExchangeListContactsOptions::FetchPhotoAndAttachments = 2 }
 Enumerates the list contacts options More...
 
enum  MailTipsType {
  MailTipsType::All = 1, MailTipsType::OutOfOfficeMessage = 2, MailTipsType::MailboxFullStatus = 4, MailTipsType::CustomMailTip = 8,
  MailTipsType::ExternalMemberCount = 16, MailTipsType::TotalMemberCount = 32, MailTipsType::MaxMessageSize = 64, MailTipsType::DeliveryRestriction = 128,
  MailTipsType::ModerationStatus = 256, MailTipsType::InvalidRecipient = 512, MailTipsType::Scope = 1024
}
 Enumerates the types of mail tips More...
 
enum  MessageTrackingReportTemplate { MessageTrackingReportTemplate::Summary, MessageTrackingReportTemplate::RecipientPath }
 Enumerates the types of report to display. More...
 
enum  EventTypes {
  EventTypes::None = 0, EventTypes::Copied = 1, EventTypes::Created = 2, EventTypes::Deleted = 4,
  EventTypes::FreeBusyChanged = 8, EventTypes::Modified = 16, EventTypes::Moved = 32, EventTypes::NewMail = 64
}
 Specifies event type More...
 
enum  SyncFolderType { SyncFolderType::Items = 1, SyncFolderType::SubFolders = 2, SyncFolderType::All = 3 }
 Folder synchronization types More...
 
enum  DeleteTaskOptions { DeleteTaskOptions::None = 0, DeleteTaskOptions::DeletePermanently = 1 }
 Enumerates delete task options. More...
 
enum  ExchangeTaskStatus {
  ExchangeTaskStatus::NotStarted, ExchangeTaskStatus::Completed, ExchangeTaskStatus::Deferred, ExchangeTaskStatus::InProgress,
  ExchangeTaskStatus::WaitingOnOthers
}
 Enumerates the task statuses. More...
 
enum  TaskRegeneratingType { TaskRegeneratingType::Daily, TaskRegeneratingType::Weekly, TaskRegeneratingType::Monthly, TaskRegeneratingType::Yearly }
 Enumerates the types of regenerating pattern. More...
 
enum  UpdateTaskOptions { UpdateTaskOptions::None = 0, UpdateTaskOptions::ForceRewrite = 1 }
 Enumerates update task options. More...
 
enum  ConnectionFailureCause {
  ConnectionFailureCause::None, ConnectionFailureCause::UserBusy, ConnectionFailureCause::NoAnswer, ConnectionFailureCause::Unavailable,
  ConnectionFailureCause::Other
}
 Connection failure cause More...
 
enum  PhoneCallState {
  PhoneCallState::Idle, PhoneCallState::Connecting, PhoneCallState::Alerted, PhoneCallState::Connected,
  PhoneCallState::Disconnected, PhoneCallState::Incoming, PhoneCallState::Transferring, PhoneCallState::Forwarding
}
 Phone call statuses. More...
 
enum  ExchangeUserBusyness {
  ExchangeUserBusyness::Busy, ExchangeUserBusyness::Free, ExchangeUserBusyness::NoData, ExchangeUserBusyness::OOF,
  ExchangeUserBusyness::Tentative, ExchangeUserBusyness::WorkingElsewhere
}
 Enumerates the user free/busy statuses More...
 

Enumeration Type Documentation

◆ CalendarItemCreateOrDeleteOperation

Represents options for create and delete operations

Enumerator
NotSpecified 

Not specified

SendToNone 

Don't send mail

SendOnlyToAll 

Send email to participants.

SendToAllAndSaveCopy 

Send email to participants and save copy.

◆ ConnectionFailureCause

Connection failure cause

Enumerator
None 

Failure cause is absent

UserBusy 

Addressee is busy

NoAnswer 

No answer

Unavailable 

Addressee is unavailable.

Other 

Other reason

◆ DeleteTaskOptions

Enumerates delete task options.

Deprecated:
Enumerator
None 

Specifies that task should be moved into DeletedItems folder.

DeletePermanently 

Specifies that task should be deleted permanently.

◆ DeletionType

Type of deletion

Enumerator
Default 

Type of deletion depends on item type. In most cases (if possible) uses permanent deletion.

MoveToDeletedItems 

Move item or folder to garbage folder

Permanently 

The item or folder is permanently deleted.

◆ EmptyFolderOptions

Enumerates the empty folder options

Enumerator
None 

If DeletePermanently flag is not set, move folder contents excluding subfolders to DeletedItems folder.

DeleteSubfolders 

Include subfolders into deletion operation.

DeletePermanently 

Indicates that items should be deleted permanently.

◆ EventTypes

Specifies event type

Enumerator
None 

Not defined

Copied 

Event arises when item is copied

Created 

Event arises when item is created

Deleted 

Event arises when item is deleted

FreeBusyChanged 

Event arises when FreeBusy state is changed

Modified 

Event arises when item is changed

Moved 

Event arises when item is moved

NewMail 

Event arises when new mail is received

◆ ExchangeConversationFlagStatus

Enumerates the flag status for conversation.

Enumerator
Undefined 

Undefined status

NotFlagged 

Specifies the not-flagged status.

Flagged 

Specifies the flagged flag status.

Complete 

Specifies the complete flag status.

◆ ExchangeDelegateFolderPermissionLevel

Enumerates the permissions levels which a delegate user can have on folder

Enumerator
NotSpecified 

Indicates that permission level is not specified

None 

Indicates that the delegate user has no permissions on the folder

Reviewer 

Indicates that the delegate user can read items in the folder

Author 

Indicates that the delegate user can read and create items in the folder

Editor 

Indicates that the delegate user can create, read and modify items in the folder

Custom 

Indicates that the delegate user has custom permission on the folder

◆ ExchangeDelegateOptions

Enumerates delegation options

Enumerator
None 

Indicates that no additional options are specified

ReceiveCopiesOfMeetingMessages 

Indicates that the delegate receives copies of meeting-related messages that are addressed to the principal.

ViewPrivateItems 

Indicates that the delegate can view private calendar items on the principal´┐Żs calendar.

◆ ExchangeListContactsOptions

Enumerates the list contacts options

Enumerator
None 

No specific options are defined

FetchPhoto 

Defines, whether a contact photo to be retrieved from a server.

FetchPhotoAndAttachments 

Defines, whether a contact photo to be retrieved from a server.

◆ ExchangeTaskStatus

Enumerates the task statuses.

Enumerator
NotStarted 

Specifies that the task is not started.

Completed 

Specifies that the task is completed.

Deferred 

Specifies that the task is deferred.

InProgress 

Specifies that the task is in progress.

WaitingOnOthers 

Specifies that the task is waiting on others.

◆ ExchangeUserBusyness

Enumerates the user free/busy statuses

Enumerator
Busy 

Specifies the status as busy.

Free 

Specifies the status as free.

NoData 

Specifies that there is no data for that recipient.

OOF 

Specifies the status as Out of Office (OOF).

Tentative 

Specifies the status as tentative.

WorkingElsewhere 

Specifies the status as working elsewhere.

◆ ExchangeVersion

Exchange server versions

Enumerator
Exchange2007 

MS Exchange server 2007

Exchange2007_SP1 

MS Exchange server 2007 SP1

Exchange2010 

MS Exchange server 2010

Exchange2010_SP1 

MS Exchange server 2010 SP1

Exchange2010_SP2 

MS Exchange server 2010 SP2

Exchange2013 

MS Exchange server 2013

Exchange2013_SP1 

MS Exchange server 2013 SP1

Exchange2016 

MS Exchange server 2016

◆ ItemChoice

Specifies property type which should be used for Exchange impersonation.

Enumerator
PrimarySmtpAddress 

Specifies that primary Simple Mail Transfer Protocol (SMTP) address of the account should be used for Exchange impersonation.

PrincipalName 

Specifies that user principal name (UPN) of the account should be used for Exchange impersonation.

SID 

Specifies that security descriptor definition language (SDDL) form of the security identifier (SID) for the account should be used for Exchange impersonation.

SmtpAddress 

Specifies that Simple Mail Transfer Protocol (SMTP) address of the account should be used for Exchange impersonation.

◆ KnownFolders

Specifies the known Exchange server folders.

Enumerator
NotDefined 

Not specified

Root 

The Root folder.

Calendar 

The Calendar folder.

Contacts 

The Contacts folder.

DeletedItems 

The DeletedItems folder.

Drafts 

The Drafts folder.

Inbox 

The Inbox folder.

Journal 

The Journal folder.

Notes 

The Notes folder.

Outbox 

The Outbox folder.

SentItems 

The SentItems folder.

Tasks 

The Tasks folder.

◆ KnownFolderTypes

Specifies the known Exchange server folders.

Deprecated:
This object is obsolete and will be removed soon. Please, uses KnownFolders instead.
Enumerator
Unknown 

Not specified

Root 

The Root folder.

Calendar 

The Calendar folder.

Contacts 

The Contacts folder.

DeletedItems 

The DeletedItems folder.

Drafts 

The Drafts folder.

Inbox 

The Inbox folder.

Journal 

The Journal folder.

Notes 

The Notes folder.

Outbox 

The Outbox folder.

SentItems 

The SentItems folder.

Tasks 

The Tasks folder.

◆ MailTipsType

Enumerates the types of mail tips

Enumerator
All 

Represents all available mail tips.

OutOfOfficeMessage 

Represents the Out of Office (OOF) message.

MailboxFullStatus 

Represents the status for a mailbox that is full.

CustomMailTip 

Represents a custom mail tip.

ExternalMemberCount 

Represents the count of external members.

TotalMemberCount 

Represents the count of all members.

MaxMessageSize 

Represents the maximum message size a recipient can accept.

DeliveryRestriction 

Indicates whether delivery restrictions will prevent the sender's message from reaching the recipient.

ModerationStatus 

Indicates whether the sender's message will be reviewed by a moderator.

InvalidRecipient 

Indicates whether the recipient is invalid.

Scope 

◆ MessageTrackingReportTemplate

Enumerates the types of report to display.

Enumerator
Summary 

Specifies that the report will display all the recipients of the message and the delivery status of the message to each recipient.

RecipientPath 

Specifies that for a single recipient, the report will display a full history of the events that occurred.

◆ PhoneCallState

Phone call statuses.

Enumerator
Idle 

Phone call is idle

Connecting 

Phone call is connecting

Alerted 

Alerted call.

Connected 

Phone call is connected

Disconnected 

Phone call is disconnected

Incoming 

Incoming call

Transferring 

Transferred call.

Forwarding 

Phone call is forwarding

◆ SyncFolderType

Folder synchronization types

Enumerator
Items 

Only items

SubFolders 

Only subfolders

All 

Items and subfolders

◆ TaskRegeneratingType

Enumerates the types of regenerating pattern.

Enumerator
Daily 

Indicates the daily regenerating pattern.

Weekly 

Indicates the weekly regenerating pattern.

Monthly 

Indicates the monthly regenerating pattern.

Yearly 

Indicates the yearly regenerating pattern.

◆ UpdateTaskOptions

Enumerates update task options.

Enumerator
None 

No specific options are specified.

ForceRewrite 

Specifies that the task should be rewritten in any way even if some changes were made after the last operation with the task.