EWSClient

Contents
[ ]

Inheritance: java.lang.Object, com.aspose.email.ExchangeClientBase

public abstract class EWSClient extends ExchangeClientBase

Provides access to MS Exchange Server by using Exchange Web Services (EWS).

Fields

Field Description
RootFolderServerNotifications Occurs when arises specified event type for Root folder.
CalendarFolderServerNotifications Occurs when arises specified event type for Calendar folder.
ContactsFolderServerNotifications Occurs when arises specified event type for Contacts folder.
DeletedItemsFolderServerNotifications Occurs when arises specified event type for DeletedItems folder.
DraftsFolderServerNotifications Occurs when arises specified event type for Drafts folder.
InboxFolderServerNotifications Occurs when arises specified event type for Inbox folder.
JournalFolderServerNotifications Occurs when arises specified event type for Journal folder.
NotesFolderServerNotifications Occurs when arises specified event type for Notes folder.
OutboxFolderServerNotifications Occurs when arises specified event type for Outbox folder.
SentItemsFolderServerNotifications Occurs when arises specified event type for SentItems folder.
TasksFolderServerNotifications Occurs when arises specified event type for Tasks folder.

Methods

Method Description
useSAAJAPI(boolean value) Sets value indicating whether SAAJ is used.
disableSAAJCertificateValidation() Disable SAAJ certificate validation
getEWSClient(URL mailboxUrl) Initializes a new instance of the EWSClient based class
getEWSClient(URL mailboxUrl, int serverVersion) Initializes a new instance of the EWSClient based class
getEWSClient(String mailboxUri, System.Net.ICredentials credentials) Initializes a new instance of the EWSClient based class
getEWSClient(String mailboxUri, String username, String password) Initializes a new instance of the EWSClient based class
getEWSClient(String mailboxUri, String username, String password, System.Net.WebProxy proxy) Initializes a new instance of the EWSClient based class
getEWSClient(String mailboxUri, String username, String password, String domain) Initializes a new instance of the EWSClient based class
getEWSClient(String mailboxUri, String username, String password, String domain, System.Net.WebProxy proxy) Initializes a new instance of the EWSClient based class
getEWSClient(int serverVersion, String mailboxUri, System.Net.ICredentials credentials, System.Net.WebProxy proxy) Initializes a new instance of the EWSClient based class
getEWSClient(int serverVersion, boolean formbasedAuthenticationRequired, String formbasedAuthenticationLocation, String mailboxUri, System.Net.ICredentials credentials, System.Net.WebProxy proxy) Initializes a new instance of the EWSClient based class
getEWSClient(String mailboxUri, System.Net.ICredentials credentials, System.Net.WebProxy proxy) Initializes a new instance of the EWSClient based class
getEWSClient(String mailboxUri, System.Net.ICredentials credentials, System.Net.WebProxy proxy, int timeout) Initializes a new instance of the EWSClient based class
getNotificationTimeout() getNotificationTimeout.
setNotificationTimeout(int value) setNotificationTimeout.
getNotificationsCheckInterval() getNotificationsCheckInterval.
setNotificationsCheckInterval(int value) setNotificationsCheckInterval.
getRootFolderEventFilter() getRootFolderEventFilter.
setRootFolderEventFilter(int value) setRootFolderEventFilter.
getCalendarFolderEventFilter() getCalendarFolderEventFilter.
setCalendarFolderEventFilter(int value) setCalendarFolderEventFilter.
getContactsFolderEventFilter() getContactsFolderEventFilter.
setContactsFolderEventFilter(int value) setContactsFolderEventFilter.
getDeletedItemsFolderEventFilter() getDeletedItemsFolderEventFilter.
setDeletedItemsFolderEventFilter(int value) setDeletedItemsFolderEventFilter.
getDraftsFolderEventFilter() getDraftsFolderEventFilter.
setDraftsFolderEventFilter(int value) setDraftsFolderEventFilter.
getInboxFolderEventFilter() getInboxFolderEventFilter.
setInboxFolderEventFilter(int value) setInboxFolderEventFilter.
getJournalFolderEventFilter() getJournalFolderEventFilter.
setJournalFolderEventFilter(int value) setJournalFolderEventFilter.
getNotesFolderEventFilter() getNotesFolderEventFilter.
setNotesFolderEventFilter(int value) setNotesFolderEventFilter.
getOutboxFolderEventFilter() getOutboxFolderEventFilter.
setOutboxFolderEventFilter(int value) setOutboxFolderEventFilter.
getSentItemsFolderEventFilter() getSentItemsFolderEventFilter.
setSentItemsFolderEventFilter(int value) setSentItemsFolderEventFilter.
getTasksFolderEventFilter() getTasksFolderEventFilter.
setTasksFolderEventFilter(int value) setTasksFolderEventFilter.
dispose()

