Connection Properties
The connection properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection settings for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
Property | Description |
Protocol | The type of email server to connect to. |
User | The user of the Email account used to authenticate. |
Password | The password of the email account used to authenticate. |
Server | The name or address of the mail server. |
Port | The port of the mail server. The default value is 143 for IMAP and 110 for POP. |
SSLMode | The authentication mechanism to be used when connecting to the Email server. |
Property | Description |
SMTPServer | The name or address of the mail server (SMTP server). |
SMTPPort | The server port for SMTP (default 25). |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
Property | Description |
ProxyAutoDetect | When this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server. |
ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
ProxyPort | The TCP port that the proxy server (specified in the ProxyServer connection property) is running on. |
ProxyAuthScheme | The authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connnection property. |
ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
Property | Description |
Logfile | A filepath which designates the name and location of the log file. |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
LogModules | Core modules to be included in the log file. |
MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
MaxLogFileCount | A string specifying the maximum file count of log files. |
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
Property | Description |
EmailService | Optimizes the IMAP connection for the service you are working with. |
IncludeMessage | Whether to include message body content and attachment data or not. |
IsHTML | Determines whether to return the MessageBody as HTML or plain-text. |
KeepAlive | Determines whether to keep the connection alive across instances. |
ListMailboxes | Whether to list all mailboxes or just the subscribed IMAP mailboxes. IMAP Only. |
MaxItems | Maximum number of items to return. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
MessageCharset | Specifies the session character set for decoding character data transferred from the IMAP server. |
Other | These hidden properties are used only in specific use cases. |
PseudoColumns | Specify a set of pseudocolumns to expose as columns. |
Readonly | You can use this property to enforce read-only access to IMAP from the provider. |
RTK | The runtime key used for licensing. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UIDMode | If true, permanent message Ids are used instead of the default temporary Ids. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |