Connect-IMAPCmdlet
Parameters Output Objects Config Settings
The Connect-IMAP cmdlet is used to create a persistent connection object.
Syntax
$cnn = Connect-IMAP [parameters]
Remarks
This cmdlet allows you to create a persistent connection object to be used with related cmdlets.When executing the cmdlet a connection object is returned. Pass this object to the Connection parameter of related cmdlets to use the newly created connection object.
To disconnect call Disconnect-IMAP.
Parameter List
The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.
| LogFile | The location of a file to which debug information is written. |
| 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 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 component to accept the default behavior instead of querying the user. |
| 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. |
| SSL | Determines how the component 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. |
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.
| IMAPConnection | The connection object. |
Config Settings
The following is a list of config settings for the cmdlet with short descriptions. Click on the links for further details.
| MessageCount | Number of messages in the mailbox. |
| AlwaysReturnUIDs | Instructs the server to return UIDs even if not in UIDMode. |
| AppendToMailboxDateTime | Specifies the date-time parameter used in the initial APPEND request. |
| AuthorizationIdentity | The value to use as the authorization identity when SASL authentication is used. |
| AutoDecodeSubject | Instructs the component to automatically decode message subjects. |
| AutoDecodeText | Whether to decode MessageText when AutoDecodeParts is True. |
| FetchAfterSearch | Determines if messages matching the SearchCriteria are fetched after calling SearchMailbox. |
| FetchTextAndHeaders | Specifies whether the message body and headers are fetched in a single request. |
| IncludeHeaders | Instructs the component to include the headers in the LocalFile. |
| MaskSensitive | Whether sensitive properties should be masked when logging. |
| SendIDCommand | Instructs component to send the ID command if the server advertises support for it. |
| UTF7MailboxNames | Specifies whether or not to automatically encode and decode UTF-7 mailbox names. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component 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. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| 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 component 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. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| 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. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitive | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
LogFile Parameter (Connect-IMAP Cmdlet)
The location of a file to which debug information is written.
Syntax
Connect-IMAP -LogFile string
Remarks
When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.Default Value
null
AuthMechanism Parameter (Connect-IMAP Cmdlet)
The authentication mechanism to be used when connecting to the mail server.
Syntax
Connect-IMAP -AuthMechanism string
Remarks
Default Value
0
CertPassword Parameter (Connect-IMAP Cmdlet)
The password to the certificate store.
Syntax
Connect-IMAP -CertPassword string
Remarks
Default Value
""
Parameter Alias
CertificatePassword
CertStore Parameter (Connect-IMAP Cmdlet)
The name of the certificate store for the client certificate.
Syntax
Connect-IMAP -CertStore string
Remarks
Default Value
"MY"
Parameter Alias
CertificateStore
CertStoreType Parameter (Connect-IMAP Cmdlet)
The type of certificate store for the client certificate.
Syntax
Connect-IMAP -CertStoreType string
Remarks
Default Value
0
CertSubject Parameter (Connect-IMAP Cmdlet)
The subject of the certificate used for client authentication.
Syntax
Connect-IMAP -CertSubject string
Remarks
Default Value
"*"
Config Parameter (Connect-IMAP Cmdlet)
Specifies one or more configuration settings.
Syntax
Connect-IMAP -Config string[]
Remarks
Default Value
null
CreateFolder Parameter (Connect-IMAP Cmdlet)
Creates a mailbox.
Syntax
Connect-IMAP -CreateFolder SwitchParameter
Remarks
Default Value
false
Credential Parameter (Connect-IMAP Cmdlet)
The PSCredential object to use for user/password authentication.
Syntax
Connect-IMAP -Credential PSCredential
Remarks
Default Value
null
Parameter Position
1
Parameter Alias
auth
FirewallHost Parameter (Connect-IMAP Cmdlet)
Name or IP address of firewall.
Syntax
Connect-IMAP -FirewallHost string
Remarks
Default Value
""
FirewallPassword Parameter (Connect-IMAP Cmdlet)
A password if authentication is to be used when connecting through the firewall.
Syntax
Connect-IMAP -FirewallPassword string
Remarks
Default Value
""
FirewallPort Parameter (Connect-IMAP Cmdlet)
The port of the firewall to which to connect.
Syntax
Connect-IMAP -FirewallPort int
Remarks
Default Value
0
FirewallType Parameter (Connect-IMAP Cmdlet)
Determines the type of firewall to connect through.
Syntax
Connect-IMAP -FirewallType string
Remarks
Default Value
0
FirewallUser Parameter (Connect-IMAP Cmdlet)
A user name if authentication is to be used connecting through a firewall.
Syntax
Connect-IMAP -FirewallUser string
Remarks
Default Value
""
Folder Parameter (Connect-IMAP Cmdlet)
The IMAP folder to which to connect.
Syntax
Connect-IMAP -Folder string
Remarks
Default Value
""
Parameter Alias
Mailbox
Force Parameter (Connect-IMAP Cmdlet)
Forces the component to accept the default behavior instead of querying the user.
Syntax
Connect-IMAP -Force SwitchParameter
Remarks
Default Value
false
LocalIP Parameter (Connect-IMAP Cmdlet)
The IP address of the local interface to use.
Syntax
Connect-IMAP -LocalIP string
Remarks
Default Value
""
Parameter Alias
LocalAddress
LogFile Parameter (Connect-IMAP Cmdlet)
The location of a file to which debug information is written.
Syntax
Connect-IMAP -LogFile string
Remarks
Default Value
""
MessageFlags Parameter (Connect-IMAP Cmdlet)
The flags of the message to add to IMAP server.
Syntax
Connect-IMAP -MessageFlags string
Remarks
Default Value
""
MessageHeaders Parameter (Connect-IMAP Cmdlet)
The headers of the message to add to IMAP server.
Syntax
Connect-IMAP -MessageHeaders string
Remarks
Default Value
""
MessageText Parameter (Connect-IMAP Cmdlet)
The text of the message to add to IMAP server.
Syntax
Connect-IMAP -MessageText string
Remarks
Default Value
""
Password Parameter (Connect-IMAP Cmdlet)
The password to use for authentication.
Syntax
Connect-IMAP -Password string
Remarks
Default Value
""
Port Parameter (Connect-IMAP Cmdlet)
The TCP port in the remote host to which to connect.
Syntax
Connect-IMAP -Port int
Remarks
Default Value
143
Server Parameter (Connect-IMAP Cmdlet)
The address of the Server.
Syntax
Connect-IMAP -Server string
Remarks
Default Value
""
Parameter Position
0
This is a required parameter.
SSL Parameter (Connect-IMAP Cmdlet)
Determines how the component starts SSL negotiation.
Syntax
Connect-IMAP -SSL string
Remarks
Default Value
3
SSLAccept Parameter (Connect-IMAP Cmdlet)
The encoded public key of the certificate which is to be trusted explicitly.
Syntax
Connect-IMAP -SSLAccept string
Remarks
Default Value
""
Parameter Alias
Accept
Timeout Parameter (Connect-IMAP Cmdlet)
The maximum time allowed for the operation.
Syntax
Connect-IMAP -Timeout int
Remarks
Default Value
10
User Parameter (Connect-IMAP Cmdlet)
The username to use for authentication.
Syntax
Connect-IMAP -User string
Remarks
Default Value
""
IMAPConnection Output Object (Connect-IMAP Cmdlet)
The connection object.
Syntax
Object IMAPConnection {string AuthMechanism;
string CertPassword;
string CertStore;
string CertStoreType;
string CertSubject;
string[] Config;
PSCredential Credential;
string FirewallHost;
string FirewallPassword;
int FirewallPort;
string FirewallType;
string FirewallUser;
SwitchParameter Force;
string LocalIP;
string LogFile;
string Password;
int Port;
string Server;
string SSL;
string SSLAccept;
int Timeout;
string User;
}