Get-POP Cmdlet
Parameters Output Objects Configuration Settings
The Get-POP cmdlet is used to retrieve electronic mail from Internet Post Office (POP) servers.
Syntax
Get-POP [parameters]
Remarks
This cmdlet implements a standard Internet Post Office (POP3) client as specified in RFC 1725 for retrieving email messages.
To use the cmdlet to retrieve email, you must specify a mail Server and Credential. If the View parameter is set, the specified message will be retrieved in EmailMessage.
If View is not set, the cmdlet will retrieve a list of the messages on the server in one or more MessageHeaderss.
To use SSL-enabled (RFC 2595) POP, set SSL to True.
This cmdlet handles retrieving emails and listing email folders. To send an email, see the SEND-EMAIL cmdlet.
The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.
# list the last 10 messages to arrive get-pop -server mailserver -credential $cred -list 10# view message number 43 get-pop -server mailserver -credential $cred -view 43Connection Handling
This cmdlet supports persistent connections through the Connection parameter. To establish a new POP connection, use the Connect-POP cmdlet. To close the connection, use the Disconnect-POP cmdlet.
Parameter List
The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.
| Connection | An already established connection. |
| LogFile | The location of a file to which debug information is written. |
| AttachmentDirectory | Specifies the directory where attachments are downloaded. |
| CertPassword | The password to the certificate store. |
| CertStore | The name of the certificate store for the client certificate. |
| CertStoreType | The type of certificate store for the client certificate. |
| CertSubject | The subject of the certificate used for client authentication. |
| Config | Specifies one or more configuration settings. |
| Credential | The PSCredential object to use for user/password authentication. |
| FirewallHost | Name or IP address of firewall. |
| FirewallPassword | A password if authentication is to be used when connecting through the firewall. |
| FirewallPort | The port of the firewall to which to connect. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| Force | Forces the cmdlet to accept the default behavior instead of querying the user. |
| List | Number of messages to list. |
| LocalFile | Part is stored here if this property is set. |
| LocalIP | The IP address of the local interface to use. |
| LogFile | The location of a file to which debug information is written. |
| PartType | The ContentType to return when viewing a message. |
| Password | The password to use for authentication. |
| Port | The TCP port in the remote host to which to connect. |
| Server | The address of the Server. |
| SSL | Determines how the cmdlet starts SSL negotiation. |
| SSLAccept | The encoded public key of the certificate which is to be trusted explicitly. |
| Timeout | The maximum time allowed for the operation. |
| User | The username to use for authentication. |
| View | The message number to view. |
Output Objects
The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.
| MessageHeaders | Object containing brief information about the returned email. |
| POPEmailMessage | Object containing the full text of the returned email. |
Configuration Settings
The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.
| MessageCount | Number of messages in the mailbox. |
| AuthorizationIdentity | The value to use as the authorization identity when SASL authentication is used. |
| GetMessageSize | Whether to poll the server for the message size prior to retrieving it. |
| MaxLineLength | The maximum expected length for message lines. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the cmdlet whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the cmdlet binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| UseBackgroundThread | Whether threads created by the cmdlet are background threads. |
| UseInternalSecurityAPI | Tells the cmdlet whether or not to use the system security libraries or an internal implementation. |