EWSClient

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
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.
RootFolderServerNotifications	Occurs when arises specified event type for Root folder.
SentItemsFolderServerNotifications	Occurs when arises specified event type for SentItems folder.
TasksFolderServerNotifications	Occurs when arises specified event type for Tasks folder.

Methods

Method	Description
close()
disableSAAJCertificateValidation()	Disable SAAJ certificate validation
dispose()
equals(Object arg0)
getCalendarFolderEventFilter()	getCalendarFolderEventFilter.
getClass()
getContactsFolderEventFilter()	getContactsFolderEventFilter.
getCredentials()	Gets or sets the credentials
getDeletedItemsFolderEventFilter()	getDeletedItemsFolderEventFilter.
getDraftsFolderEventFilter()	getDraftsFolderEventFilter.
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(int serverVersion, String mailboxUri, System.Net.ICredentials credentials, System.Net.WebProxy proxy)	Initializes a new instance of the EWSClient based class
getEWSClient(int serverVersion, String mailboxUri, String username, String password)	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, 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
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(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
getInboxFolderEventFilter()	getInboxFolderEventFilter.
getJournalFolderEventFilter()	getJournalFolderEventFilter.
getLogFileName()	Gets or sets log file name
getMailboxUri()	Gets or sets the mailbox uri
getNotesFolderEventFilter()	getNotesFolderEventFilter.
getNotificationTimeout()	getNotificationTimeout.
getNotificationsCheckInterval()	getNotificationsCheckInterval.
getOutboxFolderEventFilter()	getOutboxFolderEventFilter.
getProxy()	Gets or sets the proxy.
getRootFolderEventFilter()	getRootFolderEventFilter.
getSentItemsFolderEventFilter()	getSentItemsFolderEventFilter.
getTasksFolderEventFilter()	getTasksFolderEventFilter.
getTimeout()	Gets or sets the number of milliseconds to wait before the operation times out.
getUseDateInLogFileName()	Gets or sets value which indicates if date has to be used in log file name.
hashCode()
listItemsWithChangeKey(boolean value)	Sets value indicating whether List Items result URI includes ChangeKey value.
notify()
notifyAll()
resetLogSettings()	Resets logging settings to default.
setCalendarFolderEventFilter(int value)	setCalendarFolderEventFilter.
setCommonLogFileName(String value)	Sets log file name for all sessions.
setContactsFolderEventFilter(int value)	setContactsFolderEventFilter.
setCredentials(System.Net.ICredentials value)	Gets or sets the credentials
setDeletedItemsFolderEventFilter(int value)	setDeletedItemsFolderEventFilter.
setDraftsFolderEventFilter(int value)	setDraftsFolderEventFilter.
setInboxFolderEventFilter(int value)	setInboxFolderEventFilter.
setJournalFolderEventFilter(int value)	setJournalFolderEventFilter.
setLogFileName(String value)	Gets or sets log file name
setMailboxUri(String value)	Gets or sets the mailbox uri
setNotesFolderEventFilter(int value)	setNotesFolderEventFilter.
setNotificationTimeout(int value)	setNotificationTimeout.
setNotificationsCheckInterval(int value)	setNotificationsCheckInterval.
setOutboxFolderEventFilter(int value)	setOutboxFolderEventFilter.
setProxy(System.Net.WebProxy value)	Gets or sets the proxy.
setRootFolderEventFilter(int value)	setRootFolderEventFilter.
setSentItemsFolderEventFilter(int value)	setSentItemsFolderEventFilter.
setTasksFolderEventFilter(int value)	setTasksFolderEventFilter.
setTimeout(int value)	Gets or sets the number of milliseconds to wait before the operation times out.
setUseDateInLogFileName(boolean value)	Gets or sets value which indicates if date has to be used in log file name.
toString()
useOAUTHImpersonation(boolean value)	Sets value indicating whether OAUTH2 Impersonation is used.
useSAAJAPI(boolean value)	Sets value indicating whether SAAJ is used.
wait()
wait(long arg0)
wait(long arg0, int arg1)

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.

RootFolderServerNotifications

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

Occurs when arises specified event type for Root 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.

close()

public void close()

disableSAAJCertificateValidation()

public static void disableSAAJCertificateValidation()

Disable SAAJ certificate validation

dispose()

public void dispose()

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

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getCalendarFolderEventFilter()

public int getCalendarFolderEventFilter()

getCalendarFolderEventFilter.

Returns: int - a int.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getContactsFolderEventFilter()

public int getContactsFolderEventFilter()

getContactsFolderEventFilter.

Returns: int - a int.

getCredentials()

public System.Net.ICredentials getCredentials()

Gets or sets the credentials

Value: ICredentials

Returns: com.aspose.ms.System.Net.ICredentials

getDeletedItemsFolderEventFilter()

public int getDeletedItemsFolderEventFilter()

getDeletedItemsFolderEventFilter.

Returns: int - a int.

getDraftsFolderEventFilter()

public int getDraftsFolderEventFilter()

getDraftsFolderEventFilter.

Returns: int - a int.

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(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, String mailboxUri, String username, String password)

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

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
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, 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, 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.

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(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.

getInboxFolderEventFilter()

public int getInboxFolderEventFilter()

getInboxFolderEventFilter.

Returns: int - a int.

getJournalFolderEventFilter()

public int getJournalFolderEventFilter()

getJournalFolderEventFilter.

Returns: int - a int.

getLogFileName()

public final String getLogFileName()

Gets or sets log file name

Returns: java.lang.String

getMailboxUri()

public String getMailboxUri()

Gets or sets the mailbox uri

Value: Uri of the mailbox

Returns: java.lang.String

getNotesFolderEventFilter()

public int getNotesFolderEventFilter()

getNotesFolderEventFilter.

Returns: int - a int.

getNotificationTimeout()

public int getNotificationTimeout()

getNotificationTimeout.

Returns: int - a int.

getNotificationsCheckInterval()

public int getNotificationsCheckInterval()

getNotificationsCheckInterval.

Returns: int - a int.

getOutboxFolderEventFilter()

public int getOutboxFolderEventFilter()

getOutboxFolderEventFilter.

Returns: int - a int.

getProxy()

public System.Net.WebProxy getProxy()

Gets or sets the proxy.

Returns: com.aspose.ms.System.Net.WebProxy

getRootFolderEventFilter()

public int getRootFolderEventFilter()

getRootFolderEventFilter.

Returns: int - a int.

getSentItemsFolderEventFilter()

public int getSentItemsFolderEventFilter()

getSentItemsFolderEventFilter.

Returns: int - a int.

getTasksFolderEventFilter()

public int getTasksFolderEventFilter()

getTasksFolderEventFilter.

Returns: int - a int.

getTimeout()

public int getTimeout()

Gets or sets the number of milliseconds to wait before the operation times out. The default value is 100,000 milliseconds (100 seconds).

Value: Timeout in milliseconds

Returns: int

getUseDateInLogFileName()

public final boolean getUseDateInLogFileName()

Gets or sets value which indicates if date has to be used in log file name.

Returns: boolean

hashCode()

public native int hashCode()

Returns: int

listItemsWithChangeKey(boolean value)

public static void listItemsWithChangeKey(boolean value)

Sets value indicating whether List Items result URI includes ChangeKey value.

Parameters:

Parameter	Type	Description
value	boolean	True if ChangeKey included to URI.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

resetLogSettings()

public final void resetLogSettings()

Resets logging settings to default.

setCalendarFolderEventFilter(int value)

public void setCalendarFolderEventFilter(int value)

setCalendarFolderEventFilter.

Parameters:

Parameter	Type	Description
value	int	a int.

setCommonLogFileName(String value)

public static void setCommonLogFileName(String value)

Sets log file name for all sessions.

Parameters:

Parameter	Type	Description
value	java.lang.String	The log file name.

setContactsFolderEventFilter(int value)

public void setContactsFolderEventFilter(int value)

setContactsFolderEventFilter.

Parameters:

Parameter	Type	Description
value	int	a int.

setCredentials(System.Net.ICredentials value)

public void setCredentials(System.Net.ICredentials value)

Gets or sets the credentials

Value: ICredentials

Parameters:

Parameter	Type	Description
value	com.aspose.ms.System.Net.ICredentials

setDeletedItemsFolderEventFilter(int value)

public void setDeletedItemsFolderEventFilter(int value)

setDeletedItemsFolderEventFilter.

Parameters:

Parameter	Type	Description
value	int	a int.

setDraftsFolderEventFilter(int value)

public void setDraftsFolderEventFilter(int value)

setDraftsFolderEventFilter.

Parameters:

Parameter	Type	Description
value	int	a int.

setInboxFolderEventFilter(int value)

public void setInboxFolderEventFilter(int value)

setInboxFolderEventFilter.

Parameters:

Parameter	Type	Description
value	int	a int.

setJournalFolderEventFilter(int value)

public void setJournalFolderEventFilter(int value)

setJournalFolderEventFilter.

Parameters:

Parameter	Type	Description
value	int	a int.

setLogFileName(String value)

public final void setLogFileName(String value)

Gets or sets log file name

Parameters:

Parameter	Type	Description
value	java.lang.String

setMailboxUri(String value)

public void setMailboxUri(String value)

Gets or sets the mailbox uri

Value: Uri of the mailbox

Parameters:

Parameter	Type	Description
value	java.lang.String

setNotesFolderEventFilter(int value)

public void setNotesFolderEventFilter(int value)

setNotesFolderEventFilter.

Parameters:

Parameter	Type	Description
value	int	a int.

setNotificationTimeout(int value)

public void setNotificationTimeout(int value)

setNotificationTimeout.

Parameters:

Parameter	Type	Description
value	int	a int.

setNotificationsCheckInterval(int value)

public void setNotificationsCheckInterval(int value)

setNotificationsCheckInterval.

Parameters:

Parameter	Type	Description
value	int	a int.

setOutboxFolderEventFilter(int value)

public void setOutboxFolderEventFilter(int value)

setOutboxFolderEventFilter.

Parameters:

Parameter	Type	Description
value	int	a int.

setProxy(System.Net.WebProxy value)

public void setProxy(System.Net.WebProxy value)

Gets or sets the proxy.

Parameters:

Parameter	Type	Description
value	com.aspose.ms.System.Net.WebProxy

setRootFolderEventFilter(int value)

public void setRootFolderEventFilter(int value)

setRootFolderEventFilter.

Parameters:

Parameter	Type	Description
value	int	a int.

setSentItemsFolderEventFilter(int value)

public void setSentItemsFolderEventFilter(int value)

setSentItemsFolderEventFilter.

Parameters:

Parameter	Type	Description
value	int	a int.

setTasksFolderEventFilter(int value)

public void setTasksFolderEventFilter(int value)

setTasksFolderEventFilter.

Parameters:

Parameter	Type	Description
value	int	a int.

setTimeout(int value)

public void setTimeout(int value)

Gets or sets the number of milliseconds to wait before the operation times out. The default value is 100,000 milliseconds (100 seconds).

Value: Timeout in milliseconds

Parameters:

Parameter	Type	Description
value	int

setUseDateInLogFileName(boolean value)

public final void setUseDateInLogFileName(boolean value)

Gets or sets value which indicates if date has to be used in log file name.

Parameters:

Parameter	Type	Description
value	boolean

toString()

public String toString()

Returns: java.lang.String

useOAUTHImpersonation(boolean value)

public static void useOAUTHImpersonation(boolean value)

Sets value indicating whether OAUTH2 Impersonation is used.

Parameters:

Parameter	Type	Description
value	boolean	True if OAUTH2 Impersonation should be used.

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.

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int