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.


Connection	An already established connection.
LogFile	The location of a file to which debug information is written.
ACL	Indicates whether or not to list the mailbox ACLs.
AuthMechanism	The authentication mechanism to be used when connecting to the mail server.
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.
Folder	The IMAP folder to which to connect.
Force	Forces the cmdlet to accept the default behavior instead of querying the user.
HeadersOnly	If true, only message headers will be fetched.
List	Number of messages to list.
ListFolders	Indicates whether or not to perform a List Mailboxes operation on the IMAP server.
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.
Part	If set, the cmdlet will retrieve the content of the part from the server.
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.


SMIMEIMAPEmailMessage	Object 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.


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.