AutodiscoverService

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

public final class AutodiscoverService extends AutodiscoverServiceBase

Represents a binding to the Exchange Autodiscover Service.

Constructors

Constructor Description
AutodiscoverService() Initializes a new instance of the AutodiscoverService class.
AutodiscoverService(Integer requestedServerVersion) Initializes a new instance of the AutodiscoverService class.
AutodiscoverService(String domain) Initializes a new instance of the AutodiscoverService class.
AutodiscoverService(String domain, Integer requestedServerVersion) Initializes a new instance of the AutodiscoverService class.
AutodiscoverService(URI url) Initializes a new instance of the AutodiscoverService class.
AutodiscoverService(URI url, Integer requestedServerVersion) Initializes a new instance of the AutodiscoverService class.

Fields

Field Description
OnSerializeCustomSoapHeaders

Methods

Method Description
equals(Object arg0)
getAcceptGzipEncoding() Gets or sets a value indicating whether GZip compression encoding should be accepted.
getClass()
getClientRequestId() Gets or sets the request id for the request.
getConnectionGroupName() Gets or sets the name of the connection group for the request.
getCookieContainer() Gets or sets the cookie container.
getCredentials() Gets or sets the credentials used to authenticate with the Exchange Web Services.
getDomain() Gets or sets the domain this service is bound to.
getEnableScpLookup() Gets or sets a value indicating whether the AutodiscoverService should perform SCP (ServiceConnectionPoint) record lookup when determining the Autodiscover service URL.
getHttpHeaders() Gets a collection of HTTP headers that will be sent with each request to EWS.
getHttpResponseHeaders() Gets a collection of HTTP headers from the last response.
getKeepAlive() Gets or sets if the request to the internet resource should contain a Connection HTTP header with the value Keep-alive
getLogFileName() Gets or sets log file name
getPreAuthenticate() Gets or sets a value that indicates whether HTTP pre-authentication should be performed.
getRedirectionUrlValidationCallback() Gets or sets the redirection URL validation callback.
getRequestedServerVersion() Gets the requested server version.
getReturnClientRequestId() Gets or sets a flag to indicate whether the client requires the server side to return the request id.
getSendClientLatencies() Gets or sets a value indicating whether client latency info is push to server.
getServerInfo() Gets information associated with the server that processed the last request.
getTimeout() Gets or sets the timeout used when sending HTTP requests and when receiving HTTP responses, in milliseconds.
getUrl() Gets or sets the URL this service is bound to.
getUseDateInLogFileName() Gets or sets value which indicates if date has to be used in log file name.
getUseDefaultCredentials() Gets or sets a value indicating whether the credentials of the user currently logged into Windows should be used to authenticate with the Exchange Web Services.
getUserAgent() Gets or sets the user agent.
getUserSettings(String userSmtpAddress, Integer[] userSettingNames) Retrieves the specified settings for single SMTP address.
getUsersSettings(System.Collections.Generic.IGenericEnumerable userSmtpAddresses, Integer[] userSettingNames) Retrieves the specified settings for a set of users.
getWebProxy() Gets or sets the web proxy that should be used when sending requests to EWS.
hashCode()
isExternal() Gets a value indicating whether the Autodiscover service that URL points to is internal (inside the corporate network) or external (outside the corporate network).
notify()
notifyAll()
setAcceptGzipEncoding(boolean value) Gets or sets a value indicating whether GZip compression encoding should be accepted.
setClientRequestId(String value) Gets or sets the request id for the request.
setConnectionGroupName(String value) Gets or sets the name of the connection group for the request.
setCookieContainer(System.Net.CookieContainer value) Gets or sets the cookie container.
setCredentials(System.Net.ICredentials value) Gets or sets the credentials used to authenticate with the Exchange Web Services.
setDomain(String value) Gets or sets the domain this service is bound to.
setEnableScpLookup(boolean value) Gets or sets a value indicating whether the AutodiscoverService should perform SCP (ServiceConnectionPoint) record lookup when determining the Autodiscover service URL.
setKeepAlive(boolean value) Gets or sets if the request to the internet resource should contain a Connection HTTP header with the value Keep-alive
setLogFileName(String value) Gets or sets log file name
setPreAuthenticate(boolean value) Gets or sets a value that indicates whether HTTP pre-authentication should be performed.
setRedirectionUrlValidationCallback(AutodiscoverRedirectionUrlValidationCallback value) Gets or sets the redirection URL validation callback.
setReturnClientRequestId(boolean value) Gets or sets a flag to indicate whether the client requires the server side to return the request id.
setSendClientLatencies(boolean value) Gets or sets a value indicating whether client latency info is push to server.
setTimeout(int value) Gets or sets the timeout used when sending HTTP requests and when receiving HTTP responses, in milliseconds.
setUrl(URI value) Gets or sets the URL this service is bound to.
setUseDateInLogFileName(boolean value) Gets or sets value which indicates if date has to be used in log file name.
setUseDefaultCredentials(boolean value) Gets or sets a value indicating whether the credentials of the user currently logged into Windows should be used to authenticate with the Exchange Web Services.
setUserAgent(String value) Gets or sets the user agent.
setWebProxy(System.Net.IWebProxy value) Gets or sets the web proxy that should be used when sending requests to EWS.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

