HostedEmailManager Class

 

Contains the object model for the hosted email functions.

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

System::Object
  Microsoft.WindowsServerSolutions.Common.ProviderFramework::ObjectModelBase
    Microsoft.WindowsServerSolutions.Common.ProviderFramework::ObjectModelBaseExtended<TBackEnd>
      Microsoft.WindowsServerSolutions.HostedEmail::HostedEmailManager

public ref class HostedEmailManager : ObjectModelBaseExtended<IHostedEmailProviderBackend^>

NameDescription
System_CAPS_pubmethodHostedEmailManager(Guid)

Creates a new instance of a HostedEmailManager using the specified add-in ID.

NameDescription
System_CAPS_protpropertyAutoReconnect

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_protpropertyBackEnd

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_pubpropertyCachedDomains

Retrieves the cached domains for the email service.

System_CAPS_pubpropertyConnected

Gets the status of the connection to the provider.(Inherited from ObjectModelBase.)

System_CAPS_protpropertyLogCategory

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

NameDescription
System_CAPS_pubmethodAssignAccount(String^, String^)

Synchronous call to bind a Windows Server 2012 Essentials user with an email account.

System_CAPS_pubmethodAssignAccountByEmailAddress(String^, String^)

Synchronous call to bind a Windows Server 2012 Essentials user with an email address.

System_CAPS_pubmethodBeginAssignAccount(String^, String^, EventHandler<OperationInvokeEventArgs<Boolean>^>^)

Asynchronous call to bind a Windows Server 2012 Essentials server user with an email account ID.

System_CAPS_pubmethodBeginAssignAccountByEmailAddress(String^, String^, EventHandler<OperationInvokeEventArgs<Boolean>^>^)

Asynchronous call to bind an SBS8 server user with an email account.

System_CAPS_pubmethodBeginCreateAccount(String^, String^, EmailAccountInfo^, EventHandler<OperationInvokeEventArgs<EmailAccountInfo^>^>^)

Asynchronous call to create a new email account.

System_CAPS_pubmethodBeginDeleteAccount(String^, EventHandler<OperationInvokeEventArgs<Boolean>^>^)

Asynchronous call to delete email account from the bound Windows Server 2012 Essentials user.

System_CAPS_pubmethodBeginDisableAccount(String^, EventHandler<OperationInvokeEventArgs<Boolean>^>^)

Asynchronous call to disable the email account bound to the specified Windows Server 2012 Essentials user.

System_CAPS_pubmethodBeginEnableAccount(String^, EventHandler<OperationInvokeEventArgs<Boolean>^>^)

Asynchronous call to enable an email account bound to a Windows Server 2012 Essentials user.

System_CAPS_pubmethodBeginGetAccount(String^, EventHandler<OperationInvokeEventArgs<EmailAccountInfo^>^>^)

Asynchronous call to retrieve a new email account and bound it with a Windows Server 2012 Essentials user.

System_CAPS_pubmethodBeginGetAllAccounts(EventHandler<OperationInvokeEventArgs<array<EmailAccountInfo^>^>^>^)

Asynchronous call to retrieve all email accounts.

System_CAPS_pubmethodBeginGetAllAssignedAccounts(EventHandler<OperationInvokeEventArgs<array<UserEmailInfo^>^>^>^)

Asynchronous call to retrieve all email accounts assigned to Windows Server 2012 Essentials users.

System_CAPS_pubmethodBeginGetAllUnassignedAccounts(EventHandler<OperationInvokeEventArgs<array<EmailAccountInfo^>^>^>^)

Asynchronous call to get all email accounts not assigned to any user.

System_CAPS_pubmethodBeginGetDomains(EventHandler<OperationInvokeEventArgs<array<String^>^>^>^)

Asynchronous call to retrieve all domains associated with the email host service.

System_CAPS_pubmethodBeginResetPassword(String^, String^, EventHandler<OperationInvokeEventArgs<Boolean>^>^)

Asynchronous call to reset the password of the email account bound with the specified user.

System_CAPS_pubmethodBeginUnassignAccount(String^, EventHandler<OperationInvokeEventArgs<Boolean>^>^)

Asynchronous call to unbind the specified user with a bound email account.

System_CAPS_pubmethodBeginUpdateAccount(String^, EmailAccountInfo^, EventHandler<OperationInvokeEventArgs<Boolean>^>^)

Asynchronous call to update email account.

System_CAPS_pubmethodConnect()

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_pubmethodConnectAsync()

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_protmethodConvertResult<TResult, TTarget>(OperationInvokeEventArgs<TResult>^)

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_pubmethodCreateAccount(String^, String^, EmailAccountInfo^)

Synchronous call to create a new email account.

System_CAPS_pubmethodDeleteAccount(String^)

Synchronous call to delete the email account bound to the specified user.

System_CAPS_pubmethodDisableAccount(String^)

Synchronous call to disable the email account bound to the specified user.

System_CAPS_pubmethodDisconnect()

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_pubmethodDispose()

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_protmethodDispose(Boolean)

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_pubmethodEnableAccount(String^)

Synchronous call to enable the email account bound to the specified user.

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodExecuteOperationAsync<T>(String^, TimeSpan, Action<String^>^)

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetAccount(String^)

Synchronous call to retrieve a new email account and to bind the new account to a Windows Server 2012 Essentials user.

System_CAPS_pubmethodGetAllAccounts()

Synchronous call to retrieve all email accounts.

System_CAPS_pubmethodGetAllAssignedAccounts()

Synchronous call to get all email accounts assigned to Windows Server 2012 Essentials users.

System_CAPS_pubmethodGetAllUnassignedAccounts()

Synchronous call to get all email accounts that not assigned to any Windows Server 2012 Essentials user.

System_CAPS_pubmethodGetDomains()

Synchronous call to get the domains associated with the hosted email server.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodInvoke(Action^)

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_protmethodInvoke<TResult>(Func<TResult>^)

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_protmethodInvokeAsync(Action^, EventHandler<OperationInvokeEventArgs<Object^>^>^)

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_protmethodInvokeAsync<TResult>(Func<TResult>^, EventHandler<OperationInvokeEventArgs<TResult>^>^)

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_protmethodIsKnownException(Exception^)

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodOnConnectionClosed()

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_pubmethodOnConnectionFailed()

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_pubmethodOnConnectionOpened()

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_protmethodOnOperationComplete<TResult>(OperationInvokeEventArgs<TResult>^)

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_pubmethodOnOperationInvokeCompleted<TResult>(OperationInvokeEventArgs<TResult>^)

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_protmethodOnOperationStart(String^, TimeSpan)

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_protmethodRaisePropertyChanged(String^)

Raises the property changed event with the specified property name.(Inherited from ObjectModelBase.)

System_CAPS_pubmethodResetPassword(String^, String^)

Synchronous call to reset the password of the email account bound to a Windows Server 2012 Essentials user.

System_CAPS_protmethodStartOperation<T>(String^, TimeSpan, EventHandler<OperationInvokeEventArgs<T>^>^, Action<String^>^)

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUnassignAccount(String^)

Synchronous call to unbind a Windows Server 2012 Essentials user with a bound email account.

System_CAPS_pubmethodUpdateAccount(String^, EmailAccountInfo^)

Synchronous call to update an email account.

NameDescription
System_CAPS_pubeventConnectCompleted

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_pubeventConnectFailed

(Inherited from ObjectModelBaseExtended<TBackEnd>.)

System_CAPS_pubeventHostedEmailAccountUpdated

Occurs when any hosted email account is updated.

System_CAPS_pubeventPropertyChanged

Represents an INotifyPropertyChanged event that informs consumers of a provider when a property value is changed.(Inherited from ObjectModelBase.)

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.

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top

Community Additions

ADD
Show: