Set-ImapSettings

此 cmdlet 仅适用于本地 Exchange。

使用 Set-ImapSettings cmdlet 修改 Exchange 服务器上Microsoft Exchange IMAP4 服务的设置。 此服务存在于安装了客户端访问服务器角色的 Exchange 服务器上,并由 IMAP4 客户端用来连接到 Exchange。

有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法

语法

Set-ImapSettings
   [-AuthenticatedConnectionTimeout <EnhancedTimeSpan>]
   [-Banner <String>]
   [-CalendarItemRetrievalOption <CalendarItemRetrievalOptions>]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-EnableExactRFC822Size <Boolean>]
   [-EnableGSSAPIAndNTLMAuth <Boolean>]
   [-EnforceCertificateErrors <Boolean>]
   [-ExtendedProtectionPolicy <ExtendedProtectionTokenCheckingMode>]
   [-ExternalConnectionSettings <MultiValuedProperty>]
   [-InternalConnectionSettings <MultiValuedProperty>]
   [-LogFileLocation <String>]
   [-LogFileRollOverSettings <LogFileRollOver>]
   [-LoginType <LoginOptions>]
   [-LogPerFileSizeQuota <Unlimited>]
   [-MaxCommandSize <Int32>]
   [-MaxConnectionFromSingleIP <Int32>]
   [-MaxConnections <Int32>]
   [-MaxConnectionsPerUser <Int32>]
   [-MessageRetrievalMimeFormat <MimeTextFormat>]
   [-OwaServerUrl <Uri>]
   [-PreAuthenticatedConnectionTimeout <EnhancedTimeSpan>]
   [-ProtocolLogEnabled <Boolean>]
   [-ProxyTargetPort <Int32>]
   [-Server <ServerIdParameter>]
   [-ShowHiddenFoldersEnabled <Boolean>]
   [-SSLBindings <MultiValuedProperty>]
   [-SuppressReadReceipt <Boolean>]
   [-UnencryptedOrTLSBindings <MultiValuedProperty>]
   [-WhatIf]
   [-X509CertificateName <String>]
   [<CommonParameters>]

说明

可以为运行 Microsoft Exchange IMAP4 服务的单个 Exchange 服务器或运行 Microsoft Exchange IMAP4 服务的所有 Exchange 服务器运行 Set-ImapSettings cmdlet。

您必须先获得权限,然后才能运行此 cmdlet。 虽然本主题中列出了此 cmdlet 的所有参数,但如果这些参数并未包含在分配给您的权限中,那么您将无法使用这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet

示例

示例 1

Set-ImapSettings -Server "MBX01" -UnencryptedOrTLSBindings 10.0.0.0:143

此示例使用 TCP 端口 143 上的本地 IP 地址 10.0.0.0 配置与名为 MBX01 的服务器建立的未加密或 STARTTLS 加密 IMAP4 连接。

示例 2

Set-ImapSettings -ProtocolLogEnabled $true -LogFileLocation "C:\Imap4Logging"

本示例将启用 IMAP4 协议日志记录。 还会将 IMAP4 协议日志记录目录更改为 C:\Imap4Logging。

示例 3

Set-ImapSettings -LogPerFileSizeQuota 2MB

本示例将 IMAP4 协议日志记录更改为在日志文件达到 2 MB 时创建新的日志文件。

示例 4

Set-ImapSettings -LogPerFileSizeQuota 0 -LogFileRollOverSettings Hourly

本示例将 IMAP4 协议日志记录更改为每小时创建一个新的日志文件。

示例 5

Set-ImapSettings -X509CertificateName mail.contoso.com

此示例指定包含 mail.contoso.com 用于加密 IMAP4 客户端连接的证书。

注意:对于单使用者证书或 SAN 证书,还需要使用 Enable-ExchangeCertificate cmdlet 将证书分配给 Exchange IMAP 服务。 对于通配符证书,无需将证书分配给 Exchange IMAP 服务, (在尝试) 时将收到错误。

参数

-AuthenticatedConnectionTimeout

AuthenticatedConnectionTimeout 参数指定在关闭经过身份验证的空闲连接之前要等待的时间。

若要指定值,请以时间跨度格式 dd.hh:mm:ss 输入值(其中 dd = 天,hh = 小时,mm = 分钟,ss = 秒)。

有效值为 00:00:30 和 1:00:00。 默认设置为 00:30:00 (30 分钟) 。

Type:EnhancedTimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Banner

