Share via


IHostedEmailAdaptor Interface

 

Manages the hosted email adapter.

Namespace:   Microsoft.WindowsServerSolutions.HostedEmail
Assembly:  Wssg.HostedEmailBase (in Wssg.HostedEmailBase.dll)

Syntax

public interface IHostedEmailAdaptor
public interface class IHostedEmailAdaptor
Public Interface IHostedEmailAdaptor

Properties

Name Description
System_CAPS_pubproperty Connected

Retrieves whether the adapter is connected to the host email server.

Methods

Name Description
System_CAPS_pubmethod Activate(String, String, IDictionary<String, String>)

Initializes the adapter.

System_CAPS_pubmethod Connect()

Connects to the hosted email provider for a user management session.

System_CAPS_pubmethod CreateAccount(EmailAccountInfo, String)

Creates a new email account.

System_CAPS_pubmethod Deactivate(IDictionary<String, String>)

Deactivates the hosted email adapter.

System_CAPS_pubmethod DeleteAccount(String)

Deletes an existing email account.

System_CAPS_pubmethod DisableAccount(String)

Disables an existing email account.

System_CAPS_pubmethod Disconnect()

Disconnects a user management session.

System_CAPS_pubmethod EnableAccount(String)

Enables an existing email account.

System_CAPS_pubmethod GetAccount(String)

Retrieves the account information of the specified email account.

System_CAPS_pubmethod GetAllAccounts()

Retrieves the account information for all accounts on the system.

System_CAPS_pubmethod GetDomains()

Retrieves the domains of the hosted email service.

System_CAPS_pubmethod ResetAdminCredential(String, String, IDictionary<String, String>)

Resets the management account credentials.

System_CAPS_pubmethod ResetPassword(String, String)

Resets the password for an existing email account.

System_CAPS_pubmethod UpdateAccount(EmailAccountInfo)

Updates the account information of an existing email account.

Remarks

This interface is exposed by the hosted email adapter. As such, this interface is the primary tool that the Windows Server 2012 Essentials Hosted Email Integration application uses to manage the email service. For more information about implementing this interface, see Creating the Add-In.

See Also

Microsoft.WindowsServerSolutions.HostedEmail Namespace

Return to top