RootFolderServerNotifications

public final Event<System.EventHandler<ServerNotificationEventArgs>> RootFolderServerNotifications

Occurs when arises specified event type for Root folder.

CalendarFolderServerNotifications

public final Event<System.EventHandler<ServerNotificationEventArgs>> CalendarFolderServerNotifications

Occurs when arises specified event type for Calendar folder.

ContactsFolderServerNotifications

public final Event<System.EventHandler<ServerNotificationEventArgs>> ContactsFolderServerNotifications

Occurs when arises specified event type for Contacts folder.

DeletedItemsFolderServerNotifications

public final Event<System.EventHandler<ServerNotificationEventArgs>> DeletedItemsFolderServerNotifications

Occurs when arises specified event type for DeletedItems folder.

DraftsFolderServerNotifications

public final Event<System.EventHandler<ServerNotificationEventArgs>> DraftsFolderServerNotifications

Occurs when arises specified event type for Drafts folder.

InboxFolderServerNotifications

public final Event<System.EventHandler<ServerNotificationEventArgs>> InboxFolderServerNotifications

Occurs when arises specified event type for Inbox folder.

JournalFolderServerNotifications

public final Event<System.EventHandler<ServerNotificationEventArgs>> JournalFolderServerNotifications

Occurs when arises specified event type for Journal folder.

NotesFolderServerNotifications

public final Event<System.EventHandler<ServerNotificationEventArgs>> NotesFolderServerNotifications

Occurs when arises specified event type for Notes folder.

OutboxFolderServerNotifications

public final Event<System.EventHandler<ServerNotificationEventArgs>> OutboxFolderServerNotifications

Occurs when arises specified event type for Outbox folder.

SentItemsFolderServerNotifications

public final Event<System.EventHandler<ServerNotificationEventArgs>> SentItemsFolderServerNotifications

Occurs when arises specified event type for SentItems folder.

TasksFolderServerNotifications

public final Event<System.EventHandler<ServerNotificationEventArgs>> TasksFolderServerNotifications

Occurs when arises specified event type for Tasks folder.

useSAAJAPI(boolean value)

public static void useSAAJAPI(boolean value)

Sets value indicating whether SAAJ is used.

Parameters:

Parameter Type Description
value boolean True if SAAJ API should be used.

disableSAAJCertificateValidation()

public static void disableSAAJCertificateValidation()

Disable SAAJ certificate validation

getEWSClient(URL mailboxUrl)

public static IEWSClient getEWSClient(URL mailboxUrl)

Initializes a new instance of the EWSClient based class

Parameters:

Parameter Type Description
mailboxUrl java.net.URL The URL of mailbox

Returns: IEWSClient - Instance of the class based on the EWSClient class.

getEWSClient(URL mailboxUrl, int serverVersion)

public static IEWSClient getEWSClient(URL mailboxUrl, int serverVersion)

Initializes a new instance of the EWSClient based class

Parameters:

Parameter Type Description
mailboxUrl java.net.URL The URL of mailbox
serverVersion int Exchange server versions

Returns: IEWSClient - Instance of the class based on the EWSClient class.

getEWSClient(String mailboxUri, System.Net.ICredentials credentials)

public static IEWSClient getEWSClient(String mailboxUri, System.Net.ICredentials credentials)

Initializes a new instance of the EWSClient based class

Parameters:

Parameter Type Description
mailboxUri java.lang.String The URI of mailbox
credentials com.aspose.ms.System.Net.ICredentials Contains the credentials for authentication.

Returns: IEWSClient - Instance of the class based on the EWSClient class.

getEWSClient(String mailboxUri, String username, String password)

public static IEWSClient getEWSClient(String mailboxUri, String username, String password)

Initializes a new instance of the EWSClient based class

Parameters:

Parameter Type Description
mailboxUri java.lang.String The URI of mailbox
username java.lang.String The username
password java.lang.String The password

Returns: IEWSClient - Instance of the class based on the EWSClient class.