Banner 参数指定显示给连接 IMAP4 客户端的文本字符串。 默认值为: The Microsoft Exchange IMAP4 service is ready.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-CalendarItemRetrievalOption

CalendarItemRetrievalOption 参数指定日历项如何呈现给 IMAP4 客户端。 有效值包含:

  • 0 或 iCalendar。 此值为默认值。
  • 1 或 IntranetUrl
  • 2 或 InternetUrl
  • 3 或自定义

如果指定 3 或 Custom,则需要为 OwaServerUrl 参数设置指定值。

Type:CalendarItemRetrievalOptions
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Confirm

Confirm 开关指定是否显示确认提示。 此开关对 cmdlet 造成的影响取决于在你继续操作之前 cmdlet 是否需要确认。

  • 破坏性 cmdlet (例如,Remove-* cmdlet) 具有内置的暂停,该暂停会强制你在继续操作之前确认命令。 对于这些 cmdlet,您可以使用此确切语法跳过确认提示:-Confirm:$false
  • 大多数其他 cmdlet (例如,New-* 和 Set-* cmdlet) 没有内置暂停。 对于这些 cmdlet,指定不含值的 Confirm 开关会引入暂停,从而强制要求你先确认命令,然后再继续操作。
Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-DomainController

DomainController 参数指定此 cmdlet 从 Active Directory 读取数据或向其写入数据时使用的域控制器。 可以使用完全限定的域名 (FQDN) 来标识域控制器。 例如,dc01.contoso.com。

Type:Fqdn
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-EnableExactRFC822Size

EnableExactRFC822Size 参数指定如何向 IMAP4 客户端显示消息大小。 有效值包含:

  • $true:计算确切的消息大小。 由于此设置可能会对性能产生负面影响,因此应仅在 IMAP4 客户端需要时才对其进行配置。
  • $false:使用估计的消息大小。 此值为默认值。
Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-EnableGSSAPIAndNTLMAuth

EnableGSSAPIAndNTLMAuth 参数指定连接是否可以使用集成Windows 身份验证 (NTLM) 使用通用安全服务应用程序编程接口 (GSSAPI) 。 此设置适用于禁用传输层安全性 (TLS) 的连接。 有效值包含:

  • $true:已启用适用于 IMAP4 连接的 NTLM。 此值为默认值。
  • $false:禁用 IMAP4 连接的 NTLM。
Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-EnforceCertificateErrors

EnforceCertificateErrors 参数指定是否强制实施有效的安全套接字层 (SSL) 证书验证失败。 有效值包含:

默认设置是 $false。

  • $true:如果证书无效或与目标 IMAP4 服务器的 FQDN 不匹配,则连接尝试失败。
  • $false:服务器不会基于证书错误拒绝 IMAP4 连接。 此值为默认值。
Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-ExtendedProtectionPolicy

ExtendedProtectionPolicy 参数指定如何使用扩展保护进行身份验证。 有效值包含:

  • 无:不使用针对身份验证的扩展保护。 此值为默认值。
  • 允许:仅当传入 IMAP4 连接支持时,才使用身份验证扩展保护。 如果不是,则不使用针对身份验证的扩展保护。
  • 要求:所有 IMAP4 连接都需要扩展身份验证保护。 如果传入的 IMAP4 连接不支持它,则会拒绝该连接。

针对身份验证的扩展保护通过集成Windows 身份验证 ((也称为 NTLM) )增强了对凭据的保护和处理,因此,如果客户端支持凭据 (默认安装 Windows 7 或更高版本,并且 Windows Server 2008 R2 或更高版本支持它) ,我们强烈建议你使用它。

Type:ExtendedProtectionTokenCheckingMode
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-ExternalConnectionSettings

ExternalConnectionSettings 参数指定外部 IMAP4 客户端使用的主机名、端口和加密方法, (来自企业网络) 外部的 IMAP4 连接。

此参数使用语法 HostName:Port:[<TLS | SSL>]。 加密方法值是可选的, (空白表示未加密的连接) 。

默认值为空白 ($null) ,这意味着未配置任何外部 IMAP4 连接设置。

若要输入多个值并覆盖任何现有条目,请使用以下语法: Value1,Value2,...ValueN。 如果值包含空格或需要引号,请使用以下语法: "Value1","Value2",..."ValueN"

若要在不影响任何现有条目的情况下添加或删除一个或多个值,请使用以下语法: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}

