Cloud

Build 25.0.9540
  • Email
    • はじめに
      • 接続の確立
      • SSL の設定
      • ファイアウォールとプロキシ
    • サポートされるMail プロトコル
      • IMAP
      • POP
      • SMTP
    • データモデル
      • Tables
        • MailMessages
      • ストアドプロシージャ
        • GetPartIMAP
        • GetPartPOP
        • MoveEmails
        • SendMailMessage
        • SetFlags
        • SetLabels
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • 接続文字列オプション
      • Authentication
        • Protocol
        • User
        • Password
        • Server
        • Port
        • SSLMode
      • SMTP
        • SMTPServer
        • SMTPPort
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • EmailService
        • IncludeMessage
        • IsHTML
        • KeepAlive
        • ListMailboxes
        • MaxItems
        • MaxRows
        • MessageCharset
        • PseudoColumns
        • ThrowsKeyNotFound
        • Timeout
        • UIDMode
    • Third Party Copyrights

Email - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるIMAP へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してIMAP に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、IMAP への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:IMAP は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

このページでは、CData Cloud でのIMAP への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

IMAP への接続

接続の確立 は、CData Cloud にデータベースを作成するためのIMAP への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してIMAP からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

CData Cloud

接続の確立

Database タブで対応するアイコンを選択して、IMAP に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Authentication セクションのUser プロパティとPassword プロパティに、有効な認証情報を設定する必要があります。E メールを取得するには、Server を指定する必要があります。E メールを送信するにはSMTPServer を指定する必要があります。

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.

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

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.

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

CData Cloud

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

  • ProxyServer:HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
  • ProxyPort:プロキシサーバーが起動しているTCP ポート。
  • ProxyAuthScheme:プロキシサーバーに対して認証する際にCloud が使用する認証方法。
  • ProxyUser:プロキシサーバーに登録されているユーザーアカウントのユーザー名。
  • ProxyPassword:ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

  • プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
  • 接続をトンネルするには、FirewallType をTUNNEL に設定します。
  • 認証するには、FirewallUser とFirewallPassword を設定します。
  • SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Cloud

サポートされるMail プロトコル

CData Cloud では、次のRFC で定義されたIMAP、POP、およびSMTP 向けの標準メールプロトコルを使ってメールサーバーへのアクセスを可能にします:

IMAPでは、Cloud は、RFC 1730 およびRFC 2060 で指定された標準IMAP クライアントとして実装されます。

POPでは、Cloud は、RFC 1725 で指定された標準POP3 クライアントとして実装されます。

SMTPでは、Cloud は、RFC 821 で指定された標準SMTP クライアントとして実装されます。

CData Cloud

IMAP

IMAP 固有の情報

E メールアドレスフィールドは、E メールアドレスとして次のフォーマットを受け付けます:

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

SELECT

E メールが新しいものから古いものの順でリストされます。デフォルトで、複数のメッセージをリストする場合には、MessageBody およびHeader は返されません。

Note:デフォルトで返されるメッセージの最大数は100 です。これは、LIMIT もしくはMaxItems を使用して変更できます。メールボックス内のすべてのメールを返したい場合には、0 もしくは-1 を設定してください。

メールメッセージをリスト

特定のメールボックス内のメッセージをリストするには、メールボックスをテーブルとして指定します。これは新しいメッセージからリストします。

別の方法として、リストするメッセージId の範囲を指定することができます。これには次の形式が含まれます:

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.
E メールを検索する:

メールを検索するには、次のカラムについてWHERE 句にて指定をします:To、From、BCC、CC、Subject、MessageBody、Flags、Labels、Size、またはDate。 これは複雑なステートメントを含むことができます。次に例を示します。

CONTAINS 関数には、UI の検索バーのように完全な単語(例えば、Tes ではなくTest)が必要であることに注意してください。 次に例を示します。

SELECT * FROM [Inbox] WHERE CONTAINS(MessageBody, "Test") AND ([From] = [email protected] OR [From] = [email protected]) AND Date>'1-1-2012'
これはメッセージbody に'Test' というテキストを含み、送信者が[email protected] もしくは[email protected] であるすべてのメッセージを返します。

標準カラムでの検索に加えて、添付ファイル名での検索および添付ファイルがあるかどうかでの検索も可能です。次に例を示します。

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

複雑なWHERE 句では、括弧の使用もサポートされています。

上記の検索クライテリアの作成方法の別の方法として、SearchCriteria 疑似カラムを使うこともできます。これは、RFC で指定されたあらゆる有効なIMAP 検索クライテリアを受け付けます。

INSERT

SMTP セクションを参照してください。

UPDATE

E メールをあるメールボックスから他のメールボックスに移動させる場合、SET 句でメールボックスを指定し、WHERE 句でID を指定します。次に例を示します。

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

Id はメッセージ番号、':' で区切られた2つのメッセージ番号の範囲(e.g. "1:5")、および/または',' で区切られた個別のメッセージ番号(e.g. "1:5,7,10")を含むことができます。

E メールをあるメールボックスから他のメールボックスに移動させる場合、追加の更新を同時に指定することはできません。

補足

デフォルトで返されるページごとのメッセージの最大数は25です。ItemsPerPage 疑似カラムを設定することで変更が可能です。

返されるすべてのメッセージId はテンポラリーId であり、続くサーバーへのリクエストにて変わることがあります。静的なId を使う場合は、UIDMode=true に設定します。UID では、メッセージのリストのみがサポートされています。

CData Cloud

POP

POP 固有の情報

このテーブル内に含まれるE メールアドレスフィールドは、次のフォーマットを受け付けます:

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

SELECT

E メールが新しいものから古いものの順でリストされます。デフォルトで、複数のメッセージをリストする場合には、MessageBody およびHeader は返されません。

Note:デフォルトで返されるE メールの最大数は100 です。これは、LIMIT もしくはMaxItems を使用して変更できます。すべてのメールを返したい場合には、0 もしくは-1 を設定してください。

E メールをリスト

メッセージをリストするには、アカウント情報を指定した後にSELECT を実行します。これは新しいメッセージからリストします。

Id を1つだけ指定して、ヘッダーおよびメッセージbody を返す場合には、次のように指定します:

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

特定のId から始まるメッセージをリストするには、WHERE 句にてStartId プロパティを設定します。これによりLIMIT 内の一番古いメッセージから指定したId のメッセージを表示します。

WHERE StartId='45' //Returns messages 45 through 1
E メールを検索する

POP プロトコルでは、検索はサポートされません。E メールの検索にはIMAP を使う必要があります。

INSERT

SMTP セクションを参照してください。

UPDATE

POP プロトコルでは、更新はサポートされません。

補足

デフォルトで返されるページごとのメッセージの最大数は25です。ItemsPerPage 疑似カラムを設定することで変更が可能です。

返されるすべてのメッセージId はテンポラリーId であり、続くサーバーへのリクエストにて変わることがあります。静的なId を使う場合は、UIDMode=true に設定します。UID では、メッセージのリストのみがサポートされています。

CData Cloud

SMTP

SMTP 固有の情報

E メールアドレスフィールドは、E メールアドレスおよびユーザー名を伴うE メールアドレスの両方を受け付けます。例えば、"Friendly Name" <[email protected]>。

INSERT

POP、もしくはIMAP でメールを送信する場合、メールサーバーへのメッセージ送付にはSMTP が使われます。

メールの送信には、テーブルに行を追加します。必須項目はSubject、To、およびMessageBody です。次に例を示します。

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

補足

デフォルトでFrom フィールドはアカウントの提供するE メールアドレスから生成されます。これが完全なE メールアドレスではない場合には、From を指定してからメッセージを送信してください。

CData Cloud

データモデル

CData Cloud は、IMAP エンティティをリレーショナルテーブルおよびストアドプロシージャにモデル化します。

テーブル

Tables では、メールボックスをテーブルとしてクエリする方法を説明します。Cloud は、ランタイムで使用可能なメールボックスを検出します。

ストアドプロシージャ

ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。

CData Cloud

Tables

Cloud はIMAP のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Email Tables

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

CData Cloud

MailMessages

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

このスキーマはすべてのテーブルに定義されます。すべてのテーブル名はサーバーのメールボックスフォルダとなります。

テーブル固有の情報

メールボックスフォルダのテーブル名をエスケープするには、角かっこを使うことができます。

プロトコル情報

このテーブルをIMAP、POP、およびSMTP と使うための詳細は、サポートされるMail プロトコル を参照してください。

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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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.

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、IMAP の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにIMAP から関連するレスポンスデータを返します。

CData Cloud - Email ストアドプロシージャ