getEWSClient(String mailboxUri, String username, String password, System.Net.WebProxy proxy)

public static IEWSClient getEWSClient(String mailboxUri, String username, String password, System.Net.WebProxy proxy)

Initializes a new instance of the EWSClient based class

Parameters:

Parameter Type Description
mailboxUri java.lang.String The URI of mailbox
username java.lang.String The username
password java.lang.String The password
proxy com.aspose.ms.System.Net.WebProxy Contains HTTP proxy settings

Returns: IEWSClient - Instance of the class based on the EWSClient class.

getEWSClient(String mailboxUri, String username, String password, String domain)

public static IEWSClient getEWSClient(String mailboxUri, String username, String password, String domain)

Initializes a new instance of the EWSClient based class

Parameters:

Parameter Type Description
mailboxUri java.lang.String The URI of mailbox
username java.lang.String The username
password java.lang.String The password
domain java.lang.String The domain name

Returns: IEWSClient - Instance of the class based on the EWSClient class.

getEWSClient(String mailboxUri, String username, String password, String domain, System.Net.WebProxy proxy)

public static IEWSClient getEWSClient(String mailboxUri, String username, String password, String domain, System.Net.WebProxy proxy)

Initializes a new instance of the EWSClient based class

Parameters:

Parameter Type Description
mailboxUri java.lang.String The URI of mailbox
username java.lang.String The username
password java.lang.String The password
domain java.lang.String The domain name
proxy com.aspose.ms.System.Net.WebProxy Contains HTTP proxy settings

Returns: IEWSClient - Instance of the class based on the EWSClient class.

getEWSClient(int serverVersion, String mailboxUri, System.Net.ICredentials credentials, System.Net.WebProxy proxy)

public static IEWSClient getEWSClient(int serverVersion, String mailboxUri, System.Net.ICredentials credentials, System.Net.WebProxy proxy)

Initializes a new instance of the EWSClient based class

Parameters:

Parameter Type Description
serverVersion int Exchange server versions
mailboxUri java.lang.String The URI of mailbox
credentials com.aspose.ms.System.Net.ICredentials Contains the credentials for authentication.
proxy com.aspose.ms.System.Net.WebProxy Contains HTTP proxy settings

Returns: IEWSClient - Instance of the class based on the EWSClient class.

getEWSClient(int serverVersion, boolean formbasedAuthenticationRequired, String formbasedAuthenticationLocation, String mailboxUri, System.Net.ICredentials credentials, System.Net.WebProxy proxy)

public static IEWSClient getEWSClient(int serverVersion, boolean formbasedAuthenticationRequired, String formbasedAuthenticationLocation, String mailboxUri, System.Net.ICredentials credentials, System.Net.WebProxy proxy)

Initializes a new instance of the EWSClient based class

Parameters:

Parameter Type Description
serverVersion int Exchange server versions
formbasedAuthenticationRequired boolean Set true if form-based authentication is required, otherwise set false.
formbasedAuthenticationLocation java.lang.String url for form-based authentication
mailboxUri java.lang.String The URI of mailbox
credentials com.aspose.ms.System.Net.ICredentials Contains the credentials for authentication.
proxy com.aspose.ms.System.Net.WebProxy Contains HTTP proxy settings

Returns: IEWSClient - Instance of the class based on the EWSClient class.

getEWSClient(String mailboxUri, System.Net.ICredentials credentials, System.Net.WebProxy proxy)

public static IEWSClient getEWSClient(String mailboxUri, System.Net.ICredentials credentials, System.Net.WebProxy proxy)

Initializes a new instance of the EWSClient based class

Parameters:

Parameter Type Description
mailboxUri java.lang.String The URI of mailbox
credentials com.aspose.ms.System.Net.ICredentials Contains the credentials for authentication.
proxy com.aspose.ms.System.Net.WebProxy Contains HTTP proxy settings

Returns: IEWSClient - Instance of the class based on the EWSClient class.

getEWSClient(String mailboxUri, System.Net.ICredentials credentials, System.Net.WebProxy proxy, int timeout)

public static IEWSClient getEWSClient(String mailboxUri, System.Net.ICredentials credentials, System.Net.WebProxy proxy, int timeout)

Initializes a new instance of the EWSClient based class

Parameters:

Parameter Type Description
mailboxUri java.lang.String The URI of mailbox
credentials com.aspose.ms.System.Net.ICredentials Contains the credentials for authentication.
proxy com.aspose.ms.System.Net.WebProxy Contains HTTP proxy settings
timeout int Sets the number of milliseconds to wait before the operation times out.

