Adding a Connection to IMAP

To add a connection to IMAP:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the IMAP icon is not available, click the Add More icon to download and install the IMAP connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

The User and Password properties in the Authentication section must be set to valid credentials. The Server must be specified to retrieve emails and the SMTPServer must be specified to send emails.

Deprecation notice for Gmail users

From May 30, 2022, Google no longer supports the use of third-party apps or devices which ask you to sign in to your Google Account using only your username and password. There are alternatives that allow your continued use of our Email drivers to connect to your Google account, which is why Gmail-specific columns, pseudo-columns, and stored procedures are only getting deprecated. We recommend you move to our Gmail drivers that offer more secure methods of authentication.

This section details a selection of advanced features of the IMAP Sync App.

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to IMAP and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Customizing the SSL Configuration

To enable TLS, set SSLMode to AUTO, IMPLICIT, or EXPLICIT. See this connection property's page (Connection String Options > Authentication > SSLMode) for more information about how each SSL mode works.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• 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 is running on.
• ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Sync App connects to mail servers using standard mail protocols for IMAP, POP, and SMTP, as defined by the following RFCs:

For IMAP, the Sync App implements a standard IMAP client, as specified in RFC 1730 and RFC 2060.

For POP, the Sync App implements a standard Internet post office (POP3) client, as specified in RFC 1725.

And, finally, for SMTP, the Sync App implements a standard SMTP client, as specified in RFC 821.

IMAP Specific Information

Email address fields accept the following formats for email addresses:

• "Friendly Name" <[email protected]>
• [email protected]

SELECT

Email will be listed newest to oldest. By default, the MessageBody and Headers will not be returned when listing multiple messages.

Note: By default, the max number of messages returned will be 100. This can be changed by setting either LIMIT or MaxItems. If you wish to return all email within a mailbox, you will need to specify a value of 0 or -1.

List Mail Messages

To list messages within a specific mailbox, specify the mailbox as the table. This will list the most recent messages.

Alternatively, you can specify a range of message Ids to list. This includes the following formats:

WHERE Id='10' //For returning only the message with an Id of 10.
WHERE Id BETWEEN 10 AND 20 //For returning all messages from 10 to 20.
WHERE Id IN (1,3,5) //For returning messages 1, 3, 5.

Search Email

To search mail, simply specify a value for any of the following columns in the WHERE clause: To, From, BCC, CC, Subject, MessageBody, Flags, Labels, Size, or Date. This includes complex statements. For example:

Note that the CONTAINS function requires full words (For example Test, not Tes), just like the search bar from the UI. For example:

SELECT * FROM [Inbox] WHERE CONTAINS(MessageBody, "Test") AND ([From] = [email protected] OR [From] = [email protected]) AND Date>'1-1-2012'

This will return all messages where the message body contains the text 'Test', and the message is from either [email protected] or [email protected].

In addition to searching by standard columns, you can also search by attachment file names and by whether or not an attachment is on the email. For example:

SELECT * FROM [Inbox] WHERE HasAttachment='True' AND Attachments='.txt'

Use of parentheses is also supported for complex WHERE clauses.

As an alternative to the above method of creating search criteria, the SearchCriteria pseudo column is also available. This will accept any valid IMAP search criteria as specified by RFC.

INSERT

Please refer to the SMTP section.

UPDATE

To move an email from one mailbox to another, you will need to specify the Mailbox in the SET clauses of the message and the ID in the WHERE clause. For example:

UPDATE [Inbox] SET Mailbox='NewMailboxName' WHERE Id='MessageId'

Id may consist of a single message number, a range of messages specified by two message numbers separated by ':' (e.g. "1:5"), and/or individual message numbers separated by ',' (e.g. "1:5,7,10").

When moving an email from one mailbox to another, you may not specify any additional updates.

Additional Notes

By default, the number of messages returned per page will be 25. To change this, you can set the ItemsPerPage pseudo column.

All message Ids returned are temporary Ids and may change in subsequent requests to the server. To use static Ids, you can set UIDMode=true. However, only listing messages is supported with UIDs.

POP Specific Information

Email address fields contained within this table accept the following formats:

• 'Friendly Name' <[email protected]>
• [email protected]

SELECT

Email will be listed newest to oldest. By default, the MessageBody and Headers will not be returned when listing multiple messages.

Note: By default, the max number of emails returned will be 100. This can be changed by setting either LIMIT or MaxItems. If you wish to return all emails, you will need to specify a value of 0 or -1.

List Emails

To list messages, simply call SELECT after specifying the account information. This will list the most recent messages first.

To specify a single Id, which will return headers and the message body, you can specify the following:

WHERE Id='10' //For returning only the message with an Id of 10.

To list messages beginning with a specific Id, you can set the StartId property in the WHERE clause. This will cause messages to begin with the Id you specified, to the oldest message available within the LIMIT.

WHERE StartId='45' //Returns messages 45 through 1

Search Emails

Searching is not supported by the POP protocol. In order to search emails, you must use IMAP.

INSERT

Please refer to the SMTP section.

UPDATE

Updating is not supported by the POP protocol.

Additional notes