AutodiscoverService()

public AutodiscoverService()

Initializes a new instance of the AutodiscoverService class.

AutodiscoverService(Integer requestedServerVersion)

public AutodiscoverService(Integer requestedServerVersion)

Initializes a new instance of the AutodiscoverService class.

Parameters:

Parameter Type Description
requestedServerVersion java.lang.Integer The requested server version.

AutodiscoverService(String domain)

public AutodiscoverService(String domain)

Initializes a new instance of the AutodiscoverService class.

Parameters:

Parameter Type Description
domain java.lang.String The domain that will be used to determine the URL of the service.

AutodiscoverService(String domain, Integer requestedServerVersion)

public AutodiscoverService(String domain, Integer requestedServerVersion)

Initializes a new instance of the AutodiscoverService class.

Parameters:

Parameter Type Description
domain java.lang.String The domain that will be used to determine the URL of the service.
requestedServerVersion java.lang.Integer The requested server version.

AutodiscoverService(URI url)

public AutodiscoverService(URI url)

Initializes a new instance of the AutodiscoverService class.

Parameters:

Parameter Type Description
url java.net.URI The URL of the service.

AutodiscoverService(URI url, Integer requestedServerVersion)

public AutodiscoverService(URI url, Integer requestedServerVersion)

Initializes a new instance of the AutodiscoverService class.

Parameters:

Parameter Type Description
url java.net.URI The URL of the service.
requestedServerVersion java.lang.Integer The requested server version.

OnSerializeCustomSoapHeaders

public final Event<AutodiscoverServiceBase.CustomXmlSerializationDelegate> OnSerializeCustomSoapHeaders

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter Type Description
arg0 java.lang.Object

Returns: boolean

getAcceptGzipEncoding()

public final boolean getAcceptGzipEncoding()

Gets or sets a value indicating whether GZip compression encoding should be accepted.


This value will tell the server that the client is able to handle GZip compression encoding. The server will only send Gzip compressed content if it has been configured to do so.

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getClientRequestId()

public final String getClientRequestId()

Gets or sets the request id for the request.

Returns: java.lang.String

getConnectionGroupName()

public final String getConnectionGroupName()

Gets or sets the name of the connection group for the request.

Returns: java.lang.String

getCookieContainer()

public final System.Net.CookieContainer getCookieContainer()

Gets or sets the cookie container.

Value: The cookie container.

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

getCredentials()

public final System.Net.ICredentials getCredentials()

Gets or sets the credentials used to authenticate with the Exchange Web Services. Setting the Credentials property automatically sets the UseDefaultCredentials to false.

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

getDomain()

public final String getDomain()

Gets or sets the domain this service is bound to. When this property is set, the domain name is used to automatically determine the Autodiscover service URL.

Returns: java.lang.String

getEnableScpLookup()

public final boolean getEnableScpLookup()

Gets or sets a value indicating whether the AutodiscoverService should perform SCP (ServiceConnectionPoint) record lookup when determining the Autodiscover service URL.

Returns: boolean

getHttpHeaders()

public final System.Collections.Generic.IGenericDictionary<String,String> getHttpHeaders()

Gets a collection of HTTP headers that will be sent with each request to EWS.

Returns: com.aspose.ms.System.Collections.Generic.IGenericDictionary<java.lang.String,java.lang.String>

getHttpResponseHeaders()

public final System.Collections.Generic.IGenericDictionary<String,String> getHttpResponseHeaders()

Gets a collection of HTTP headers from the last response.

Returns: com.aspose.ms.System.Collections.Generic.IGenericDictionary<java.lang.String,java.lang.String>

getKeepAlive()

public final boolean getKeepAlive()

Gets or sets if the request to the internet resource should contain a Connection HTTP header with the value Keep-alive

Returns: boolean

getLogFileName()

public final String getLogFileName()

Gets or sets log file name

Returns: java.lang.String

getPreAuthenticate()

public final boolean getPreAuthenticate()

Gets or sets a value that indicates whether HTTP pre-authentication should be performed.

Returns: boolean

getRedirectionUrlValidationCallback()

public final AutodiscoverRedirectionUrlValidationCallback getRedirectionUrlValidationCallback()

Gets or sets the redirection URL validation callback.

Value: The redirection URL validation callback.

Returns: AutodiscoverRedirectionUrlValidationCallback

getRequestedServerVersion()

public final int getRequestedServerVersion()

Gets the requested server version.

Value: The requested server version.

Returns: int

getReturnClientRequestId()

public final boolean getReturnClientRequestId()

Gets or sets a flag to indicate whether the client requires the server side to return the request id.

Returns: boolean

getSendClientLatencies()

public final boolean getSendClientLatencies()

Gets or sets a value indicating whether client latency info is push to server.

Returns: boolean

getServerInfo()

public final ServerVersionInfo getServerInfo()

Gets information associated with the server that processed the last request. Will be null if no requests have been processed.

Returns: com.microsoft.schemas.exchange.services._2006.types.ServerVersionInfo

getTimeout()

public final int getTimeout()

Gets or sets the timeout used when sending HTTP requests and when receiving HTTP responses, in milliseconds. Defaults to 100000.

Returns: int

getUrl()

public final URI getUrl()

Gets or sets the URL this service is bound to.

Returns: java.net.URI

getUseDateInLogFileName()

public final boolean getUseDateInLogFileName()

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

Returns: boolean

getUseDefaultCredentials()

public final boolean getUseDefaultCredentials()

Gets or sets a value indicating whether the credentials of the user currently logged into Windows should be used to authenticate with the Exchange Web Services. Setting UseDefaultCredentials to true automatically sets the Credentials property to null.

Returns: boolean

getUserAgent()

public final String getUserAgent()

Gets or sets the user agent.

Value: The user agent.

Returns: java.lang.String

getUserSettings(String userSmtpAddress, Integer[] userSettingNames)

public final GetUserSettingsResponse getUserSettings(String userSmtpAddress, Integer[] userSettingNames)

Retrieves the specified settings for single SMTP address.

Parameters:

Parameter Type Description
userSmtpAddress java.lang.String The SMTP addresses of the user.
userSettingNames java.lang.Integer[] The user setting names.

This method handles will run the entire Autodiscover “discovery” algorithm and will follow address and URL redirections. |

Returns: GetUserSettingsResponse - A UserResponse object containing the requested settings for the specified user.

getUsersSettings(System.Collections.Generic.IGenericEnumerable userSmtpAddresses, Integer[] userSettingNames)

public final GetUserSettingsResponseCollection getUsersSettings(System.Collections.Generic.IGenericEnumerable<String> userSmtpAddresses, Integer[] userSettingNames)

Retrieves the specified settings for a set of users.

Parameters:

Parameter Type Description
userSmtpAddresses com.aspose.ms.System.Collections.Generic.IGenericEnumerable<java.lang.String> The SMTP addresses of the users.
userSettingNames java.lang.Integer[] The user setting names.

Returns: GetUserSettingsResponseCollection - A GetUserSettingsResponseCollection object containing the responses for each individual user.

getWebProxy()

public final System.Net.IWebProxy getWebProxy()

Gets or sets the web proxy that should be used when sending requests to EWS. Set this property to null to use the default web proxy.

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

hashCode()

public native int hashCode()

Returns: int

isExternal()

public final Boolean isExternal()

Gets a value indicating whether the Autodiscover service that URL points to is internal (inside the corporate network) or external (outside the corporate network).


IsExternal is null in the following cases: - This instance has been created with a domain name and no method has been called, - This instance has been created with a URL.