为此参数指定的加密方法和端口的组合需要匹配相应的加密方法和由 SSLBindings 和 UnencryptedOrTLSBindings 参数指定的端口。

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-InternalConnectionSettings

InternalConnectionSettings 参数指定内部 IMAP4 客户端从公司网络) (IMAP4 连接的主机名、端口和加密方法。 将 IMAP4 连接转发到运行 Microsoft Exchange IMAP4 服务的另一个 Exchange 服务器时,也会使用此设置。

此参数使用语法 HostName:Port:[<TLS | SSL>]。 加密方法值是可选的, (空白表示未加密的连接) 。

默认值为 <ServerFQDN>:993:SSL,<ServerFQDN>:143:TLS

若要输入多个值并覆盖任何现有条目,请使用以下语法: Value1,Value2,...ValueN。 如果值包含空格或需要引号,请使用以下语法: "Value1","Value2",..."ValueN"

若要在不影响任何现有条目的情况下添加或删除一个或多个值,请使用以下语法: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}

为此参数指定的加密方法和端口的组合需要匹配相应的加密方法和由 SSLBindings 和 UnencryptedOrTLSBindings 参数指定的端口。

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-LogFileLocation

LogFileLocation 参数指定 IMAP4 协议日志文件的位置。 默认位置为 %ExchangeInstallPath%Logging\Imap4。

仅当 ProtocolLogEnabled 参数值$true时,此参数才有意义。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-LogFileRollOverSettings

LogFileRollOverSettings 参数指定 IMAP4 协议日志记录创建新日志文件的频率。 有效值包含:

  • 1 或 Hourly。 这是 Exchange 2019 和 Exchange 2016 中的默认值。
  • 2 或 Daily。 这是 Exchange 2013 和 Exchange 2010 中的默认值。
  • 3 或 Weekly。
  • 4 或 Monthly。

仅当 LogPerFileSizeQuota 参数值为 0 且 ProtocolLogEnabled 参数值$true时,此参数才有意义。

Type:LogFileRollOver
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-LoginType

LoginType 参数指定 IMAP4 连接的身份验证方法。 有效值包含:

  • 1 或 PlainTextLogin。
  • 2 或 PlainTextAuthentication。
  • 3 或 SecureLogin。 此值为默认值。
Type:LoginOptions
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-LogPerFileSizeQuota

LogPerFileSizeQuota 参数指定 IMAP4 协议日志文件的最大大小。

有效值是一个数字,最大可为 1.999999999 TB(即 2199023254528 B)或值 unlimited。默认值为 6 GB(即 6442450944 B)。

  • B(字节)
  • KB(千字节)
  • MB(兆字节)
  • GB(千兆字节)
  • TB (TB)

TB(兆兆字节)

默认值为 0,这意味着将按 LogFileRollOverSettings 参数指定的频率创建新的 IMAP4 协议日志文件。

仅当 ProtocolLogEnabled 参数值$true时,此参数才有意义。

Type:Unlimited
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-MaxCommandSize

MaxCommandSize 参数指定单个 IMAP4 命令的最大大小(以字节为单位)。 有效值为 1024 到 16384。 默认值为 10240。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-MaxConnectionFromSingleIP

MaxConnectionFromSingleIP 参数指定 Exchange 服务器从单个 IP 地址接受的最大 IMAP4 连接数。 有效值范围为 1 到 2147483647。 默认值为 2147483647。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-MaxConnections

MaxConnections 参数指定 Exchange 服务器接受的最大 IMAP4 连接数。 有效值范围为 1 到 2147483647。 默认值为 2147483647。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-MaxConnectionsPerUser

MaxConnectionsPerUser 参数指定每个用户允许的最大 IMAP4 连接数。 有效值范围为 1 到 2147483647。 默认值为 16。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-MessageRetrievalMimeFormat

MessageRetrievalMimeFormat 参数指定邮件的 MIME 编码。 有效值包含:

  • 0 或 TextOnly。
  • 1 或 HtmlOnly。
  • 2 或 HtmlAndTextAlternative。
  • 3 或 TextEnrichedOnly。
  • 4 或 TextEnrichedAndTextAlternative。
  • 5 或 BestBodyFormat。 此值为默认值。
  • 6 或 Tnef。
Type:MimeTextFormat
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-OwaServerUrl

OwaServerUrl 参数指定用于检索自定义Outlook 网页版日历项实例的日历信息的 URL。

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-PreAuthenticatedConnectionTimeout

PreAuthenticatedConnectionTimeout 参数指定在关闭未进行身份验证的空闲 IMAP4 连接之前要等待的时间段。

若要指定值,请以时间跨度格式 dd.hh:mm:ss 输入值(其中 dd = 天,hh = 小时,mm = 分钟,ss = 秒)。

有效值为 00:00:30 到 1:00:00。 默认值为 00:01:00(一分钟)。

Type:EnhancedTimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-ProtocolLogEnabled

ProtocolLogEnabled 参数指定是否为 IMAP4 启用协议日志记录。 有效值包含:

  • $true:已启用 IMAP4 协议日志记录。
  • $false:禁用 IMAP4 协议日志记录。 此值为默认值。
Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-ProxyTargetPort

ProxyTargetPort 参数指定Microsoft Exchange IMAP4 后端服务上的端口,该服务侦听从 Microsoft Exchange IMAP4 服务代理的客户端连接。 默认值为 1993。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Server

服务器参数指定要运行此命令的Exchange服务器。 可以使用唯一标识该服务器的任何值。 例如:

  • 名称
  • FQDN
  • 可分辨名称 (DN)
  • Exchange 旧版 DN

Exchange 旧版 DN

Type:ServerIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-ShowHiddenFoldersEnabled

ShowHiddenFoldersEnabled 参数指定隐藏邮箱文件夹是否可见。 有效值包含:

  • $true:隐藏的文件夹可见。
  • $false:隐藏的文件夹不可见。 此值为默认值。
Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-SSLBindings

SSLBindings 参数指定用于始终由 SSL/TLS 加密的 IMAP4 连接的 IP 地址和 TCP 端口。 此参数使用语法 IPv4OrIPv6Address:Port

默认值为 [::]:993,0.0.0.0:993

若要输入多个值并覆盖任何现有条目,请使用以下语法: Value1,Value2,...ValueN。 如果值包含空格或需要引号,请使用以下语法: "Value1","Value2",..."ValueN"

若要在不影响任何现有条目的情况下添加或删除一个或多个值,请使用以下语法: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-SuppressReadReceipt

SuppressReadReceipt 参数指定是否停止将重复的已读回执发送到 IMAP4 客户端,这些客户端在其 IMAP4 电子邮件程序中配置了“为我发送的邮件发送已读回执”设置。 有效值包含:

  • $true:仅当收件人打开邮件时,发件人才会收到已读回执。
  • $false:发件人在收件人下载邮件时以及收件人打开邮件时收到已读回执。 此值为默认值。
Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-UnencryptedOrTLSBindings

UnencryptedOrTLSBindings 参数指定用于未加密的 IMAP4 连接的 IP 地址和 TCP 端口,或者在初始未加密协议握手后使用机会性 TLS (STARTTLS) 加密的 IMAP4 连接。 此参数使用语法 IPv4OrIPv6Address:Port

默认值为 [::]:143,0.0.0.0:143

若要输入多个值并覆盖任何现有条目,请使用以下语法: Value1,Value2,...ValueN。 如果值包含空格或需要引号,请使用以下语法: "Value1","Value2",..."ValueN"

若要在不影响任何现有条目的情况下添加或删除一个或多个值,请使用以下语法: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-WhatIf

WhatIf 开关模拟命令操作。 可以使用此开关在不实际应用将会发生的更改的情况下预览这些更改。 不必为此开关指定值。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-X509CertificateName

X509CertificateName 参数指定用于加密 IMAP4 客户端连接的证书。

此参数的有效值为 ExternalConnectionSettings 或 InternalConnectionSettings 参数 (FQDN,例如 mail.contoso.com 或 mailbox01.contoso.com) 。

如果使用单个使用者证书或使用者可选名称 (SAN) 证书,则还需要使用 Enable-ExchangeCertificate cmdlet 将证书分配给 Exchange IMAP 服务。

如果使用通配符证书,则无需将证书分配给 Exchange IMAP 服务。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

输入

Input types

若要了解此 cmdlet 接受的输入类型,请参阅 cmdlet 的输入和输出类型。 如果 cmdlet 的"输入类型"字段为空,则表明此 cmdlet 不接受输入数据。

输出

Output types

若要了解此 cmdlet 接受的返回类型(亦称为"输出类型"),请参阅 cmdlet 的输入和输出类型。 如果"输出类型"字段为空,则表明此 cmdlet 不返回任何数据。