Aspose::Email::Clients::Exchange::AutodiscoverService Class Referencefinal

Represents a binding to the Exchange Autodiscover Service. More...

Inherits Aspose::Email::Clients::Exchange::AutodiscoverServiceBase.

Public Types

template<typename T >
using Func = System::MulticastDelegate< T()>
 
template<typename T1 , typename T2 >
using FuncC = System::MulticastDelegate< T2(T1)>
 
- Public Types inherited from Aspose::Email::Clients::Exchange::AutodiscoverServiceBase
using CustomXmlSerializationDelegate = System::MulticastDelegate< void(System::SharedPtr< System::Xml::XmlWriter >)>
 Defines a delegate that is used to allow applications to emit custom XML when SOAP requests are sent to Exchange. More...
 

Public Member Functions

System::String get_Domain () const
 Gets the domain this service is bound to. When this property is set, the domain name is used to automatically determine the Autodiscover service URL. More...
 
void set_Domain (System::String value)
 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. More...
 
System::SharedPtr< System::Uri > get_Url () const
 Gets the URL this service is bound to. More...
 
void set_Url (System::SharedPtr< System::Uri > value)
 Sets the URL this service is bound to. More...
 
System::Nullable< bool > get_IsExternal () const
 Gets a value indicating whether the Autodiscover service that URL points to is internal (inside the corporate network) or external (outside the corporate network). More...
 
void set_IsExternal (System::Nullable< bool > value)
 Gets a value indicating whether the Autodiscover service that URL points to is internal (inside the corporate network) or external (outside the corporate network). More...
 
AutodiscoverRedirectionUrlValidationCallback get_RedirectionUrlValidationCallback () const
 Gets the redirection URL validation callback. More...
 
void set_RedirectionUrlValidationCallback (AutodiscoverRedirectionUrlValidationCallback value)
 Sets the redirection URL validation callback. More...
 
System::SharedPtr< System::Net::IPAddress > get_DnsServerAddress () const
 Gets the DNS server address. More...
 
void set_DnsServerAddress (System::SharedPtr< System::Net::IPAddress > value)
 Sets the DNS server address. More...
 
bool get_EnableScpLookup () const
 Gets a value indicating whether the AutodiscoverService should perform SCP (ServiceConnectionPoint) record lookup when determining the Autodiscover service URL. More...
 
void set_EnableScpLookup (bool value)
 Sets a value indicating whether the AutodiscoverService should perform SCP (ServiceConnectionPoint) record lookup when determining the Autodiscover service URL. More...
 
AutodiscoverService::FuncC< System::String, System::SharedPtr< System::Collections::Generic::ICollection< System::String > > > get_GetScpUrlsForDomainCallback () const
 Gets the delegate used to resolve Autodiscover SCP urls for a specified domain. More...
 
void set_GetScpUrlsForDomainCallback (AutodiscoverService::FuncC< System::String, System::SharedPtr< System::Collections::Generic::ICollection< System::String >>> value)
 Sets the delegate used to resolve Autodiscover SCP urls for a specified domain. More...
 
template<typename TSettings >
TSettings GetLegacyUserSettings (System::String emailAddress)
 Calls the legacy Autodiscover service to retrieve configuration settings. More...
 
System::SharedPtr< System::Uri > GetRedirectionUrlFromDnsSrvRecord (System::String domainName)
 Get an autodiscover SRV record in DNS and construct autodiscover URL. More...
 
System::SharedPtr< GetUserSettingsResponseInternalGetLegacyUserSettings (System::String emailAddress, System::SharedPtr< System::Collections::Generic::ListExt< UserSettingName >> requestedSettings)
 Gets user settings from Autodiscover legacy endpoint. More...
 
System::SharedPtr< GetUserSettingsResponseInternalGetSoapUserSettings (System::String smtpAddress, System::SharedPtr< System::Collections::Generic::ListExt< UserSettingName >> requestedSettings)
 Calls the SOAP Autodiscover service for user settings for a single SMTP address. More...
 
