Enable-HostedEmailIntegration

  • Article

Enable-HostedEmailIntegration

Enables the hosted email integration module.

Syntax

Parameter Set: Default
Enable-HostedEmailIntegration [-AddInId] <Guid> [-AdminAccount] <String> [-Password] <SecureString> [[-EnablePasswordSync]] [ <CommonParameters>]

Detailed Description

The Enable-HostedEmailIntegration cmdlet enables the hosted email integration module. Run this cmdlet after you install the hosted email add-in. The third-party hosted email provider builds the hosted email add-in on the Hosted Email Add-in Framework.

Parameters

-AddInId<Guid>

Specifies the GUID of the hosted email add-in to enable.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-AdminAccount<String>

Specifies the name of the administrator account for the hosted email service.

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-EnablePasswordSync

Indicates that the hosted email service enables password synchronization.

Aliases

none

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Password<SecureString>

Specifies the password, as a secure string, of the administration account for the hosted email service. To obtain a secure string, use the ConvertTo-SecureString cmdlet. For more information, type Get-Help ConvertTo-SecureString.

Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.Guid,System.String,System.Security.SecureString,System.Management.Automation.SwitchParameter

    AddInId
    Type: System.Guid
    Description: add-in ID for the hosted email integration

    AdminAccount
    Type: System.String
    Description: name of the administrator account

    Password
    Type: System.Security.SecureString
    Description: password of the administrator account

    EnablePasswordSync
    Type: System.Management.Automation.SwitchParameter
    Description: whether to enable password synchronization feature

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Enable the hosted email integration module

The first command creates a password as a secure string for use in the second command.

The second command enables the hosted email integration module, specifying the administrator account to use and its password that was created in the previous step.

PS C:\> $SecureString_pwd = convertto-securestring "P@ssW0rD!" -Asplaintext -Force
PS C:\> Enable-HostedEmailIntegration -AddId 26a21bda-a627-11d7-9931-806e6f6e6963 -AdminAccount "HEadmin01" -Password $SecureString_pwd -EnablePasswordSync

ConvertTo-SecureString