Returns: java.lang.Boolean

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAcceptGzipEncoding(boolean value)

public final void setAcceptGzipEncoding(boolean value)

Gets or sets a value indicating whether GZip compression encoding should be accepted.


This value will tell the server that the client is able to handle GZip compression encoding. The server will only send Gzip compressed content if it has been configured to do so.

Parameters:

Parameter Type Description
value boolean

setClientRequestId(String value)

public final void setClientRequestId(String value)

Gets or sets the request id for the request.

Parameters:

Parameter Type Description
value java.lang.String

setConnectionGroupName(String value)

public final void setConnectionGroupName(String value)

Gets or sets the name of the connection group for the request.

Parameters:

Parameter Type Description
value java.lang.String

setCookieContainer(System.Net.CookieContainer value)

public final void setCookieContainer(System.Net.CookieContainer value)

Gets or sets the cookie container.

Value: The cookie container.

Parameters:

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

setCredentials(System.Net.ICredentials value)

public final void setCredentials(System.Net.ICredentials value)

Gets or sets the credentials used to authenticate with the Exchange Web Services. Setting the Credentials property automatically sets the UseDefaultCredentials to false.

Parameters:

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

setDomain(String value)

public final void setDomain(String value)

Gets or sets the domain this service is bound to. When this property is set, the domain name is used to automatically determine the Autodiscover service URL.

Parameters:

Parameter Type Description
value java.lang.String

setEnableScpLookup(boolean value)

public final void setEnableScpLookup(boolean value)

Gets or sets a value indicating whether the AutodiscoverService should perform SCP (ServiceConnectionPoint) record lookup when determining the Autodiscover service URL.

Parameters:

Parameter Type Description
value boolean

setKeepAlive(boolean value)

public final void setKeepAlive(boolean value)

Gets or sets if the request to the internet resource should contain a Connection HTTP header with the value Keep-alive

Parameters:

Parameter Type Description
value boolean

setLogFileName(String value)

public final void setLogFileName(String value)

Gets or sets log file name

Parameters:

Parameter Type Description
value java.lang.String

setPreAuthenticate(boolean value)

public final void setPreAuthenticate(boolean value)

Gets or sets a value that indicates whether HTTP pre-authentication should be performed.

Parameters:

Parameter Type Description
value boolean

setRedirectionUrlValidationCallback(AutodiscoverRedirectionUrlValidationCallback value)

public final void setRedirectionUrlValidationCallback(AutodiscoverRedirectionUrlValidationCallback value)

Gets or sets the redirection URL validation callback.

Value: The redirection URL validation callback.

Parameters:

Parameter Type Description
value AutodiscoverRedirectionUrlValidationCallback

setReturnClientRequestId(boolean value)

public final void setReturnClientRequestId(boolean value)

Gets or sets a flag to indicate whether the client requires the server side to return the request id.

Parameters:

Parameter Type Description
value boolean

setSendClientLatencies(boolean value)

public final void setSendClientLatencies(boolean value)

Gets or sets a value indicating whether client latency info is push to server.

Parameters:

Parameter Type Description
value boolean

setTimeout(int value)

public final void setTimeout(int value)

Gets or sets the timeout used when sending HTTP requests and when receiving HTTP responses, in milliseconds. Defaults to 100000.

Parameters:

Parameter Type Description
value int

setUrl(URI value)

public final void setUrl(URI value)

Gets or sets the URL this service is bound to.

Parameters:

Parameter Type Description
value java.net.URI

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

setUseDefaultCredentials(boolean value)

public final void setUseDefaultCredentials(boolean value)

Gets or sets a value indicating whether the credentials of the user currently logged into Windows should be used to authenticate with the Exchange Web Services. Setting UseDefaultCredentials to true automatically sets the Credentials property to null.

Parameters:

Parameter Type Description
value boolean

setUserAgent(String value)

public final void setUserAgent(String value)

Gets or sets the user agent.

Value: The user agent.

Parameters:

Parameter Type Description
value java.lang.String

setWebProxy(System.Net.IWebProxy value)

public final void setWebProxy(System.Net.IWebProxy value)

Gets or sets the web proxy that should be used when sending requests to EWS. Set this property to null to use the default web proxy.

Parameters:

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

toString()

public String toString()

Returns: java.lang.String

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