Get-PopImapMailbox cmdlet gets the information on the POP/IMAP mailbox.

Input parameters

#
Parameter
Type

Mandatory (R/O)

Description
Valid Values
1 Authentication Information (all parameters)  
2

Identity

(aliases: GUID, DistinguishedName, UserPrincipalName, Name)

string O A property that is used for managing the mailbox

Value of one of these parameters  can be used as Identity:

#ParameterDescription
1 GUID Globally Unique Identifier (ObjectGuid)
2 DistinguishedName Unique name of the object in Active Directory
3 UserPrincipalName Primary Email address (Login)
4 Name Internal name of the AD object
3 ResultSize int O This parameter specifies the maximum number of results to return  

Output parameters

#PropertyTypeDescriptionValid Values

 PopImapMailboxInfo:

1 DisplayName string

Name of the mailbox in the list of Control Panel


2 DistinguishedName string Unique name of the object in Active Directory  
3 GUID string Globally Unique Identifier (ObjectGuid)  
4 HideFromAddressBook bool This property specifies whether this mailbox is visible in the address book
  • True - the mailbox is not visible in the address book.

  • False - the mailbox is visible in the address book. This is the default value.

5 OriginatingServer string Address of the server (domain name), where the object physically exists  
6 ProxyAddresses ADProxyAddressInfo[] The list of Email addresses  
7 UserPrincipalName string Primary Email address of the POP/IMAP mailbox

 

 

 

Examples of using Get-PopImapMailbox cmdlet

Getting the POP/IMAP mailbox by EmailAddress:

Get-PopImapMailbox -Identity ted@accountname.hostpilot.com

Getting not more than 7 mailboxes, which Email starts with "john":

Get-PopImapMailbox -Identity "john*" -ResultSize 7