Returns: IEWSClient - Instance of the class based on the EWSClient class.

getNotificationTimeout()

public int getNotificationTimeout()

getNotificationTimeout.

Returns: int - a int.

setNotificationTimeout(int value)

public void setNotificationTimeout(int value)

setNotificationTimeout.

Parameters:

Parameter Type Description
value int a int.

getNotificationsCheckInterval()

public int getNotificationsCheckInterval()

getNotificationsCheckInterval.

Returns: int - a int.

setNotificationsCheckInterval(int value)

public void setNotificationsCheckInterval(int value)

setNotificationsCheckInterval.

Parameters:

Parameter Type Description
value int a int.

getRootFolderEventFilter()

public int getRootFolderEventFilter()

getRootFolderEventFilter.

Returns: int - a int.

setRootFolderEventFilter(int value)

public void setRootFolderEventFilter(int value)

setRootFolderEventFilter.

Parameters:

Parameter Type Description
value int a int.

getCalendarFolderEventFilter()

public int getCalendarFolderEventFilter()

getCalendarFolderEventFilter.

Returns: int - a int.

setCalendarFolderEventFilter(int value)

public void setCalendarFolderEventFilter(int value)

setCalendarFolderEventFilter.

Parameters:

Parameter Type Description
value int a int.

getContactsFolderEventFilter()

public int getContactsFolderEventFilter()

getContactsFolderEventFilter.

Returns: int - a int.

setContactsFolderEventFilter(int value)

public void setContactsFolderEventFilter(int value)

setContactsFolderEventFilter.

Parameters:

Parameter Type Description
value int a int.

getDeletedItemsFolderEventFilter()

public int getDeletedItemsFolderEventFilter()

getDeletedItemsFolderEventFilter.

Returns: int - a int.

setDeletedItemsFolderEventFilter(int value)

public void setDeletedItemsFolderEventFilter(int value)

setDeletedItemsFolderEventFilter.

Parameters:

Parameter Type Description
value int a int.

getDraftsFolderEventFilter()

public int getDraftsFolderEventFilter()

getDraftsFolderEventFilter.

Returns: int - a int.

setDraftsFolderEventFilter(int value)

public void setDraftsFolderEventFilter(int value)

setDraftsFolderEventFilter.

Parameters:

Parameter Type Description
value int a int.

getInboxFolderEventFilter()

public int getInboxFolderEventFilter()

getInboxFolderEventFilter.

Returns: int - a int.

setInboxFolderEventFilter(int value)

public void setInboxFolderEventFilter(int value)

setInboxFolderEventFilter.

Parameters:

Parameter Type Description
value int a int.

getJournalFolderEventFilter()

public int getJournalFolderEventFilter()

getJournalFolderEventFilter.

Returns: int - a int.

setJournalFolderEventFilter(int value)

public void setJournalFolderEventFilter(int value)

setJournalFolderEventFilter.

Parameters:

Parameter Type Description
value int a int.

getNotesFolderEventFilter()

public int getNotesFolderEventFilter()

getNotesFolderEventFilter.

Returns: int - a int.

setNotesFolderEventFilter(int value)

public void setNotesFolderEventFilter(int value)

setNotesFolderEventFilter.

Parameters:

Parameter Type Description
value int a int.

getOutboxFolderEventFilter()

public int getOutboxFolderEventFilter()

getOutboxFolderEventFilter.

Returns: int - a int.

setOutboxFolderEventFilter(int value)

public void setOutboxFolderEventFilter(int value)

setOutboxFolderEventFilter.

Parameters:

Parameter Type Description
value int a int.

getSentItemsFolderEventFilter()

public int getSentItemsFolderEventFilter()

getSentItemsFolderEventFilter.

Returns: int - a int.

setSentItemsFolderEventFilter(int value)

public void setSentItemsFolderEventFilter(int value)

setSentItemsFolderEventFilter.

Parameters:

Parameter Type Description
value int a int.

getTasksFolderEventFilter()

public int getTasksFolderEventFilter()

getTasksFolderEventFilter.

Returns: int - a int.

setTasksFolderEventFilter(int value)

public void setTasksFolderEventFilter(int value)

setTasksFolderEventFilter.

Parameters:

Parameter Type Description
value int a int.

dispose()

public void dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.