System::SharedPtr< GetUserSettingsResponseCollectionGetUserSettings (System::SharedPtr< System::Collections::Generic::ListExt< System::String >> smtpAddresses, System::SharedPtr< System::Collections::Generic::ListExt< UserSettingName >> settings)
 Gets the user settings using Autodiscover SOAP service. More...
 
System::SharedPtr< GetDomainSettingsResponseCollection > GetDomainSettings (System::SharedPtr< System::Collections::Generic::ListExt< System::String >> domains, System::SharedPtr< System::Collections::Generic::ListExt< DomainSettingName >> settings, System::Nullable< WebService::ExchangeVersion > requestedVersion)
 Gets the domain settings using Autodiscover SOAP service. More...
 
System::SharedPtr< System::Collections::Generic::ListExt< System::SharedPtr< System::Uri > > > GetAutodiscoverServiceUrls (System::String domainName, int32_t &scpHostCount)
 Gets the list of autodiscover service URLs. More...
 
System::SharedPtr< System::Collections::Generic::ListExt< System::String > > GetAutodiscoverServiceHosts (System::String domainName, int32_t &scpHostCount)
 Gets the list of autodiscover service hosts. More...
 
void TraceResponse (System::SharedPtr< System::Net::HttpWebResponse > response, System::SharedPtr< System::IO::MemoryStream > memoryStream)
 Traces the response. More...
 
System::SharedPtr< System::Net::HttpWebRequest > PrepareHttpWebRequestForUrl (System::SharedPtr< System::Uri > url)
 Creates an HttpWebRequest instance and initializes it with the appropriate parameters, based on the configuration of this service object. More...
 
void ProcessHttpErrorResponse (System::SharedPtr< System::Net::HttpWebResponse > httpWebResponse, System::Net::WebException webException)
 Processes an HTTP error response. More...
 
 AutodiscoverService ()
 Initializes a new instance of the AutodiscoverService class. More...
 
 AutodiscoverService (WebService::ExchangeVersion requestedServerVersion)
 Initializes a new instance of the AutodiscoverService class. More...
 
 AutodiscoverService (System::String domain)
 Initializes a new instance of the AutodiscoverService class. More...
 
 AutodiscoverService (System::String domain, WebService::ExchangeVersion requestedServerVersion)
 Initializes a new instance of the AutodiscoverService class. More...
 
 AutodiscoverService (System::SharedPtr< System::Uri > url)
 Initializes a new instance of the AutodiscoverService class. More...
 
 AutodiscoverService (System::SharedPtr< System::Uri > url, WebService::ExchangeVersion requestedServerVersion)
 Initializes a new instance of the AutodiscoverService class. More...
 
 AutodiscoverService (System::SharedPtr< System::Uri > url, System::String domain)
 Initializes a new instance of the AutodiscoverService class. More...
 
 AutodiscoverService (System::SharedPtr< System::Uri > url, System::String domain, WebService::ExchangeVersion requestedServerVersion)
 Initializes a new instance of the AutodiscoverService class. More...
 
System::SharedPtr< GetUserSettingsResponseGetUserSettings (System::String userSmtpAddress, const System::ArrayPtr< UserSettingName > &userSettingNames)
 Retrieves the specified settings for single SMTP address. More...
 
System::SharedPtr< GetUserSettingsResponseCollectionGetUsersSettings (System::SharedPtr< System::Collections::Generic::IEnumerable< System::String >> userSmtpAddresses, const System::ArrayPtr< UserSettingName > &userSettingNames)
 Retrieves the specified settings for a set of users. More...
 
System::SharedPtr< GetDomainSettingsResponse > GetDomainSettings (System::String domain, System::Nullable< WebService::ExchangeVersion > requestedVersion, const System::ArrayPtr< DomainSettingName > &domainSettingNames)
 Retrieves the specified settings for a domain. More...
 
