NetCmdlets 2016
NetCmdlets 2016
Questions / Feedback?

Get-SMIMEIMAP Cmdlet

Parameters   Output Objects   Configuration Settings  

The Get-SMIMEIMAP cmdlet is used to retrieve electronic mail from Internet Message Access (IMAP) servers.

Syntax

Get-SMIMEIMAP [parameters]

Remarks

This cmdlet is the SMIME enabled equivalent of GETIMAP. In addition to implementing a standard Internet Message Access Protocol (IMAP) client as specified in RFC 1730 and RFC 2060 for retrieving email and listing mail folders (mailboxes), the cmdlet can decrypt and/or verify SMIME email messages.

To use the cmdlet to retrieve email, you must specify a mail Server, User, and Password. Specify the Folder for the mailbox you wish to connect to. The email message (or range of messages) to download is given by View.

Retrieved email messages will be returned in one or more EmailMessages. Brief information (Id, From, Subject, and size) about each retrieved email will be returned in one or more MessageHeaderss.

You may also list all of your mailboxes by setting the ListFolders switch. Folders will be returned in one or more MailBoxObjects.


# get a list of the mailboxes
get-imap -server mailserver -credential $cred -listfolders
# list the last 5 messages to arrive from the default mailbox (INBOX)
get-imap -server mailserver -credential $cred -list 5
# view message number 8320 in the "Archive" mailbox
get-imap -server mailserver -credential $cred -folder "INBOX.Archive" -view 8320

Connection Handling

This cmdlet supports persistent connections through the Connection parameter. To establish a new SMIMEIMAP connection, use the Connect-SMIMEIMAP cmdlet. To close the connection, use the Disconnect-SMIMEIMAP 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.
ACLIndicates whether or not to list the mailbox ACLs.
AuthMechanismThe authentication mechanism to be used when connecting to the mail server.
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.
FolderThe IMAP folder to which to connect.
ForceForces the cmdlet to accept the default behavior instead of querying the user.
HeadersOnlyIf true, only message headers will be fetched.
ListNumber of messages to list.
ListFoldersIndicates whether or not to perform a List Mailboxes operation on the IMAP server.
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.
PartIf set, the cmdlet will retrieve the content of the part from the server.
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.

SMIMEIMAPEmailMessageObject containing the entire text of the email message.

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]