Configure Protocol Logging for POP3 and IMAP4

  • Article

 

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

You can configure protocol logging settings for POP3 and IMAP4 on a Microsoft Exchange Server 2010 Client Access server. By default, protocol logging isn't enabled. You can use protocol logging to review the POP3 and IMAP4 connections in your Exchange environment. This can be useful if you're troubleshooting issues related to POP3 or IMAP4 performance. For more information, see Understanding Protocol Logging for POP3 and IMAP4.

You can enable, disable, and modify protocol logging options by using the Exchange Management Shell.

Looking for other management tasks related to setting up POP3 and IMAP4? Check out Managing POP3 and IMAP4.

Use the Shell to enable protocol logging for POP3 or IMAP4

You need to be assigned permissions before you can perform this procedure. To see what permissions you need, see the "POP3 and IMAP4" entry in the Client Access Permissions topic.

This example enables protocol logging for IMAP4 or POP3 on the Client Access server CAS01.

Set-IMAPSettings -Server "CAS01" -ProtocolLogEnabled $true
Set-POPSettings -Server "CAS01" -ProtocolLogEnabled $true

You must restart the POP3 service or the IMAP4 service after you change these settings. The settings will take effect as soon as you restart the service.

For detailed syntax and parameter information, see Set-ImapSettings and Set-PopSettings.

Use the Shell to disable protocol logging for POP3 or IMAP4

You need to be assigned permissions before you can perform this procedure. To see what permissions you need, see the "POP3 and IMAP4" entry in the Client Access Permissions topic.

This example disables protocol logging for IMAP4 or POP3 on the Client Access server CAS01.

Set-IMAPSettings -Server "CAS01" -ProtocolLogEnabled $false
Set-POPSettings -Server "CAS01" -ProtocolLogEnabled $false

You must restart the POP3 service or the IMAP4 service after you change these settings. The settings will take effect as soon as you restart the service.

For detailed syntax and parameter information, see Set-ImapSettings and Set-PopSettings.

Use the Shell to modify protocol logging for POP3 or IMAP4

You need to be assigned permissions before you can perform this procedure. To see what permissions you need, see the "POP3 and IMAP4" entry in the Client Access Permissions topic.

To modify POP3 or IMAP4 logging settings, run the Set-IMAPSettings or Set-POPSettings cmdlets with one or more of the following parameters. You must restart the POP3 service or the IMAP4 service after you change these settings. The settings will take effect as soon as you restart the service.

  • LogFileLocation   This parameter specifies the location for the POP3 or IMAP4 protocol log files. By default, POP3 protocol log files are located in the C:\Program Files\Microsoft\Exchange Server\V14\Logging\Pop3 directory. This example turns on POP3 protocol logging on the Client Access server CAS01. It also changes the POP3 protocol logging directory to C:\Pop3Logging.

    Set-POPSettings -Server "CAS01" -ProtocolLogEnabled $true -LogFileLocation "C:\Pop3Logging"

  • LogFileRollOverSettings   This parameter defines how frequently POP3 or IMAP4 protocol logging creates a new log file. By default, a new log file is created every hour. The possible values are:

    Hourly

    Daily

    Weekly

    Monthly

    This setting applies only when the value for the parameter LogPerFileSizeQuota is set to 0. This example changes the POP3 protocol logging on the Client Access server CAS01 to create a new log file every hour.

    Set-POPSettings -Server "CAS01" -LogPerFileSizeQuota 0 -LogFileRollOverSettings Hourly

  • LogPerFileSizeQuota   This parameter defines the maximum size of a POP3 or IMAP4 protocol log file in bytes. By default, this value is set to 0. When this value is set to zero, a new protocol log file is created at the frequency specified by the LogFileRollOverSettings parameter.

    This example changes the POP3 protocol logging on the Client Access server CAS01 to create a new log file when a log file reaches 2 MB.

    Set-POPSettings -Server "CAS01" -LogPerFileSizeQuota 2000000

    This example changes the POP3 protocol logging on the Client Access server CAS01 to use the same log file regardless of its creation date and size.

    Set-POPSettings -Server "CAS01" -LogPerFileSizeQuota unlimited

For detailed syntax and parameter information, see Set-ImapSettings and Set-PopSettings.

Other Tasks

After you configure protocol logging settings for POP3 and IMAP4, you may also want to do the following:

 © 2010 Microsoft Corporation. All rights reserved.