System::SharedPtr< GetDomainSettingsResponseCollection > GetDomainSettings (System::SharedPtr< System::Collections::Generic::IEnumerable< System::String >> domains, System::Nullable< WebService::ExchangeVersion > requestedVersion, const System::ArrayPtr< DomainSettingName > &domainSettingNames)
 Retrieves the specified settings for a set of domains. More...
 
- Public Member Functions inherited from Aspose::Email::Clients::Exchange::AutodiscoverServiceBase
System::String get_LogFileName () const
 Gets log file name More...
 
void set_LogFileName (System::String value)
 Sets log file name More...
 
bool get_UseDateInLogFileName () const
 Gets value which indicates if date has to be used in log file name. More...
 
void set_UseDateInLogFileName (bool value)
 Sets value which indicates if date has to be used in log file name. More...
 
System::SharedPtr< Aspose::Email::Tools::Logging::Loggerget_Logger ()
 Diagnostic logger More...
 
System::SharedPtr< System::Net::CookieContainer > get_CookieContainer () const
 Gets the cookie container. More...
 
void set_CookieContainer (System::SharedPtr< System::Net::CookieContainer > value)
 Sets the cookie container. More...
 
System::SharedPtr< Aspose::Email::Common::TimeZone::Zone > get_TimeZone () const
 Gets the time zone this service is scoped to. More...
 
bool get_SendClientLatencies () const
 Gets a value indicating whether client latency info is push to server. More...
 
void set_SendClientLatencies (bool value)
 Sets a value indicating whether client latency info is push to server. More...
 
System::SharedPtr< System::Net::ICredentials > get_Credentials () const
 Gets the credentials used to authenticate with the Exchange Web Services. Setting the Credentials property automatically sets the UseDefaultCredentials to false. More...
 
void set_Credentials (System::SharedPtr< System::Net::ICredentials > value)
 Sets the credentials used to authenticate with the Exchange Web Services. Setting the Credentials property automatically sets the UseDefaultCredentials to false. More...
 
bool get_UseDefaultCredentials () const
 Gets 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. More...
 
void set_UseDefaultCredentials (bool value)
 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. More...
 
int32_t get_Timeout () const
 Gets the timeout used when sending HTTP requests and when receiving HTTP responses, in milliseconds. Defaults to 100000. More...
 
void set_Timeout (int32_t value)
 Sets the timeout used when sending HTTP requests and when receiving HTTP responses, in milliseconds. Defaults to 100000. More...
 
bool get_PreAuthenticate () const
 Gets a value that indicates whether HTTP pre-authentication should be performed. More...
 
void set_PreAuthenticate (bool value)
 Sets a value that indicates whether HTTP pre-authentication should be performed. More...
 
bool get_AcceptGzipEncoding () const
 Gets a value indicating whether GZip compression encoding should be accepted. More...
 
void set_AcceptGzipEncoding (bool value)
 Sets a value indicating whether GZip compression encoding should be accepted. More...
 
WebService::ExchangeVersion get_RequestedServerVersion () const
 Gets the requested server version. More...
 
System::String get_UserAgent () const
 Gets the user agent. More...
 
void set_UserAgent (System::String value)
 Sets the user agent. More...
 
System::SharedPtr< WebService::Schema_2016::ServerVersionInfo > get_ServerInfo () const
 Gets information associated with the server that processed the last request. Will be null if no requests have been processed. More...
 
void set_ServerInfo (System::SharedPtr< WebService::Schema_2016::ServerVersionInfo > value)
 Gets information associated with the server that processed the last request. Will be null if no requests have been processed. More...
 
System::SharedPtr< System::Net::IWebProxy > get_WebProxy () const
 Gets the web proxy that should be used when sending requests to EWS. Set this property to null to use the default web proxy. More...
 
void set_WebProxy (System::SharedPtr< System::Net::IWebProxy > value)
 Sets the web proxy that should be used when sending requests to EWS. Set this property to null to use the default web proxy. More...
 