Name Description
GetPartIMAP Gets the message part specified by LocalFile or PartId from the message specified by Id on the IMAP server.
GetPartPOP Gets the message part specified by LocalFile or PartId from the message specified by Id on the POP server.
MoveEmails Moves the messages specified by Ids to the mailbox specified by Mailbox .
SendMailMessage Sends the message to the specified recipient.
SetFlags Adds, removes, or replaces existing flags with the specified flags.
SetLabels Adds or Rpelaces exeisting Labels with the specified Labels.

CData Cloud

GetPartIMAP

Gets the message part specified by LocalFile or PartId from the message specified by Id on the IMAP server.

Input

Name Type Description
ID String The Id of the message that contains the part.
LocalFile String The local file where the content of the part will be written to.
Mailbox String The mailbox of the message that contains the part.
PartFileName String The part file name of the part to retrieve. Either the PartId or the PartFileName input must be specified.
PartID String The part Id of the part to retrieve. Either the part Id or the part file name input must be specified.
UIDMode String If true, permanent message Ids are used instead of the default temporary Ids.

Result Set Columns

Name Type Description
Content String If the LocalFile input is not specified, the base64 encoded content will be output. Otherwise, the path to the file containing the content will be output.
ContentType String The content type.
Size String The size of the message part.
FileName String The filename of the message part.
To String The list of recipients
From String The sender of the current message.
CC String The list of CCed recipients.
Subject String The subject of the current message.
Flags String The flags set on the current message.
Date String The date the current message was sent.

CData Cloud

GetPartPOP

Gets the message part specified by LocalFile or PartId from the message specified by Id on the POP server.

Input

Name Type Description
ID String The Id of the message that contains the part.
LocalFile String The local file where the content of the part will be written to.
PartFileName String The part file name of the part to retrieve. Either the part Id or the part file name input must be specified.
PartID String The part Id of the part to retrieve. Either the part Id or the part file name input must be specified.
UIDMode String If true, permanent message Ids are used instead of the default temporary Ids.

デフォルト値はFALSEです。

Result Set Columns

Name Type Description
Content String If the LocalFile input is not specified, the base64 encoded content will be output. Otherwise, the path to the file containing the content will be output.
ContentType String The content type.
Size String The size of the message part.
FileName String The filename of the message part.
To String The list of recipients
From String The sender of the current message.
CC String The list of CCed recipients.
Subject String The subject of the current message.
Flags String The flags set on the current message.
Date String The date the current message was sent.

CData Cloud

MoveEmails

Moves the messages specified by Ids to the mailbox specified by Mailbox .

Input

Name Type Description
Mailbox String The mailbox where the message is currently located.

デフォルト値はInboxです。

Id String This inputs indicates the set of messages to operate on. It may consist of a single message id, 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').
Destination String The mailbox where the message will be moved.

デフォルト値はInboxです。

Result Set Columns

Name Type Description
Success String Boolean response indicating whether or not the operation was successful.

CData Cloud

SendMailMessage

Sends the message to the specified recipient.

Note:このプロシージャは、インデックス付きパラメータを使用します。 インデックス付きパラメータは、プロシージャの入力として単一のパラメータを複数のインスタンスに提供することを容易にします。

Param# という名前の入力パラメータがあるとします。このようなインデックス付きパラメータの複数のインスタンスを入力するには、次のように実行します。

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

以下のInput テーブルでは、インデックス付きの入力パラメータは、名前の末尾に '#' 文字が付きます。

Input

Name Type Description
To String The semicolon-separated list of names and email addresses of the recipients.
Subject String The subject of the mail message.
From String The email address of the sender.
MessageBody String The message body.
CC String The semicolon-separated list of names and email addresses of the CCed recipients.
BCC String The semicolon-separated list of names and email addresses of the BCCed recipients.
Attachment# String Semicolon-separated list of the attachment file names (with path if reading from a file) included in the message.
AttachmentData# String Semicolon-separated list of the base-64-encoded attachment data included in the message. (You must still specify the filename in Attachments.)
InlineImage# String Semicolon-separated list of the inline image identifiers (cids) to be included in the message.
InlineImageData# String Semicolon-separated list of the base-64-encoded image data to be included in the message.
IsHTML String Whether the email is HTML or plain text.

デフォルト値はTRUEです。

Importance String Importance of the mail message.

使用できる値は次のとおりです。UNSPECIFIED, LOW, NORMAL, HIGH

デフォルト値はUNSPECIFIEDです。

Priority String Priority of the mail message.

使用できる値は次のとおりです。UNSPECIFIED, NONURGENT, URGENT, NORMAL

デフォルト値はUNSPECIFIEDです。

Sensitivity String Sensitivity of the mail message.

使用できる値は次のとおりです。UNSPECIFIED, PERSONAL, PRIVATE, COMPANYCONFIDENTIAL

デフォルト値はUNSPECIFIEDです。

DeliveryNotification String Email address to send a delivery notification to.
ReadReceipt String Email address to send a read receipt to.
Charset String The character set to use in the message.

デフォルト値はUTF-8です。

Result Set Columns

Name Type Description
MessageId String The Id for the message as returned by the server.

CData Cloud

SetFlags

Adds, removes, or replaces existing flags with the specified flags.

Input

Name Type Description
Mailbox String The mailbox where the message is located.

デフォルト値はInboxです。

Id String This inputs indicates the set of messages to operate on. It may consist of a single message id, 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').
Flags String Specifies the flags to apply to the target messages, provided as a comma-separated list (e.g., Seen,Deleted). Standard IMAP flags include Seen, Answered, Flagged, Deleted, Draft, and Recent, though servers may also support custom flags.

デフォルト値はSeenです。

OperationType String Specifies whether the provided flags should be added to, removed from, or used to replace the existing flag list.

使用できる値は次のとおりです。ADD, REPLACE, REMOVE

デフォルト値はREPLACEです。

Result Set Columns

Name Type Description
Success String Boolean response indicating whether or not the operation was successful.

CData Cloud

SetLabels

Adds or Rpelaces exeisting Labels with the specified Labels.

Input

Name Type Description
Mailbox String The Gmail mailbox where the message is located.

デフォルト値はInboxです。

Id String This inputs indicates the set of messages to operate on. It may consist of a single message id, 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').
Labels String List of labels to be set to the message specified by the MessageSet property. This input should be set to a comma separate list of labels.
OperationType String This indicates weather the specified labels should be added,removed or replace existing labels list.

使用できる値は次のとおりです。ADD, REPLACE, REMOVE

デフォルト値はREPLACEです。

Result Set Columns

Name Type Description
Success String Boolean response indicating whether or not the operation was successful.

CData Cloud

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、IMAP のデータベースメタデータを返します。

  • sys_catalogs:利用可能なデータベースをリスト。
  • sys_schemas:利用可能なスキーマをリスト。
  • sys_tables:利用可能なテーブルおよびビューをリスト。
  • sys_tablecolumns:利用可能なテーブルおよびビューのカラムについて説明。
  • sys_procedures:利用可能なストアドプロシージャについて説明。
  • sys_procedureparameters:ストアドプロシージャパラメータについて説明。
  • sys_keycolumns:主キーおよび外部キーについて説明。
  • sys_indexes:利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

  • sys_connection_props:利用可能な接続プロパティについての情報を返す。
  • sys_sqlinfo:Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

  • sys_identity:バッチ処理または単一の更新に関する情報を返す。

CData Cloud

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String データベース名。

CData Cloud

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String データベース名。
SchemaName String スキーマ名。

CData Cloud

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベース。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String テーブル名またはビュー名。
TableType String テーブルの種類(テーブルまたはビュー)。
Description String テーブルまたはビューの説明。
IsUpdateable Boolean テーブルが更新可能かどうか。

CData Cloud

sys_tablecolumns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、[INBOX] テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='[INBOX]' 

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベースの名前。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String カラムを含むテーブルまたはビューの名前。
ColumnName String カラム名。
DataTypeName String データ型の名前。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length Int32 カラムのストレージサイズ。
DisplaySize Int32 指定されたカラムの通常の最大幅(文字数)。
NumericPrecision Int32 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。
NumericScale Int32 カラムのスケール(小数点以下の桁数)。
IsNullable Boolean カラムがNull を含められるかどうか。
Description String カラムの簡単な説明。
Ordinal Int32 カラムのシーケンスナンバー。
IsAutoIncrement String カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn String 生成されたカラムであるかどうか。
IsHidden Boolean カラムが非表示かどうか。
IsArray Boolean カラムが配列かどうか。
IsReadOnly Boolean カラムが読み取り専用かどうか。
IsKey Boolean sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType String スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

CData Cloud

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベース。
SchemaName String ストアドプロシージャを含むスキーマ。
ProcedureName String ストアドプロシージャの名前。
Description String ストアドプロシージャの説明。
ProcedureType String PROCEDURE やFUNCTION などのプロシージャのタイプ。

CData Cloud

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、SendMailMessage ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SendMailMessage' AND Direction = 1 OR Direction = 2

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SendMailMessage' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName String データ型の名前。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。
Values String このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams Boolean パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath Boolean パラメータがスキーマ作成操作のターゲットパスかどうか。
Default String 何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName String 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided Boolean プロシージャがネイティブのIMAP プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

CData Cloud

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、[INBOX] テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='[INBOX]' 
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
IsKey Boolean カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey Boolean カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。

CData Cloud

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前 タイプ 説明
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。
ForeignKeyType String 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。

CData Cloud

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前。
KeySeq String 主キーのシーケンス番号。
KeyName String 主キーの名前。

CData Cloud

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String インデックスを含むデータベースの名前。
SchemaName String インデックスを含むスキーマの名前。
TableName String インデックスを含むテーブルの名前。
IndexName String インデックス名。
ColumnName String インデックスに関連付けられたカラムの名前。
IsUnique Boolean インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary Boolean インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type Int16 インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder String 並べ替え順序:A が昇順、D が降順。
OrdinalPosition Int16 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String 接続プロパティ名。
ShortDescription String 簡単な説明。
Type String 接続プロパティのデータ型。
Default String 明示的に設定されていない場合のデフォルト値。
Values String 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value String 設定した値またはあらかじめ設定されたデフォルト。
Required Boolean プロパティが接続に必要かどうか。
Category String 接続プロパティのカテゴリ。
IsSessionProperty String プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity String プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName String キャメルケースの短縮形の接続プロパティ名。
Ordinal Int32 パラメータのインデックス。
CatOrdinal Int32 パラメータカテゴリのインデックス。
Hierarchy String このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible Boolean プロパティが接続UI に表示されるかどうかを通知します。
ETC String プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR識別子をエスケープするための開始文字。[
IDENTIFIER_QUOTE_CLOSE_CHAR識別子をエスケープするための終了文字。]
SUPPORTED_OPERATORSサポートされているSQL 演算子。=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYGROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESサポートされている外部結合の種類。NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS外部結合がサポートされているかどうか。YES, NO
SUBQUERIESサブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSサポートされている文字列関数。LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSサポートされている数値関数。ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSサポートされている日付および時刻関数。NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESレプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNSレプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTIONプロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。YES, NO
DIALECT使用するSQL ダイアレクトを示します。
KEY_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加SQL 機能がサポートされているかどうか。TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSバッチ操作がサポートされているかどうか。YES, NO
SQL_CAPこのドライバーでサポートされているすべてのSQL 機能。SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERYドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。YES, NO
PSEUDO_COLUMNS利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。TRUE, FALSE
REPLICATION_MIN_DATE_QUERYレプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTIONサーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATEレプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERYレプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTIONサーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。TRUE, FALSE
CREATE_SCHEMA_PROCEDURESスキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name Type Description
NAME String SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE String サポートされるSQL またはSQL 構文の詳細。

CData Cloud

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String データ変更処理から返された、データベース生成Id。
Batch String バッチの識別子。1 は単一処理。
Operation String バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。
Message String SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

CData Cloud

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductString製品名。
VersionString製品のバージョン番号。
DatasourceString製品が接続するデータソースの名前。
NodeIdString製品がインストールされているマシンの固有識別子。
HelpURLString製品のヘルプドキュメントのURL。
LicenseString製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。)
LocationString製品のライブラリが格納されているファイルパスの場所。
EnvironmentString製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersionString本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategoryStringCData Sync 機能のカテゴリ(例:Source、Destination)。

CData Cloud

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication


プロパティ説明
Protocol接続するE メールサーバーのタイプ。
User認証に使用されるE メールアカウントのユーザー。
Password認証に使用されるE メールアカウントのパスワード。
Serverメールサーバーの名前およびアドレス。
PortE メールサーバーのポート。デフォルト値はIMAP では143、POP では110です。
SSLModeEmail サーバーに接続する際の認証メカニズム。

SMTP


プロパティ説明
SMTPServerメールサーバー(SMTP サーバー)の名前およびアドレス。
SMTPPortSMTP のサーバーポート(デフォルトは25)。

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous


プロパティ説明
EmailService作業しているサービスとのIMAP 接続の最適化。
IncludeMessageメッセージbody 内容を含めるかどうか。
IsHTMLDetermines whether to return the MessageBody as HTML or plain-text.
KeepAlive他の接続に渡って接続を維持するかどうかを決定します。
ListMailboxesすべてのメールボックスをリストするか、サブスクライブされたIMAP メールボックスのみをリストするか。IMAP Only。
MaxItems返すアイテムの最大数。
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MessageCharsetSpecifies the session character set for decoding character data transferred from the IMAP server.
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ThrowsKeyNotFound更新された行がない場合に例外をスローするかどうかを指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UIDModeTrue に設定された場合、デフォルトのテンポラリーId ではなく、パーマネントメッセージId が使われます。
CData Cloud

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。


プロパティ説明
Protocol接続するE メールサーバーのタイプ。
User認証に使用されるE メールアカウントのユーザー。
Password認証に使用されるE メールアカウントのパスワード。
Serverメールサーバーの名前およびアドレス。
PortE メールサーバーのポート。デフォルト値はIMAP では143、POP では110です。
SSLModeEmail サーバーに接続する際の認証メカニズム。
CData Cloud

Protocol

接続するE メールサーバーのタイプ。

Possible Values

IMAP, POP

データ型

string

デフォルト値

"IMAP"

解説

使用できる値は、POP およびIMAP を含みます。このフィールドのデフォルト値はIMAP です。

CData Cloud

User

認証に使用されるE メールアカウントのユーザー。

データ型

string

デフォルト値

""

解説

このフィールドは、Password とともに、E メールサーバーに対して認証をするために使われます。

CData Cloud

Password

認証に使用されるE メールアカウントのパスワード。

データ型

string

デフォルト値

""

解説

このフィールドは、User とともに、E メールサーバーに対して認証をするために使われます。

CData Cloud

Server

メールサーバーの名前およびアドレス。

データ型

string

デフォルト値

""

解説

このプロパティはメールサーバーのIP アドレス、もしくはドメイン名を指定します。 このプロパティは接続を試行する前に設定されなければならず、接続が継続している間は変更ができません。

このプロパティがドメイン名に設定されている場合は、DNS 要求が発行されます。

接続がSOCKS ファイアウォールを使うように設定されている場合には、このプロパティに設定される値は"*" から始まります。 この場合、ホスト名はresolve されていないファイアウォールに渡され、ファイアウォールがDNS resolution を実施します。

CData Cloud

Port

E メールサーバーのポート。デフォルト値はIMAP では143、POP では110です。

データ型

string

デフォルト値

""

解説

接続の確立には、1~65535 の間の有効なポート番号が必要です。 このプロパティは接続を試行する前に設定されなければならず、一度接続が確立されると変更ができません。

CData Cloud

SSLMode

Email サーバーに接続する際の認証メカニズム。

Possible Values

AUTO, NONE, IMPLICIT, EXPLICIT

データ型

string

デフォルト値

"NONE"

解説

SSLMode がNONE に設定されている場合、サーバーへのログインには、デフォルトのプレーンテキストでの認証が使われます。 SSLMode がIMPLICIT に設定されている場合、接続が確立された直後にSSL ネゴシエーションが開始されます。 SSLMode がEXPLICIT に設定されている場合、Cloud は最初にプレーンテキストで接続し、次にSTARTTLS などのプロトコルコマンドを使用してSSL ネゴシエーションを明示的に開始します。 SSLMode がAUTO に設定されている場合、リモートポートがプロトコルの標準のプレーンテキストポート(適用可能な場所)に設定されている場合、コンポーネントはSSLMode がEXPLICIT に設定されている場合と同じように動作します。その他すべてのケースでは、SSL ネゴシエーションはIMPLICIT になります。

  • AUTO
  • NONE
  • IMPLICIT
  • EXPLICIT

CData Cloud

SMTP

このセクションでは、本プロバイダーの接続文字列で設定可能なSMTP プロパティの全リストを提供します。


プロパティ説明
SMTPServerメールサーバー(SMTP サーバー)の名前およびアドレス。
SMTPPortSMTP のサーバーポート(デフォルトは25)。
CData Cloud

SMTPServer

メールサーバー(SMTP サーバー)の名前およびアドレス。

データ型

string

デフォルト値

""

解説

このプロパティはメールサーバーのIP アドレス、もしくはドメイン名を指定します。 このプロパティは接続を試行する前に設定されなければならず、接続が継続している間は変更ができません。

このプロパティがドメイン名に設定されている場合は、DNS 要求が発行されます。

接続がSOCKS ファイアウォールを使うように設定されている場合には、このプロパティに設定される値は"*" から始まります。 この場合、ホスト名はresolve されていないファイアウォールに渡され、ファイアウォールがDNS resolution を実施します。

CData Cloud

SMTPPort

SMTP のサーバーポート(デフォルトは25)。

データ型

string

デフォルト値

"25"

解説

接続の確立には、1~65535 の間の有効なポート番号が必要です。 このプロパティは接続を試行する前に設定されなければならず、一度接続が確立されると変更ができません。

CData Cloud

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

データ型

string

デフォルト値

""

解説

TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります:

説明 例
フルPEM 証明書(例では省略されています) -----BEGIN CERTIFICATE-----
MIIChTCCAe4CAQAwDQYJKoZIhv......Qw==
-----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。 C:\cert.cer
公開鍵(例では省略されています) -----BEGIN RSA PUBLIC KEY-----
MIGfMA0GCSq......AQAB
-----END RSA PUBLIC KEY-----
MD5 Thumbprint(hex 値はスペースまたはコロン区切り) ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint(hex 値はスペースまたはコロン区切り) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

CData Cloud

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
CData Cloud

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

CData Cloud

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
CData Cloud

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

CData Cloud

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。


プロパティ説明
EmailService作業しているサービスとのIMAP 接続の最適化。
IncludeMessageメッセージbody 内容を含めるかどうか。
IsHTMLDetermines whether to return the MessageBody as HTML or plain-text.
KeepAlive他の接続に渡って接続を維持するかどうかを決定します。
ListMailboxesすべてのメールボックスをリストするか、サブスクライブされたIMAP メールボックスのみをリストするか。IMAP Only。
MaxItems返すアイテムの最大数。
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MessageCharsetSpecifies the session character set for decoding character data transferred from the IMAP server.
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ThrowsKeyNotFound更新された行がない場合に例外をスローするかどうかを指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UIDModeTrue に設定された場合、デフォルトのテンポラリーId ではなく、パーマネントメッセージId が使われます。
CData Cloud

EmailService

作業しているサービスとのIMAP 接続の最適化。

データ型

string

デフォルト値

"Other"

解説

使用できる値は、AOL、Gmail、Outlook、Yahoo、およびOther です。

CData Cloud

IncludeMessage

メッセージbody 内容を含めるかどうか。

データ型

bool

デフォルト値

false

解説

メッセージbody 内容を含めるかどうか。

CData Cloud

IsHTML

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

データ型

bool

デフォルト値

true

解説

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

CData Cloud

KeepAlive

他の接続に渡って接続を維持するかどうかを決定します。

データ型

bool

デフォルト値

true

解説

他の接続に渡って接続を維持するかどうかを決定します。

CData Cloud

ListMailboxes

すべてのメールボックスをリストするか、サブスクライブされたIMAP メールボックスのみをリストするか。IMAP Only。

Possible Values

All, Subscribed

データ型

string

デフォルト値

"All"

解説

すべてのメールボックスをリストするか、サブスクライブされたIMAP メールボックスのみをリストするか。IMAP Only。

  • すべて
  • サブスクライブ

CData Cloud

MaxItems

返すアイテムの最大数。

データ型

string

デフォルト値

"100"

解説

返すアイテムの最大数。

CData Cloud

MaxRows

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

CData Cloud

MessageCharset

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

データ型

string

デフォルト値

"UTF-8"

解説

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.

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:

*=*

CData Cloud

ThrowsKeyNotFound

更新された行がない場合に例外をスローするかどうかを指定します。

データ型

bool

デフォルト値

false

解説

更新された行がない場合に例外をスローするかどうかを指定します。

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

UIDMode

True に設定された場合、デフォルトのテンポラリーId ではなく、パーマネントメッセージId が使われます。

データ型

bool

デフォルト値

false

解説

UIDMode のデフォルト値はFalse です。

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9540