By default, the number of messages returned per page will be 25. To change this, you can set the ItemsPerPage pseudo column.

All message Ids returned are temporary Ids and may change in subsequent requests to the server. To use static Ids, you can set UIDMode=true. However, only listing messages is supported with UIDs.

SMTP Specific Information

Email address fields accept both the email addresses and the email address accompanied by the username; for example, "Friendly Name" <[email protected]>

INSERT

When sending mail with either POP or IMAP, SMTP is used to send the message to the mail server.

To send mail, you can insert a row into the table. Required fields are Subject, To, and MessageBody. For example:

INSERT INTO [Inbox] (Subject, MessageBody, To) VALUES ('Test Subject','Body Text','[email protected]')

Additional notes

By default, the From field will be populated with the email address supplied in the account. If it is not a complete email address, be sure to set From before sending a message.

The CData Sync App models IMAP entities as relational tables and stored procedures.

Tables

Tables describes how to query mailboxes as a table. The Sync App detects the available mailboxes at run time.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

The Sync App models the data in IMAP as a list of tables in a relational database that can be queried using standard SQL statements.

Email Connector for CData Sync Tables

Name	Description
MailMessages	List, search, delete, and move IMAP messages. List and delete POP messages. And send messages with SMTP.

List, search, delete, and move IMAP messages. List and delete POP messages. And send messages with SMTP.

This schema is defined for all tables. Each table name will be a mailbox folder on the server.

Table Specific Information

You can use square brackets to escape the table names of mailbox folders.

Protocol Information

For more specifics on using this table with IMAP, POP, and SMTP, refer to Supported Mail Protocols.

Deprecation notice for Gmail users

From May 30, 2022, Google no longer supports the use of third-party apps or devices which ask you to sign in to your Google Account using only your username and password. There are alternatives that allow your continued use of our Email drivers to connect to your Google account, which is why Gmail-specific columns, pseudo-columns, and stored procedures are only getting deprecated. We recommend you move to our Gmail drivers that offer more secure methods of authentication.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	Identifier of the mail message.
Mailbox	String	True	The current mailbox that the item is listed in.
Subject	String	False	The subject of the current message.
From	String	True	The sender email address of the current message.
FullFrom	String	True	The sender name and email address of the current message.
To	String	False	The semicolon-separated list of email addresses of the recipients.
FullTo	String	False	The semicolon-separated list of names and email addresses of the recipients.
CC	String	False	The semicolon-separated list of names and email addresses of the CCed recipients.
BCC	String	False	The semicolon-separated list of names and email addresses of the BCCed recipients (only applicable for sent mail).
Date	String	True	The date the current message was sent.
MessageBody	String	False	The message body. To set this field, specify a single Id in SELECT or set IncludeMessage to true.
MessageDisplayText	String	False	A text representation of an email's content. It displays either the HTML content or plain text, depending on the value provided by IsHTML connection property or pseudo-column. To set this field, specify a single Id in SELECT or set IncludeMessage to true.
Attachments	String	False	Semicolon-separated list of the attachment file names (with path if reading from a file) included in the message.
AttachmentData	String	False	Semicolon-separated list of the base-64-encoded attachment data included in the message. (You must still specify the file name in Attachments.)
Size	Int	True	The size in bytes of the current message.
Flags	String	False	The flags set on the current message.
Labels	String	False	The labels of the message, separated by spaces. Gmail treats labels as mailboxes.
ThreadId	String	True	The Gmail thread Id associated with the current message. Several messages may have the same thread Id.
MsgId	String	True	The message Id associated with the current message. For Gmail, this is a globally unique Id assigned by Google separate from the IMAP Id/UID.
PartIds	String	True	The Id of the message part.
PartFilenames	String	True	The file name of the message part.
PartContentTypes	String	True	The content type of the message part.
PartSizes	String	True	The size of the message part.
Headers	String	True	The message headers for the specified mail message. Available only if you specify a single Id in SELECT.
AttachmentHeaders	String	True	A newline-separated list of the headers associated with each attachment.
ContentIds	String	True	A semicolon-separated list of Content-Id headers for each attachment.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
ItemsPerPage	String	Maximum number of items to return per page. The default value is 25.
SearchCriteria	String	The search criteria to use for the search operation (e.g., SENTSINCE dd-MMM-yyyy). The exact format of the search criteria is specified by the IMAP RFCs. The string consists of one or more search keys and their corresponding values (if any) separated by spaces; for example, 'SINCE 1-Feb-1994 NOT FROM Smith'.
UIDMode	String	If true, permanent message Ids are used instead of the default temporary Ids. The default value is FALSE.
DownloadAttachments	String	If true, attachments will be downloaded with the messages. Available only when specifying a single message Id or the Include Messages connection property is true. The default value is FALSE.
AttachmentFolder	String	Folder to download attachments to. If this is set, the AttachmentData column will not contain data: The data will be written to files.
EMLFolder	String	Folder to download the complete MIME message, which is saved as an EML file. If multiple messages are selected, subfolders will be created for each message.
Overwrite	String	Whether or not to overwrite attachments and EML files. The default value is FALSE.
IsHTML	String	Whether the email is HTML or plain text. The default value is TRUE.
Importance	String	Importance of the mail message. The allowed values are UNSPECIFIED, LOW, NORMAL, HIGH. The default value is UNSPECIFIED.
Priority	String	Priority of the mail message. The allowed values are UNSPECIFIED, NONURGENT, URGENT, NORMAL. The default value is UNSPECIFIED.
Sensitivity	String	Sensitivity of the mail message. The allowed values are UNSPECIFIED, PERSONAL, PRIVATE, COMPANYCONFIDENTIAL. The default value is UNSPECIFIED.
DeliveryNotification	String	Email address to send a delivery notification to.
ReadReceipt	String	Email address to send a read receipt to.
ShowLabels	String	Whether to show labels or not. The EmailService connection property must be set to Gmail. The default value is TRUE.
ShowThreadId	String	Whether to show the thread Id or not. The EmailService connection property must be set to Gmail. The default value is TRUE.
ShowMsgId	String	Whether to show the Msg Id or not. The EmailService connection property must be set to either Gmail or Outlook. The default value is TRUE.
HasAttachments	String	If true, only messages with attachments will be listed. If false, all messages will be listed. The EmailService connection property must be set to Gmail.