bool get_KeepAlive () const
 Gets if the request to the internet resource should contain a Connection HTTP header with the value Keep-alive More...
 
void set_KeepAlive (bool value)
 Sets if the request to the internet resource should contain a Connection HTTP header with the value Keep-alive More...
 
System::String get_ConnectionGroupName () const
 Gets the name of the connection group for the request. More...
 
void set_ConnectionGroupName (System::String value)
 Sets the name of the connection group for the request. More...
 
System::String get_ClientRequestId () const
 Gets the request id for the request. More...
 
void set_ClientRequestId (System::String value)
 Sets the request id for the request. More...
 
bool get_ReturnClientRequestId () const
 Gets a flag to indicate whether the client requires the server side to return the request id. More...
 
void set_ReturnClientRequestId (bool value)
 Sets a flag to indicate whether the client requires the server side to return the request id. More...
 
System::SharedPtr< System::Collections::Generic::IDictionary< System::String, System::String > > get_HttpHeaders () const
 Gets a collection of HTTP headers that will be sent with each request to EWS. More...
 
System::SharedPtr< System::Collections::Generic::IDictionary< System::String, System::String > > get_HttpResponseHeaders () const
 Gets a collection of HTTP headers from the last response. More...
 
bool get_SuppressXmlVersionHeader () const
 For testing: suppresses generation of the SOAP version header. More...
 
void set_SuppressXmlVersionHeader (bool value)
 For testing: suppresses generation of the SOAP version header. More...
 
void DoOnSerializeCustomSoapHeaders (System::SharedPtr< System::Xml::XmlWriter > writer)
 Calls the custom SOAP header serialization event handlers, if defined. More...
 
System::SharedPtr< System::Net::HttpWebRequest > PrepareHttpWebRequestForUrl (System::SharedPtr< System::Uri > url, bool acceptGzipEncoding, bool allowAutoRedirect)
 Creates an HttpWebRequest instance and initializes it with the appropriate parameters, based on the configuration of this service object. More...
 
void SaveHttpResponseHeaders (System::SharedPtr< System::Net::WebHeaderCollection > headers)
 Save the HTTP response headers. More...
 
void InternalProcessHttpErrorResponse (System::SharedPtr< System::Net::HttpWebResponse > httpWebResponse, System::Net::WebException webException)
 Processes an HTTP error response More...
 
void Log (System::String message)
 Log message. More...
 
void Log (System::SharedPtr< System::Net::HttpWebRequest > request)
 Log message. More...
 
void Log (System::SharedPtr< System::Net::HttpWebResponse > webResponse)
 
void Log (System::SharedPtr< System::Net::HttpWebResponse > webResponse, System::SharedPtr< System::IO::MemoryStream > memoryStream)
 
void Log (System::SharedPtr< System::IO::MemoryStream > stream)
 
void initializeLogger ()
 

Static Public Member Functions

static void ValidateParam (System::SharedPtr< System::Object > param, System::String paramName)
 
static System::SharedPtr< System::Net::HttpWebResponse > CreateExceptionResponse (System::Net::WebException exception)
 
static void Assert (bool condition, System::String caller, System::String message)
 
- Static Public Member Functions inherited from Aspose::Email::Clients::Exchange::AutodiscoverServiceBase
static System::ArrayPtr< uint8_t > get_SessionKey ()
 Gets the session key. More...
 

Static Public Attributes

static const int32_t AutodiscoverMaxRedirections
 Maximum number of Url (or address) redirections that will be followed by an Autodiscover call More...
 
- Static Public Attributes inherited from Aspose::Email::Clients::Exchange::AutodiscoverServiceBase
static const System::Net::HttpStatusCode AccountIsLocked
 Special HTTP status code that indicates that the account is locked. More...
 

Protected Member Functions

virtual ~AutodiscoverService ()
 
