Get-SMIMEPOP Cmdlet
Parameters Output Objects Configuration Settings
The Get-SMIMEPOP cmdlet is used to retrieve electronic mail from Internet Post Office (POP) servers.
Syntax
Get-SMIMEPOP [parameters]
Remarks
This cmdlet is the SMIME enabled equivalent of GETPOP. In addition to implementing a standard Internet Post Office (POP3) client as specified in RFC 1725 for retrieving email messages, the cmdlet can decrypt and/or verify SMIME 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. To delete the message after downloading and viewing it, set the Delete switch. The messages specified by View will be deleted when the cmdlet disconnects.
If View is not set, the cmdlet will retrieve a list of the messages on the server in one or more MessageHeaderss.
The CertStoreType, CertStore, CertPassword, and CertSubject parameters specify the decryption certificate.
The SignerCertStoreType, SignerCertStore SignerCertPassword, and SignerCertSubject parameters specify the recipient's public certificate used for signature verification.
#Decrypt a messageGet-SMIMEPOP -Server mailserver -User test -Password test -view 123 -SMIME Decrypt -CertStore c:\mine.pfx -CertStoreType PFXFile -CertPassword test -CertSubject *#Verify the signature of a messageGet-SMIMEPOP -Server mailserver -User test -Password test -view 124 -SMIME Verify -SignerCertStoreType PublicKeyFile -SignerCertStore c:\sender.public.cer -SignerCertSubject *#Decrypt and Verify the signatureGet-SMIMEPOP -Server mailserver -User test -Password test -view 125 -SMIME DecryptAndVerify -CertStore c:\mine.pfx -CertStoreType pfxfile -CertPassword test -CertSubject * -SignerCertStore c:\sender.public.cer -SignerCertSubject * -SignerCertStoreType PublicKeyFileConnection Handling
This cmdlet supports persistent connections through the Connection parameter. To establish a new SMIMEPOP connection, use the Connect-SMIMEPOP cmdlet. To close the connection, use the Disconnect-SMIMEPOP 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. |
| CertPassword | The password to the certificate store. |
| CertStore | The name of the certificate store for the decryption certificate. |
| CertStoreType | The type of certificate store for the decryption certificate. |
| CertSubject | The subject of the certificate used for decryption. |
| 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. |
| 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. |
| SignerCertPassword | The password to the certificate store. |
| SignerCertStore | The name of the certificate store for the signature verification certificate. |
| SignerCertStoreType | The type of certificate store for the signature verification certificate. In most cases PublicKeyFile is used. |
| SignerCertSubject | The subject of the recipient's public certificate used for signature verification. |
| SMIME | Specifies the expected protection level on the received messages. |
| 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.
| SMIMEPOPEmailMessage | 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.
| 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. |