NetCmdlets 2016
NetCmdlets 2016
Questions / Feedback?

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 message
Get-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 message
Get-SMIMEPOP -Server mailserver -User test -Password test -view 124 -SMIME Verify -SignerCertStoreType PublicKeyFile -SignerCertStore c:\sender.public.cer -SignerCertSubject *

#Decrypt and Verify the signature
Get-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 PublicKeyFile

Connection 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.

ConnectionAn already established connection.
LogFileThe location of a file to which debug information is written.
CertPasswordThe password to the certificate store.
CertStoreThe name of the certificate store for the decryption certificate.
CertStoreTypeThe type of certificate store for the decryption certificate.
CertSubjectThe subject of the certificate used for decryption.
ConfigSpecifies one or more configuration settings.
CredentialThe PSCredential object to use for user/password authentication.
FirewallHostName or IP address of firewall.
FirewallPasswordA password if authentication is to be used when connecting through the firewall.
FirewallPortThe port of the firewall to which to connect.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
ForceForces the cmdlet to accept the default behavior instead of querying the user.
ListNumber of messages to list.
LocalFilePart is stored here if this property is set.
LocalIPThe IP address of the local interface to use.
LogFileThe location of a file to which debug information is written.
PasswordThe password to use for authentication.
PortThe TCP port in the remote host to which to connect.
ServerThe address of the Server.
SignerCertPasswordThe password to the certificate store.
SignerCertStoreThe name of the certificate store for the signature verification certificate.
SignerCertStoreTypeThe type of certificate store for the signature verification certificate. In most cases PublicKeyFile is used.
SignerCertSubjectThe subject of the recipient's public certificate used for signature verification.
SMIMESpecifies the expected protection level on the received messages.
TimeoutThe maximum time allowed for the operation.
UserThe username to use for authentication.
ViewThe 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.

SMIMEPOPEmailMessageObject 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.

CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
NetCmdlets 2016 - Version 16.0 [Build 6335]