- Protected Member Functions inherited from Aspose::Email::Clients::Exchange::AutodiscoverServiceBase
 AutodiscoverServiceBase ()
 Initializes a new instance of the AutodiscoverServiceBase class. More...
 
 AutodiscoverServiceBase (WebService::ExchangeVersion requestedServerVersion)
 Initializes a new instance of the AutodiscoverServiceBase class. More...
 

Friends

class Aspose::Email::Clients::Exchange::AutodiscoverRequest
 

Additional Inherited Members

- Public Attributes inherited from Aspose::Email::Clients::Exchange::AutodiscoverServiceBase
System::Event< void(System::SharedPtr< System::Xml::XmlWriter >)> OnSerializeCustomSoapHeaders
 Provides an event that applications can implement to emit custom SOAP headers in requests that are sent to Exchange. More...
 

Detailed Description

Represents a binding to the Exchange Autodiscover Service.

Member Typedef Documentation

◆ Func

template<typename T >
using Aspose::Email::Clients::Exchange::AutodiscoverService::Func = System::MulticastDelegate<T()>

◆ FuncC

template<typename T1 , typename T2 >
using Aspose::Email::Clients::Exchange::AutodiscoverService::FuncC = System::MulticastDelegate<T2(T1)>

Constructor & Destructor Documentation

◆ AutodiscoverService() [1/8]

Aspose::Email::Clients::Exchange::AutodiscoverService::AutodiscoverService ( )

Initializes a new instance of the AutodiscoverService class.

◆ AutodiscoverService() [2/8]

Aspose::Email::Clients::Exchange::AutodiscoverService::AutodiscoverService ( WebService::ExchangeVersion  requestedServerVersion)

Initializes a new instance of the AutodiscoverService class.

Parameters
requestedServerVersionThe requested server version.

◆ AutodiscoverService() [3/8]

Aspose::Email::Clients::Exchange::AutodiscoverService::AutodiscoverService ( System::String  domain)

Initializes a new instance of the AutodiscoverService class.

Parameters
domainThe domain that will be used to determine the URL of the service.

◆ AutodiscoverService() [4/8]

Aspose::Email::Clients::Exchange::AutodiscoverService::AutodiscoverService ( System::String  domain,
WebService::ExchangeVersion  requestedServerVersion 
)

Initializes a new instance of the AutodiscoverService class.

Parameters
domainThe domain that will be used to determine the URL of the service.
requestedServerVersionThe requested server version.

◆ AutodiscoverService() [5/8]

Aspose::Email::Clients::Exchange::AutodiscoverService::AutodiscoverService ( System::SharedPtr< System::Uri >  url)

Initializes a new instance of the AutodiscoverService class.

Parameters
urlThe URL of the service.

◆ AutodiscoverService() [6/8]

Aspose::Email::Clients::Exchange::AutodiscoverService::AutodiscoverService ( System::SharedPtr< System::Uri >  url,
WebService::ExchangeVersion  requestedServerVersion 
)

Initializes a new instance of the AutodiscoverService class.

Parameters
urlThe URL of the service.
requestedServerVersionThe requested server version.

◆ AutodiscoverService() [7/8]

Aspose::Email::Clients::Exchange::AutodiscoverService::AutodiscoverService ( System::SharedPtr< System::Uri >  url,
System::String  domain 
)

Initializes a new instance of the AutodiscoverService class.

Parameters
urlThe URL of the service.
domainThe domain that will be used to determine the URL of the service.

◆ AutodiscoverService() [8/8]

Aspose::Email::Clients::Exchange::AutodiscoverService::AutodiscoverService ( System::SharedPtr< System::Uri >  url,
System::String  domain,
WebService::ExchangeVersion  requestedServerVersion 
)

Initializes a new instance of the AutodiscoverService class.

Parameters
urlThe URL of the service.
domainThe domain that will be used to determine the URL of the service.
requestedServerVersionThe requested server version.

◆ ~AutodiscoverService()

virtual Aspose::Email::Clients::Exchange::AutodiscoverService::~AutodiscoverService ( )
protectedvirtual

