HostedEmailManager Class
Contains the object model for the hosted email functions.
Namespace: Microsoft.WindowsServerSolutions.HostedEmail
Assembly: Wssg.HostedEmailObjectModel (in Wssg.HostedEmailObjectModel.dll)
Inheritance Hierarchy
System.Object
Microsoft.WindowsServerSolutions.Common.ProviderFramework.ObjectModelBase
Microsoft.WindowsServerSolutions.Common.ProviderFramework.ObjectModelBaseExtended<TBackEnd>
Microsoft.WindowsServerSolutions.HostedEmail.HostedEmailManager
Syntax
public class HostedEmailManager : ObjectModelBaseExtended<IHostedEmailProviderBackend>
public ref class HostedEmailManager : ObjectModelBaseExtended<IHostedEmailProviderBackend^>
Public Class HostedEmailManager
Inherits ObjectModelBaseExtended(Of IHostedEmailProviderBackend)
Constructors
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubmethod") |
HostedEmailManager(Guid) | Creates a new instance of a HostedEmailManager using the specified add-in ID. |
Properties
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_protproperty") |
AutoReconnect | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
BackEnd | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
.jpeg "System_CAPS_pubproperty") |
CachedDomains | Retrieves the cached domains for the email service. |
|
Connected | Gets the status of the connection to the provider.(Inherited from ObjectModelBase.) |
|
LogCategory | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
Methods
| Name | Description | |
|---|---|---|
|
AssignAccount(String, String) | Synchronous call to bind a Windows Server 2012 Essentials user with an email account. |
|
AssignAccountByEmailAddress(String, String) | Synchronous call to bind a Windows Server 2012 Essentials user with an email address. |
|
BeginAssignAccount(String, String, EventHandler<OperationInvokeEventArgs<Boolean>>) | Asynchronous call to bind a Windows Server 2012 Essentials server user with an email account ID. |
|
BeginAssignAccountByEmailAddress(String, String, EventHandler<OperationInvokeEventArgs<Boolean>>) | Asynchronous call to bind an SBS8 server user with an email account. |
|
BeginCreateAccount(String, String, EmailAccountInfo, EventHandler<OperationInvokeEventArgs<EmailAccountInfo>>) | Asynchronous call to create a new email account. |
|
BeginDeleteAccount(String, EventHandler<OperationInvokeEventArgs<Boolean>>) | Asynchronous call to delete email account from the bound Windows Server 2012 Essentials user. |
|
BeginDisableAccount(String, EventHandler<OperationInvokeEventArgs<Boolean>>) | Asynchronous call to disable the email account bound to the specified Windows Server 2012 Essentials user. |
|
BeginEnableAccount(String, EventHandler<OperationInvokeEventArgs<Boolean>>) | Asynchronous call to enable an email account bound to a Windows Server 2012 Essentials user. |
|
BeginGetAccount(String, EventHandler<OperationInvokeEventArgs<EmailAccountInfo>>) | Asynchronous call to retrieve a new email account and bound it with a Windows Server 2012 Essentials user. |
|
BeginGetAllAccounts(EventHandler<OperationInvokeEventArgs<EmailAccountInfo[]>>) | Asynchronous call to retrieve all email accounts. |
|
BeginGetAllAssignedAccounts(EventHandler<OperationInvokeEventArgs<UserEmailInfo[]>>) | Asynchronous call to retrieve all email accounts assigned to Windows Server 2012 Essentials users. |
|
BeginGetAllUnassignedAccounts(EventHandler<OperationInvokeEventArgs<EmailAccountInfo[]>>) | Asynchronous call to get all email accounts not assigned to any user. |
|
BeginGetDomains(EventHandler<OperationInvokeEventArgs<String[]>>) | Asynchronous call to retrieve all domains associated with the email host service. |
|
BeginResetPassword(String, String, EventHandler<OperationInvokeEventArgs<Boolean>>) | Asynchronous call to reset the password of the email account bound with the specified user. |
|
BeginUnassignAccount(String, EventHandler<OperationInvokeEventArgs<Boolean>>) | Asynchronous call to unbind the specified user with a bound email account. |
|
BeginUpdateAccount(String, EmailAccountInfo, EventHandler<OperationInvokeEventArgs<Boolean>>) | Asynchronous call to update email account. |
|
Connect() | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
ConnectAsync() | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
.jpeg "System_CAPS_protmethod") |
ConvertResult<TResult, TTarget>(OperationInvokeEventArgs<TResult>) | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
CreateAccount(String, String, EmailAccountInfo) | Synchronous call to create a new email account. |
|
DeleteAccount(String) | Synchronous call to delete the email account bound to the specified user. |
|
DisableAccount(String) | Synchronous call to disable the email account bound to the specified user. |
|
Disconnect() | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
Dispose() | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
Dispose(Boolean) | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
EnableAccount(String) | Synchronous call to enable the email account bound to the specified user. |
|
Equals(Object) | (Inherited from Object.) |
|
ExecuteOperationAsync<T>(String, TimeSpan, Action<String>) | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
Finalize() | (Inherited from Object.) |
|
GetAccount(String) | Synchronous call to retrieve a new email account and to bind the new account to a Windows Server 2012 Essentials user. |
|
GetAllAccounts() | Synchronous call to retrieve all email accounts. |
|
GetAllAssignedAccounts() | Synchronous call to get all email accounts assigned to Windows Server 2012 Essentials users. |
|
GetAllUnassignedAccounts() | Synchronous call to get all email accounts that not assigned to any Windows Server 2012 Essentials user. |
|
GetDomains() | Synchronous call to get the domains associated with the hosted email server. |
|
GetHashCode() | (Inherited from Object.) |
|
GetType() | (Inherited from Object.) |
|
Invoke(Action) | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
Invoke<TResult>(Func<TResult>) | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
InvokeAsync(Action, EventHandler<OperationInvokeEventArgs<Object>>) | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
InvokeAsync<TResult>(Func<TResult>, EventHandler<OperationInvokeEventArgs<TResult>>) | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
IsKnownException(Exception) | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
MemberwiseClone() | (Inherited from Object.) |
|
OnConnectionClosed() | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
OnConnectionFailed() | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
OnConnectionOpened() | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
OnOperationComplete<TResult>(OperationInvokeEventArgs<TResult>) | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
OnOperationInvokeCompleted<TResult>(OperationInvokeEventArgs<TResult>) | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
OnOperationStart(String, TimeSpan) | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
RaisePropertyChanged(String) | Raises the property changed event with the specified property name.(Inherited from ObjectModelBase.) |
|
ResetPassword(String, String) | Synchronous call to reset the password of the email account bound to a Windows Server 2012 Essentials user. |
|
StartOperation<T>(String, TimeSpan, EventHandler<OperationInvokeEventArgs<T>>, Action<String>) | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
ToString() | (Inherited from Object.) |
|
UnassignAccount(String) | Synchronous call to unbind a Windows Server 2012 Essentials user with a bound email account. |
|
UpdateAccount(String, EmailAccountInfo) | Synchronous call to update an email account. |
Events
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubevent") |
ConnectCompleted | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
ConnectFailed | (Inherited from ObjectModelBaseExtended<TBackEnd>.) |
|
HostedEmailAccountUpdated | Occurs when any hosted email account is updated. |
|
PropertyChanged | Represents an INotifyPropertyChanged event that informs consumers of a provider when a property value is changed.(Inherited from ObjectModelBase.) |
Remarks
This object represents the primary object a 3rd party developer will use to interact with a hosted email service. Most of the calls are passed to the IHostedEmailAdaptor, which is implemented by the provider.
For more information about making calls into a hosted email adapter, see How to: Manage the Hosted Email Service.
Thread Safety
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
Microsoft.WindowsServerSolutions.HostedEmail Namespace
Return to top