The connection string 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 string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

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.

SMTP

---

Property	Description
SMTPServer	The name or address of the mail server (SMTP server).
SMTPPort	The server port for SMTP (default 25).

SSL

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies 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 connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous

---

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	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
MessageCharset	Specifies the session character set for decoding character data transferred from the IMAP server.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UIDMode	If true, permanent message Ids are used instead of the default temporary Ids.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

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.

The type of email server to connect to.

Remarks

Possible values include POP and IMAP. The default value of this field is IMAP.

The user of the Email account used to authenticate.

Remarks

Together with Password, this field is used to authenticate to the email servers.

The password of the email account used to authenticate.

Remarks

Together with User, this field is used to authenticate to the email servers.

The name or address of the mail server.

Remarks

This property specifies the IP address or the domain name of the mail server. It must be set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a domain name, a DNS request is initiated.

If the connection is configured to use a SOCKS firewall, the value assigned to this property may be preceded with a "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

The port of the mail server. The default value is 143 for IMAP and 110 for POP.

Remarks

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established.

The authentication mechanism to be used when connecting to the Email server.

Remarks

If SSLMode is set to NONE, default plaintext authentication is used to log in to the server. If SSLMode is set to IMPLICIT, the SSL negotiation will start immediately after the connection is established. If SSLMode is set to EXPLICIT, the Sync App will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS. If SSLMode is set to AUTO, if the remote port is set to the standard plaintext port of the protocol (where applicable), the component will behave the same as if SSLMode is set to EXPLICIT. In all other cases, SSL negotiation will be IMPLICIT.

• AUTO
• NONE
• IMPLICIT
• EXPLICIT

This section provides a complete list of the SMTP properties you can configure in the connection string for this provider.

---

Property	Description
SMTPServer	The name or address of the mail server (SMTP server).
SMTPPort	The server port for SMTP (default 25).

The name or address of the mail server (SMTP server).

Remarks

This property specifies the IP address or domain name of the mail server. It must be set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a domain name, a DNS request is initiated.

If the connection is configured to use a SOCKS firewall, the value assigned to this property may be preceded with a "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

The server port for SMTP (default 25).

Remarks

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.

Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to IMAP. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to IMAP. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to IMAP. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies 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 connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NTLM: The Sync App retrieves an NTLM token.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The user name of a user registered with the proxy server.
DIGEST	The user name of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE	Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

The password associated with the user specified in the ProxyUser connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\\CData\\Email Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

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	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
MessageCharset	Specifies the session character set for decoding character data transferred from the IMAP server.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UIDMode	If true, permanent message Ids are used instead of the default temporary Ids.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Optimizes the IMAP connection for the service you are working with.

Remarks

Possible values include AOL, Gmail, Outlook, Yahoo, and Other.

Whether to include message body content and attachment data or not.

Remarks

Whether to include message body content and attachment data or not.

Determines whether to return the MessageBody as HTML or plain-text.

Remarks

Determines whether to return the MessageBody as HTML or plain-text.

Determines whether to keep the connection alive across instances.

Remarks

Determines whether to keep the connection alive across instances.

Whether to list all mailboxes or just the subscribed IMAP mailboxes. IMAP Only.

Remarks

Whether to list all mailboxes or just the subscribed IMAP mailboxes. IMAP Only.

• All
• Subscribed

Maximum number of items to return.

Remarks

Maximum number of items to return.

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies the session character set for decoding character data transferred from the IMAP server.

Remarks

Specifies the session character set for decoding character data transferred from the IMAP server. The default value is UTF-8. Set it to 'None' to leave the charset unspecified. This can resolve some timeout errors that can be caused by an incorrect charset configuration.

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

If true, permanent message Ids are used instead of the default temporary Ids.

Remarks

The default value for UIDMode is false.

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:

{
	"MyView": {
		"query": "SELECT * FROM [INBOX] WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.