Member Function Documentation

◆ Assert()

static void Aspose::Email::Clients::Exchange::AutodiscoverService::Assert ( bool  condition,
System::String  caller,
System::String  message 
)
static

◆ CreateExceptionResponse()

static System::SharedPtr<System::Net::HttpWebResponse> Aspose::Email::Clients::Exchange::AutodiscoverService::CreateExceptionResponse ( System::Net::WebException  exception)
static

◆ get_DnsServerAddress()

System::SharedPtr<System::Net::IPAddress> Aspose::Email::Clients::Exchange::AutodiscoverService::get_DnsServerAddress ( ) const

Gets the DNS server address.

The DNS server address.

◆ get_Domain()

System::String Aspose::Email::Clients::Exchange::AutodiscoverService::get_Domain ( ) const

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

◆ get_EnableScpLookup()

bool Aspose::Email::Clients::Exchange::AutodiscoverService::get_EnableScpLookup ( ) const

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

◆ get_GetScpUrlsForDomainCallback()

AutodiscoverService::FuncC<System::String, System::SharedPtr<System::Collections::Generic::ICollection<System::String> > > Aspose::Email::Clients::Exchange::AutodiscoverService::get_GetScpUrlsForDomainCallback ( ) const

Gets the delegate used to resolve Autodiscover SCP urls for a specified domain.

◆ get_IsExternal()

System::Nullable<bool> Aspose::Email::Clients::Exchange::AutodiscoverService::get_IsExternal ( ) const

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.

◆ get_RedirectionUrlValidationCallback()

AutodiscoverRedirectionUrlValidationCallback Aspose::Email::Clients::Exchange::AutodiscoverService::get_RedirectionUrlValidationCallback ( ) const

Gets the redirection URL validation callback.

The redirection URL validation callback.

◆ get_Url()

System::SharedPtr<System::Uri> Aspose::Email::Clients::Exchange::AutodiscoverService::get_Url ( ) const

Gets the URL this service is bound to.

◆ GetAutodiscoverServiceHosts()

System::SharedPtr<System::Collections::Generic::ListExt<System::String> > Aspose::Email::Clients::Exchange::AutodiscoverService::GetAutodiscoverServiceHosts ( System::String  domainName,
int32_t &  scpHostCount 
)

Gets the list of autodiscover service hosts.

Parameters
domainNameName of the domain.
scpHostCountCount of SCP hosts that were found.
Returns
List of host names.

◆ GetAutodiscoverServiceUrls()

System::SharedPtr<System::Collections::Generic::ListExt<System::SharedPtr<System::Uri> > > Aspose::Email::Clients::Exchange::AutodiscoverService::GetAutodiscoverServiceUrls ( System::String  domainName,
int32_t &  scpHostCount 
)

Gets the list of autodiscover service URLs.

Parameters
domainNameDomain name.
scpHostCountCount of hosts found via SCP lookup.
Returns
List of Autodiscover URLs.

◆ GetDomainSettings() [1/3]

System::SharedPtr<GetDomainSettingsResponseCollection> Aspose::Email::Clients::Exchange::AutodiscoverService::GetDomainSettings ( System::SharedPtr< System::Collections::Generic::IEnumerable< System::String >>  domains,
System::Nullable< WebService::ExchangeVersion requestedVersion,
const System::ArrayPtr< DomainSettingName > &  domainSettingNames 
)

Retrieves the specified settings for a set of domains.

Parameters
domainsThe SMTP addresses of the domains.
requestedVersionRequested version of the Exchange service.
domainSettingNamesThe domain setting names.
Returns
A GetDomainSettingsResponseCollection object containing the responses for each individual domain.

◆ GetDomainSettings() [2/3]

System::SharedPtr<GetDomainSettingsResponseCollection> Aspose::Email::Clients::Exchange::AutodiscoverService::GetDomainSettings ( System::SharedPtr< System::Collections::Generic::ListExt< System::String >>  domains,
System::SharedPtr< System::Collections::Generic::ListExt< DomainSettingName >>  settings,
System::Nullable< WebService::ExchangeVersion requestedVersion 
)

Gets the domain settings using Autodiscover SOAP service.

Parameters
domainsThe domains.
settingsThe settings.
requestedVersionRequested version of the Exchange service.
Returns
GetDomainSettingsResponse collection.

◆ GetDomainSettings() [3/3]

System::SharedPtr<GetDomainSettingsResponse> Aspose::Email::Clients::Exchange::AutodiscoverService::GetDomainSettings ( System::String  domain,
System::Nullable< WebService::ExchangeVersion requestedVersion,
const System::ArrayPtr< DomainSettingName > &  domainSettingNames 
)

Retrieves the specified settings for a domain.

Parameters
domainThe domain.
requestedVersionRequested version of the Exchange service.
domainSettingNamesThe domain setting names.
Returns
A DomainResponse object containing the requested settings for the specified domain.

◆ GetLegacyUserSettings()

template<typename TSettings >
TSettings Aspose::Email::Clients::Exchange::AutodiscoverService::GetLegacyUserSettings ( System::String  emailAddress)
inline

Calls the legacy Autodiscover service to retrieve configuration settings.

Template Parameters
TSettingsThe type of the settings to retrieve.
Parameters
emailAddressThe email address to retrieve configuration settings for.
Returns
The requested configuration settings.

◆ GetRedirectionUrlFromDnsSrvRecord()

System::SharedPtr<System::Uri> Aspose::Email::Clients::Exchange::AutodiscoverService::GetRedirectionUrlFromDnsSrvRecord ( System::String  domainName)

Get an autodiscover SRV record in DNS and construct autodiscover URL.

Parameters
domainNameName of the domain.
Returns
Autodiscover URL (may be null if lookup failed)

◆ GetUserSettings() [1/2]

System::SharedPtr<GetUserSettingsResponseCollection> Aspose::Email::Clients::Exchange::AutodiscoverService::GetUserSettings ( System::SharedPtr< System::Collections::Generic::ListExt< System::String >>  smtpAddresses,
System::SharedPtr< System::Collections::Generic::ListExt< UserSettingName >>  settings 
)

Gets the user settings using Autodiscover SOAP service.

Parameters
smtpAddressesThe SMTP addresses of the users.
settingsThe settings.
Returns

◆ GetUserSettings() [2/2]

System::SharedPtr<GetUserSettingsResponse> Aspose::Email::Clients::Exchange::AutodiscoverService::GetUserSettings ( System::String  userSmtpAddress,
const System::ArrayPtr< UserSettingName > &  userSettingNames 
)

Retrieves the specified settings for single SMTP address.

Parameters
userSmtpAddressThe SMTP addresses of the user.
userSettingNamesThe user setting names.
Returns
A UserResponse object containing the requested settings for the specified user.

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

◆ GetUsersSettings()

System::SharedPtr<GetUserSettingsResponseCollection> Aspose::Email::Clients::Exchange::AutodiscoverService::GetUsersSettings ( System::SharedPtr< System::Collections::Generic::IEnumerable< System::String >>  userSmtpAddresses,
const System::ArrayPtr< UserSettingName > &  userSettingNames 
)

Retrieves the specified settings for a set of users.

Parameters
userSmtpAddressesThe SMTP addresses of the users.
userSettingNamesThe user setting names.
Returns
A GetUserSettingsResponseCollection object containing the responses for each individual user.

◆ InternalGetLegacyUserSettings()

System::SharedPtr<GetUserSettingsResponse> Aspose::Email::Clients::Exchange::AutodiscoverService::InternalGetLegacyUserSettings ( System::String  emailAddress,
System::SharedPtr< System::Collections::Generic::ListExt< UserSettingName >>  requestedSettings 
)

Gets user settings from Autodiscover legacy endpoint.

Parameters
emailAddressThe email address.
requestedSettingsThe requested settings.
Returns
GetUserSettingsResponse

◆ InternalGetSoapUserSettings()

System::SharedPtr<GetUserSettingsResponse> Aspose::Email::Clients::Exchange::AutodiscoverService::InternalGetSoapUserSettings ( System::String  smtpAddress,
System::SharedPtr< System::Collections::Generic::ListExt< UserSettingName >>  requestedSettings 
)

Calls the SOAP Autodiscover service for user settings for a single SMTP address.

Parameters
smtpAddressSMTP address.
requestedSettingsThe requested settings.
Returns

◆ PrepareHttpWebRequestForUrl()

System::SharedPtr<System::Net::HttpWebRequest> Aspose::Email::Clients::Exchange::AutodiscoverService::PrepareHttpWebRequestForUrl ( System::SharedPtr< System::Uri >  url)

Creates an HttpWebRequest instance and initializes it with the appropriate parameters, based on the configuration of this service object.

Parameters
urlThe URL that the HttpWebRequest should target.

◆ ProcessHttpErrorResponse()

void Aspose::Email::Clients::Exchange::AutodiscoverService::ProcessHttpErrorResponse ( System::SharedPtr< System::Net::HttpWebResponse >  httpWebResponse,
System::Net::WebException  webException 
)

Processes an HTTP error response.

Parameters
httpWebResponseThe HTTP web response.
webExceptionThe web exception.

◆ set_DnsServerAddress()

void Aspose::Email::Clients::Exchange::AutodiscoverService::set_DnsServerAddress ( System::SharedPtr< System::Net::IPAddress >  value)

Sets the DNS server address.

The DNS server address.

◆ set_Domain()

void Aspose::Email::Clients::Exchange::AutodiscoverService::set_Domain ( System::String  value)

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.

◆ set_EnableScpLookup()

void Aspose::Email::Clients::Exchange::AutodiscoverService::set_EnableScpLookup ( bool  value)

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

◆ set_GetScpUrlsForDomainCallback()

void Aspose::Email::Clients::Exchange::AutodiscoverService::set_GetScpUrlsForDomainCallback ( AutodiscoverService::FuncC< System::String, System::SharedPtr< System::Collections::Generic::ICollection< System::String >>>  value)

Sets the delegate used to resolve Autodiscover SCP urls for a specified domain.

◆ set_IsExternal()

void Aspose::Email::Clients::Exchange::AutodiscoverService::set_IsExternal ( System::Nullable< bool >  value)

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.

◆ set_RedirectionUrlValidationCallback()

void Aspose::Email::Clients::Exchange::AutodiscoverService::set_RedirectionUrlValidationCallback ( AutodiscoverRedirectionUrlValidationCallback  value)

Sets the redirection URL validation callback.

The redirection URL validation callback.

◆ set_Url()

void Aspose::Email::Clients::Exchange::AutodiscoverService::set_Url ( System::SharedPtr< System::Uri >  value)

Sets the URL this service is bound to.

◆ TraceResponse()

void Aspose::Email::Clients::Exchange::AutodiscoverService::TraceResponse ( System::SharedPtr< System::Net::HttpWebResponse >  response,
System::SharedPtr< System::IO::MemoryStream >  memoryStream 
)

Traces the response.

Parameters
responseThe response.
memoryStreamThe response content in a MemoryStream.

◆ ValidateParam()

static void Aspose::Email::Clients::Exchange::AutodiscoverService::ValidateParam ( System::SharedPtr< System::Object >  param,
System::String  paramName 
)
static

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Exchange::AutodiscoverRequest

friend class Aspose::Email::Clients::Exchange::AutodiscoverRequest
friend

Member Data Documentation

◆ AutodiscoverMaxRedirections

const int32_t Aspose::Email::Clients::Exchange::AutodiscoverService::AutodiscoverMaxRedirections
static

Maximum number of Url (or address) redirections that will be followed by an Autodiscover call