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

Gmail への接続

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

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

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

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

Gmail への接続

Cloud は最新のREST API とIMAP プロトコルを使用したGmail への接続をサポートしています。AuthScheme を使用して接続方法を制御します。REST API がデフォルトです。

Gmail への認証

使用可能な認証スキームは次のとおりです。

• Basic（IMAP のみ）
• OAuth
• OAuthJWT
• GCP インスタンスアカウント

Basic（IMAP のみ）

IMAP を使用する場合は、ドライバーがIMAP プロトコルを介してGmail と通信できるようにIMAP を有効にする必要があります。IMAP を使用すると、すべてのクライアントデバイスで個々のコピーではなく、同じリモートデータを使用できます。以下の手順に従って、IMAP 経由のGmail へのアクセスを有効にします。

1. Gmail Web インターフェースを開き、［設定］ボタン（歯車のアイコン）をクリックします。
2. メール転送とPOP/IMAP タブでIMAP を有効にするを選択します。
3. 変更を保存します。

非推奨のお知らせ 2022年5月30日時点で、Google はユーザー名とパスワードのみでGoogle アカウントにサインインするよう求めるサードパーティ製のアプリやデバイスの使用をサポートしなくなりました。この認証方法をまだ使えるようにする代替案もあります。例えば、App Passwords です。これを考慮して、Basic 認証を非推奨としました。CData では、よりセキュアな認証方法であるOAuth への切り替えをお勧めします。

この認証方法を使うには、AuthScheme をBasic に、Schema をIMAP に設定します。このアプローチは、自分のデータにアクセスする必要がある場合に適しています。User プロパティとPassword プロパティに、有効なGmail ユーザー資格情報を設定します。

ユーザーアカウント（OAuth）

AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。加えて、すべてのユーザーアカウントフローで、Gmail にカスタムアプリケーションを作成し登録する必要があります。それからCloud を使用してOAuth トークンの値を取得および管理します。カスタムアプリケーションについて詳しくは、カスタムOAuth アプリの作成 を参照してください。

NOTE： CData は、OAuth 認証でIMAP およびREST の両方のスキーマをサポートしています。唯一の違いは、IMAP はUser 接続プロパティを必要とすることです。REST では必要ありません。

Web アプリケーション

OAuth アクセストークンの取得

次の接続プロパティを設定し、OAuthAccessToken を取得します。

• OAuthClientId：アプリケーション設定のクライアントId に設定。
• OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
• User：（IMAP のみ）認証に使用されるGmail ユーザーアカウントに設定。

続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。

1. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。CallbackURL インプットをアプリケーション設定で指定したコールバックURL に設定します。ストアドプロシージャがOAuth エンドポイントのURL を返します。
2. ステップ1でストアドプロシージャが返したURL に移動します。カスタムOAuth アプリケーションにログインして、Web アプリケーションを認可します。認証されると、ブラウザはコールバックURL にリダイレクトします。
3. GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode をWEB に、Verifier インプットをコールバックURL のクエリ文字列の"code" パラメータに設定します。

アクセストークンとリフレッシュトークンを取得した後、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることが可能です。

OAuth アクセストークンの自動リフレッシュ

ドライバーがOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。

• InitiateOAuth：REFRESH に設定。
• OAuthClientId：アプリケーション設定のクライアントId に設定。
• OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
• OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークンに設定。
• OAuthRefreshToken：GetOAuthAccessToken によって返されたリフレッシュトークンに設定。
• OAuthSettingsLocation：Cloud がOAuth トークン値を保存する場所に設定。これは接続間で維持されます。
• User：（IMAP のみ）認証に使用されるGmail ユーザーアカウントに設定。

次回のデータ接続では、OAuthAccessToken およびOAuthRefreshToken の値は、OAuthSettingsLocation から取得されます。

OAuth アクセストークンの手動リフレッシュ

データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。

GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用し、手動でOAuthAccessToken をリフレッシュします。次の接続プロパティを設定します。

• OAuthClientId：アプリケーション設定のクライアントId に設定。
• OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
• User：（IMAP のみ）認証に使用されるGmail ユーザーアカウントに設定。

次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。

最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでOAuth を使用するようにドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

1. 以下のオプションから選択します。
   • オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
   • オプション2：インターネットブラウザに対応したマシンにCloud をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。
2. 次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするようにCloud を設定します。

オプション1：Verifier code を取得および交換

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

1. 以下のプロパティを設定し、認証URL を作成します。
   • InitiateOAuth：OFF に設定。
   • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
   • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
   • User：（IMAP のみ）認証に使用されるGmail ユーザーアカウントに設定。
2. 適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
3. ログインして、Cloud にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。
4. verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定します。

次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。次のプロパティを設定します。

ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

• InitiateOAuth：REFRESH に設定。
• OAuthVerifier：verifier code に設定。
• OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId に設定。
• OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレットに設定。
• OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。
• User：（IMAP のみ）認証に使用されるGmail ユーザーアカウントに設定。

OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。

• InitiateOAuth：REFRESH に設定。
• OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
• OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
• OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がCloud に読み書きのアクセス許可を与えることを確認してください。

オプション2：OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続を作成し、インストールする必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続が正常にテストされたら、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

• InitiateOAuth：REFRESH に設定。
• OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
• OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
• OAuthSettingsLocation：OAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がCloud に読み書きのアクセス許可を与えることを確認してください。
• User：（IMAP のみ）認証に使用されるGmail ユーザーアカウントに設定。

ドメイン全体の権限の委任要件

OAuthJWT を使用してサービスアカウントでGmail に認証するには、Google でWorkspace 管理コンソールでドメイン全体の委任を適切に設定する必要があります。 この設定は、サービスアカウントがドメイン内のユーザーに代わってアクセスすることを許可するもので、Gmail データにアクセスするための要件です。

• ドメイン全体の委任が必要です：これがないと、Gmail は接続を試みた際に"[400] Precondition check failed" エラーを返します。
• Google Workspace アカウントのみサポートします：個人のGmail アカウント（@gmail.com で終わる）はドメイン全体の委任をサポートしておらず、Gmail API アクセスでサービスアカウントを使用することはできません。
• 各接続は特定のユーザーを偽装する必要があります：OAuthJWTSubject プロパティを使用して、サービスアカウントがアクセスすべきWorkspace ユーザーのメールボックスを指定します。1つの接続につき1人のユーザーのみ偽装できます。
• 変更の適用には時間がかかる場合があります：委任を設定した後、すべてのユーザーに完全に効力を発揮するまで最大24時間かかる場合があります。
• 管理者アクセスが必要です：Google Workspace の特権管理者がサービスアカウントを承認し、適切なOAuth スコープを割り当てる必要があります。

詳しくは、Google Domain-Wide Delegation Guide を参照してください。

GCP インスタンスアカウント

GCP 仮想マシン上で実行している場合は、Cloud は仮想マシンに関連付けられたサービスアカウントを使用して認証できます。 このモードを使用するには、AuthScheme をGCPInstanceAccount に設定します。

デスクトップアプリケーション、Web アプリケーション、ヘッドレスマシンには、OAuth カスタムアプリケーションが必要です。

Gmail API を有効化

次の手順に従いGmail API を有効化します。

1. Google Cloud Console に移動します。
2. 左側のナビゲーションメニューからライブラリを選択します。API ライブラリページが開きます。
3. 検索ボックスに、"Gmail API" を入力し、検索結果からGmail API を選択します。
4. Gmail API ページで、有効にするをクリックします。

ユーザーアカウント認証用のOAuth アプリの作成

次の手順に従ってアプリを登録し、OAuthClientId およびOAuthClientSecret を取得します。

デスクトップアプリケーション

下記の手順に従って、OAuthClientId およびOAuthClientSecret を取得します。

1. Google API コンソールにログインします。
2. プロジェクトの作成をクリック、または既存のプロジェクトを選択します。
3. API Manager で、認証情報 -> 認証情報を作成 -> OAuth クライアントID を選択します。
4. アプリケーションの種類を選択します。 デスクトップアプリケーションを作成する場合は、その他を選択します。
5. 選択した組織で利用可能なものがない場合、同意画面を作成します。注意：Google Workspace アカウントを使用しない場合、User Type が外部の同意画面の作成に制限され、ユーザーサポートメールとデベロッパーの連絡先情報を指定する必要があります。追加情報は任意です。
6. 作成をクリックします。OAuthClientId およびOAuthClientSecret が表示されます。
7. ライブラリ -> Gmail API -> 有効にするを選択します。

サービスアカウント認証用のOAuth アプリの作成

次の手順に従ってOAuth アプリケーションを作成しプライベートキーを作成します。

1. Google API コンソールにログインします。
2. プロジェクトの作成をクリック、または既存のプロジェクトを選択します。
3. API Manager で、認証情報 -> 認証情報を作成 -> サービスアカウントキーを選択します。サービスアカウントメニューで新しいサービスアカウントか既存のサービスアカウントを選択します。「キーのタイプ」でP12 キーを選択します。
4. 作成をクリックします。アカウントキーのペアがダウンロードされ、秘密キーのパスワードが表示されます。
5. ライブラリ -> Gmail API -> 有効にするを選択します。

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

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

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 は、Gmail エンティティをリレーショナルテーブルおよびストアドプロシージャにモデル化します。 Cloud は、Gmail API を使用してサポートされているフィルタを処理します。その他のフィルタは、Cloud 内でクライアント側で処理されます。

Gmail REST データモデル

Gmail REST データモデル では、Gmail REST アカウントへの接続に使用できるスキーマについて説明します。テーブルを使用して、ライブGmail データを操作できます。CData Cloud が提供するストアドプロシージャを使用して、Gmail データの操作を自動化できます。

Gmail IMAP データモデル

Gmail IMAP データモデル では、Gmail IMAP アカウントへの接続に使用できるスキーマについて説明します。テーブルを使用して、ライブGmail データを操作できます。CData Cloud が提供するストアドプロシージャを使用して、Gmail データの操作を自動化できます。

ストアドプロシージャ

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

テーブル

テーブル では、利用可能なテーブルを説明します。テーブルはLabels とMessages をモデル化するために静的に定義されています。

Labels はスタンドアローンのテーブルとして公開されており、そのラベル内にリストされたすべてのメッセージを取得できます。次に例を示します：INBOX、SENT、DRAFT など。

ビュー

ビュー では、利用可能なビューを説明します。テーブルはAttachments、Filters、History などをモデル化するために静的に定義されています。

ストアドプロシージャ

ストアドプロシージャ は、Gmail のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、OAuth アクセストークンの取得など、Gmail の操作を実行できます。

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

CData Cloud - Gmail テーブル

Name	Description
Delegates	Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account
Draft	Query Draft Messages in Gmail.
Filters	Query Filters in Gmail.
ForwardingAddresses	Query or create forwarding addresses.
Labels	Query Labels in Gmail.
MessageLabels	Query Message labels in gmail. A row will be returned for each label.
Messages	Query Messages in Gmail.
SendAs	Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom from address. Send-as aliases correspond to the Send Mail As feature in the web interface.
SendAsAliasSmimeInfo	Query, create or delete s/mime email configurations.
SENT	Query SENT Messages in Gmail.

Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account

Columns

Name	Type	ReadOnly	References	Description
DelegateEmail [KEY]	String	False		The email address of the delegate.
VerificationStatus	String	True		Indicates whether this address has been verified and can act as a delegate for the account. Read-only.

Query Draft Messages in Gmail.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the draft.Automatically assigned when the mail is created.
MessageId	String	True		The Id of the message.Automatically assigned when the mail is created.
Subject	String	False		The subject of the email.
From	String	False		The address where the email is from.
To	String	False		The address where the email is sent to.
CC	String	False		The primary email address of the user. Writeable on create only. On update, a secondary email is added.
BCC	String	False		The primary email address of the user. Writeable on create only. On update, a secondary email is added.
Content	String	False		The content of the email.
Date	Datetime	False		The date when the email is sent.
Size	Long	True		The size in bytes of the email.
Labels	String	True		A comma separated value of labels that the email is part of.
AttachmentIds	String	True		A comma separated value of the ids of all attachments in the email.
Snippet	String	True		The snippet of the email.
ThreadId	String	True		The thread id of the email.
HistoryId	String	True		The history id of the email.
Headers	String	True		A list of headers of the email.
RawMessage	String	True		The entire email message in an RFC 2822 formatted and base64url encoded string. Only returned when MessageFormat=raw.
AttachmentPath	String	False		The path of the attachment.

Pseudo-Columns

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

Name	Type	Description
IncludeSpamTrash	Boolean	Include messages from SPAM and TRASH in the results. (Default: false)
MessageFormat	String	The format to return the message in: minimal, full, raw, or metadata. (Default: full)
SearchQuery	String	Only return messages matching the specified query. Supports the same query format as the Gmail search box. This will take precedence over any other SQL criteria.

Query Filters in Gmail.

テーブル固有の情報

利用可能なFilters をクエリします。

SELECT

ドライバーはGmail REST API を使用して、Id カラムを参照する検索条件を処理します。ドライバーは他のフィルタを、ドライバー内のクライアントサイドで処理します。

• Id は'=' 演算子をサポートします。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM Filters WHERE ID = 123

INSERT

以下のOAuth スコープが必要です。

• https://www.googleapis.com/auth/gmail.settings.basic

クエリの例は以下のとおりです。

INSERT INTO Filters (AddLabelIds,[From], Subject) VALUES ('TRASH', '[email protected]', 'some subject')

DELETE

以下のOAuth スコープが必要です。

• https://www.googleapis.com/auth/gmail.settings.basic

クエリの例は以下のとおりです。

DELETE FROM Filters WHERE Id = 'ANe1BmiqbQyBsAigc6DLeEnxCXPgVM5JHHwNGB32zpMD6-DlEShqDqGOIjFYq1wW-F0c9tqVqg'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The server assigned ID of the filter.
AddLabelIds	String	False		List of labels to add to the message.
RemoveLabelIds	String	False		List of labels to remove from the message.
Forward	String	False		Email address that the message should be forwarded to.
From	String	False		The sender's display name or email address.
To	String	False		The recipient's display name or email address. Includes recipients in the
Subject	String	False		Case-insensitive phrase found in the message's subject.
Query	String	False		Only return messages matching the specified query. Supports the same query format as the Gmail search box.
NegatedQuery	String	False		The primary email address of the user. Writeable on create only. On update, a secondary email is added.
HasAttachment	Boolean	False		Whether the message has any attachment.
ExcludedChats	Boolean	False		Whether the response should exclude chats.
Size	Integer	False		The size of the entire RFC822 message in bytes, including all headers and attachments.
SizeComparison	String	False		How the message size in bytes should be in relation to the size field.

Query or create forwarding addresses.

Columns

Name	Type	ReadOnly	References	Description
ForwardingEmail [KEY]	String	False		An email address to which messages can be forwarded.
VerificationStatus	String	True		Indicates whether this address has been verified and is usable for forwarding.

Query Labels in Gmail.

テーブル固有の情報

利用可能なLabels をクエリします。

Select

ドライバーはGmail REST API を使用して、Id カラムを参照する検索条件を処理します。ドライバーは他のフィルタを、ドライバー内のクライアントサイドで処理します。

• Id '=' 演算子をサポート。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM Labels WHERE Id = 'abc'

Insert

簡単なラベルを挿入します。

INSERT INTO [Labels] (Name) VALUES ('LabelName')

Update

ラベルを更新します。

UPDATE Labels SET Name = 'new name' WHERE Id = 'abc'

Delete

ラベルを削除します。

DELETE FROM [Labels] WHERE Id = 'LabelId'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The immutable ID of the label.
Name	String	False		The display name of the label.
MessageListVisibility	String	False		The visibility of messages with this label in the message list in the Gmail web interface. Acceptable values: HIDE, SHOW.
LabelListVisibility	String	False		The visibility of the label in the label list in the Gmail web interface. Acceptable values: LabelHide, LabelShow, LabelShowIfUnread.
Type	String	True		The owner type for the label.
MessagesTotal	Long	True		The total number of messages with the label.
ThreadsTotal	Long	True		The total number of threads with the label.
MessagesUnread	Long	True		The number of unread messages with the label.
ThreadsUnread	Long	True		The number of unread threads with the label.

Query Message labels in gmail. A row will be returned for each label.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id of the message. Automatically assigned when the mail is created.
LabelId [KEY]	String	False		The thread id of the email.

Query Messages in Gmail.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id of the message. Automatically assigned when the mail is created.
Subject	String	False		The subject of the email.
From	String	False		The address where the email is from.
To	String	False		The address where the email is sent to.
Content	String	False		The content of the email.
Date	Datetime	False		The date when the email is sent.
Size	Long	False		The size in bytes of the email.
Labels	String	False		A comma separated list of labels that the email is part of.
AttachmentIds	String	False		A comma separated value of the ids of all attachments in the email.
AttachmentPath	String	False		The path of the attachment.
Snippet	String	False		The snippet of the email.
ThreadId	String	False		The thread id of the email.
HistoryId	String	False		The history id of the email.
Headers	String	False		A list of headers of the email.
RawMessage	String	False		The entire email message in an RFC 2822 formatted and base64url encoded string. Only returned when MessageFormat=raw.

Pseudo-Columns

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

Name	Type	Description
IncludeSpamTrash	String	Include messages from SPAM and TRASH in the results. (Default: false)
MessageFormat	String	The format to return the message in: minimal, full, raw, or metadata. (Default: full)
LabelsFilter	String	Set this to a comma-separated list of labels that the email should be part of.
SearchQuery	String	Only return messages matching the specified query. Supports the same query format as the Gmail search box. This will take precedence over any other SQL criteria.

Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom from address. Send-as aliases correspond to the Send Mail As feature in the web interface.

テーブル固有の情報

指定されたアカウントの送信者エイリアスをクエリします。この結果には、アカウントに関連づけられた主な送信者アドレスと、カスタムの"from" エイリアスが含まれます。

Select

ドライバーはGmail REST API を使用して、SendAsEmail カラムを参照する検索条件を処理します。ドライバーは他のフィルタを、ドライバー内のクライアントサイドで処理します。

• SendAsEmail は'=' 演算子をサポートします。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM SendAs WHERE SendAsEmail = '[email protected]'

INSERT / UPDATE / DELETE 操作は制限されています。

これらの操作は、ドメイン全体の権限を委任されたサービスアカウントクライアントでのみ利用可能です。

Columns

Name	Type	ReadOnly	References	Description
SendAsEmail [KEY]	String	False		The email address that appears in the From: header for mail sent using this alias. This is read-only for all operations except create.
DisplayName	String	False		A name that appears in the From: header for mail sent using this alias. For custom from addresses, when this is empty, Gmail will populate the From: header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
ReplyToAddress	String	False		An optional email address that is included in a Reply-To: header for mail sent using this alias. If this is empty, Gmail will not generate a Reply-To: header.
Signature	String	False		An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
IsPrimary	Bool	False		Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
IsDefault	Bool	False		Whether this address is selected as the default From: address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
TreatAsAlias	Bool	False		Whether Gmail should treat this address as an alias for the users primary email address. This setting only applies to custom from aliases.
SmtpMsaHost	String	False		The hostname of the SMTP service. Required.
SmtpMsaPort	Integer	False		The port of the SMTP service. Required.
SmtpMsaUsername	String	False		The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
SmtpMsaPassword	String	False		The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
SmtpMsaSecurityMode	String	False		The protocol that will be used to secure communication with the SMTP service. Required.
VerificationStatus	String	False		Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom from aliases.

Query, create or delete s/mime email configurations.

Table Specific Information

Query the available SendAsAliasSmimeInfo.

SELECT

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.basic

The driver uses the GMail REST API to process search criteria that refer to the Id and SendAsEmail columns. The driver processes other filters client-side within the driver.

• Id supports the '=' operator.
• SendAsEmail supports the '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM SendAsAliasSmimeInfo WHERE ID = 123

INSERT

This method is only available to service account clients that have been delegated domain-wide authority.

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.sharing

DELETE

This method is only available to service account clients that have been delegated domain-wide authority.

Requires the following OAuth scopes:

• https://www.googleapis.com/auth/gmail.settings.basic
• https://www.googleapis.com/auth/gmail.settings.sharing

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The immutable ID for the SmimeInfo.
SendAsEmail [KEY]	String	False		he email address that appears in the From header for mail sent using this alias.
IssuerCn	String	False		The S/MIME certificate issuer's common name.
IsDefault	Bool	False		Whether this SmimeInfo is the default one for this user's send-as address.
Expiration	Datetime	False		When the certificate expires
EncryptedKeyPassword	String	False		Encrypted key password, when key is encrypted.
Pem	String	False		PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key).
Pkcs12	String	False		PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately. A base64-encoded string.

Query SENT Messages in Gmail.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The identifier of the mail message.
Subject	String	False		The subject of the current message.
From	String	False		The sender email address of the current message.
To	String	False		The email address of the recipient.
CC	String	False		CCed recipient.
BCC	String	False		BCCed recipient.
Content	String	False		The content of the email.
Date	Datetime	False		The date and time the current message was sent.
Size	Long	False		The size in bytes of the current message.
Labels	String	False		A comma separated list of labels that the email is part of.
AttachmentIds	String	False		A comma-separated list of the attachment ids.
AttachmentPath	String	False		A comma-separated list of the attachments content. Used in INSERT to set the local path of the file to attach.
Snippet	String	False		A snippet of the message.
ThreadId	String	False		The thread ID of the email.
HistoryId	String	False		The history id of the email.
Headers	String	False		A list of headers of the email.
RawMessage	String	False		The entire email message in an RFC 2822 formatted and base64url encoded string. Only returned when MessageFormat=raw.

Pseudo-Columns

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

Name	Type	Description
IncludeSpamTrash	String	Include messages from SPAM and TRASH in the results. (Default: false)
MessageFormat	String	The format to return the message in: minimal, full, raw, or metadata. (Default: full)
LabelsFilter	String	Set this to a comma-separated list of labels that the email should be part of.
SearchQuery	String	Only return messages matching the specified query. Supports the same query format as the Gmail search box. This will take precedence over any other SQL criteria.

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Gmail ビュー

Name	Description
Attachments	Query Attachments in Gmail.
AutoForwarding	Query the auto-forwarding setting for the specified account.
History	Query History in Gmail.
INBOX	Query SENT Messages in Gmail.
Language	Query language settings.
Threads	Query Threads in Gmail.
Users	Query Users in Gmail.
Vacation	Query vacation responder settings.

Query Attachments in Gmail.

テーブル固有の情報

利用可能なAttachments をクエリします。

Select

ドライバーはGmail REST API を使用して、MessageId とIncludeAttachmentData カラムを参照する検索条件を処理します。ドライバーは他のフィルタを、ドライバー内のクライアントサイドで処理します。

• MessageId '=' 演算子をサポート。
• IncludeAttachmentData '=' 演算子をサポート。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM Attachments WHERE MessageId = 123
SELECT * FROM Attachments WHERE IncludeAttachmentData = true

Columns

Name	Type	References	Description
Id [KEY]	String		The X-Attachment-Id of the message part header.
MessageId [KEY]	String		The ID of the message containing the attachment.
Filename	String		The name of the attachment file.
Size	Long		The size in bytes of the attachment.
Data	String		The conent of the attachment.

Pseudo-Columns

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

Name	Type	Description
IncludeAttachmentData	Boolean		A boolean controling whether to include the attachment data or not. (Default: true)

Query the auto-forwarding setting for the specified account.

テーブル固有の情報

SELECT

以下のOAuth スコープが必要です。

• https://www.googleapis.com/auth/gmail.settings.basic

クエリの例：

SELECT * FROM AutoForwarding

UPDATE

以下のOAuth スコープが必要です。

• https://www.googleapis.com/auth/gmail.settings.sharing

INSERT / DELETE

これらのメソッドは使用できません。

Columns

Name	Type	References	Description
Enabled	Bool		Whether all incoming mail is automatically forwarded to another address.
EmailAddress	String		Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
Disposition	String		The state that a message should be left in after it has been forwarded.

Query History in Gmail.

テーブル固有の情報

利用可能なHistory をクエリします。

Select

ドライバーはGmail REST API を使用して、Id カラムを参照する検索条件を処理します。ドライバーは他のフィルタを、ドライバー内のクライアントサイドで処理します。

• Id '>' 演算子をサポート。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM History WHERE Id > 123

Columns

Name	Type	References	Description
Id [KEY]	Long		The ID of the mailbox's current history record.
MessagesAdded	String		Messages added to the mailbox in this history record.
MessagesDeleted	String		Messages deleted (not Trashed) from the mailbox in this history record.
LabelsAdded	String		Labels added to messages in this history record.
LabelsRemoved	String		Labels removed from messages in this history record.

Query SENT Messages in Gmail.

テーブル固有の情報

利用可能なINBOX をクエリします。

Select

ドライバーはGmail REST API を使用して、Id、Subject、From、To、Date、ThreadId、IncludeSpamTrash、MessageFormat、LabelsFilter、SearchQuery カラムを参照する検索条件を処理します。ドライバーは他のフィルタを、ドライバー内のクライアントサイドで処理します。

• Id '=' 演算子をサポート。
• Subject '=' 演算子をサポート。
• From '=' 演算子をサポート。
• To '=' 演算子をサポート。
• Date '>,>=,<,<=,=' 演算子をサポート。
• ThreadId '=' 演算子をサポート。
• IncludeSpamTrash '=' 演算子をサポート。
• MessageFormat '=' 演算子をサポート。
• LabelsFilter '=' 演算子をサポート。Set this to a comma-separated list of labels that the email should be part of (apart from INBOX).The emails that are returned can also be part of other labels not specified on the filter.
• SearchQuery supports the '=' 演算子をサポート。 Only return messages matching the specified query. Supports the same query format as the Gmail search box. This will take precedence over any other SQL criteria.

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM INBOX WHERE Id = '123'
SELECT * FROM INBOX WHERE Subject = '123'
SELECT * FROM INBOX WHERE [From] = '[email protected]'
SELECT * FROM INBOX WHERE [To] = '[email protected]'
SELECT * FROM INBOX WHERE [Date] >= '12/12/12 12:12:12'
SELECT * FROM INBOX WHERE [ThreadId] = '123'
SELECT * FROM INBOX WHERE [IncludeSpamTrash] = 'true'
SELECT * FROM INBOX WHERE [MessageFormat] = 'raw'
SELECT * FROM INBOX WHERE [LabelsFilter] = 'IMPORTANT, STARRED'
SELECT * FROM INBOX WHERE [SearchQuery] = 'from:[email protected]'

Columns

Name	Type	References	Description
Id [KEY]	String		The identifier of the mail message.
Subject	String		The subject of the current message.
From	String		The sender email address of the current message.
To	String		The email address of the recipient.
CC	String		CCed recipient.
BCC	String		BCCed recipient.
Content	String		The content of the email.
Date	Datetime		The date and time the current message was sent.
Size	Long		The size in bytes of the current message.
Labels	String		A comma separated list of labels that the email is part of.
AttachmentIds	String		A comma-separated list of the attachment ids.
AttachmentPath	String		A comma-separated list of the attachments content. Used in INSERT to set the local path of the file to attach.
Snippet	String		A snippet of the message.
ThreadId	String		The thread ID of the email.
HistoryId	String		The history id of the email.
Headers	String		A list of headers of the email.
RawMessage	String		The entire email message in an RFC 2822 formatted and base64url encoded string. Only returned when MessageFormat=raw.

Pseudo-Columns

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

Name	Type	Description
IncludeSpamTrash	String		Include messages from SPAM and TRASH in the results. (Default: false)
MessageFormat	String		The format to return the message in: minimal, full, raw, or metadata. (Default: full)
LabelsFilter	String		Set this to a comma-separated list of labels that the email should be part of.
SearchQuery	String		Only return messages matching the specified query. Supports the same query format as the Gmail search box. This will take precedence over any other SQL criteria.

Query language settings.

テーブル固有の情報

SELECT

以下のOAuth スコープが必要です。

• https://www.googleapis.com/auth/gmail.settings.basic

クエリの例：

SELECT * FROM Language

UPDATE

以下のOAuth スコープが必要です。

• https://www.googleapis.com/auth/gmail.settings.basic

INSERT / DELETE

これらのメソッドは使用できません。

Columns

Name	Type	References	Description
DisplayLanguage	String		The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example en-GB, fr or ja for British English, French, or Japanese respectively).

Query Threads in Gmail.

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the thread.
HistoryID	String		The Id of the last history record that modified this thread.
Snippet	String		A short part of the message text.

Pseudo-Columns

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

Name	Type	Description
LabelsFilter	String		Set this to a comma-separated list of labels that the thread should be part of.
IncludeSpamTrash	String		Include threads from SPAM and TRASH in the results. (Default: false)

Query Users in Gmail.

Columns

Name	Type	References	Description
EmailAddress	String		The email address of the user.
MessagesTotal	String		The total number of messages.
ThreadsTotal	String		The total number of threads.
HistoryId	String		The Id of the history.

Query vacation responder settings.

テーブル固有の情報

SELECT

以下のOAuth スコープが必要です。

• https://www.googleapis.com/auth/gmail.settings.basic

クエリの例：

SELECT * FROM Vacation

UPDATE

以下のOAuth スコープが必要です。

• https://www.googleapis.com/auth/gmail.settings.basic

INSERT / DELETE

これらのメソッドは使用できません。

Columns

Name	Type	References	Description
EnableAutoReply	Bool		Flag that controls whether Gmail automatically replies to messages.
ResponseSubject	String		Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.
ResponseBodyPlainText	String		Response body in plain text format. If both responseBodyPlainText and responseBodyHtml are specified, responseBodyHtml will be used.
ResponseBodyHtml	String		Response body in HTML format. Gmail will sanitize the HTML before storing it. If both responseBodyPlainText and responseBodyHtml are specified, responseBodyHtml will be used.
RestrictToContacts	Bool		Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
RestrictToDomain	Bool		Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Workspace users.
StartTime	Datetime		An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.
EndTime	Datetime		An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime.

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

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

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

Name	Description
GetAutoForwarding	Gets the auto-forwarding setting for the specified account.
GetImap	Query IMAP settings.
GetLanguage	Language settings for an account. These settings correspond to the 'Language settings' feature in the web interface.
GetPop	Query POP settings.
GetUserProfile	Gets the current user's Gmail profile.
GetVacations	Gets vacation responder settings.
ImportMessage	Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing. This method does not send a message.
ReplyToMailMessage	Reply to a mail message.
SendDraft	Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers.
SendMailMessage	Sends a message to the specified recipient.
SetDefaultSendAsAliasSmimeConfig	Sets the default S/MIME config for the specified send-as alias.
StartNotifications	Set up or update a push notification watch on the given user mailbox.
StopNotifications	Stop receiving push notifications for the given user mailbox.
TrashMessage	Moves the specified message to the trash.
UntrashMessage	Removes the specified message from the trash.
UpdateAutoForwarding	Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.
UpdateImap	Updates IMAP settings.
UpdateLanguage	Update language settings. If successful, the return object contains the displayLanguage that was saved for the user, which may differ from the value passed into the request. This is because the requested displayLanguage may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead.
UpdateMessageLabels	Update message labels by either adding or removing labels to messages.
UpdatePop	Updates POP settings.
UpdateVacations	Updates vacation responder settings.
VerifySendAs	Sends a verification email to the specified send-as alias address. The verification status must be pending. This method is only available to service account clients that have been delegated domain-wide authority.

Gets the auto-forwarding setting for the specified account.

ストアドプロシージャ固有の情報

以下のOAuth スコープが必要です。

• https://www.googleapis.com/auth/gmail.settings.basic

クエリの例：

EXEC GetAutoForwarding

Result Set Columns

Name	Type	Description
Enabled	Bool	Whether all incoming mail is automatically forwarded to another address.
EmailAddress	String	Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
Disposition	String	The state that a message should be left in after it has been forwarded.

Query IMAP settings.

ストアドプロシージャ固有の情報

以下のOAuth スコープが必要です。

• https://www.googleapis.com/auth/gmail.settings.basic

EXECUTE GetImap

Result Set Columns

Name	Type	Description
Enabled	Bool	Whether IMAP is enabled for the account.
AutoExpunge	Bool	If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.
ExpungeBehavior	String	The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.
MaxFolderSize	Integer	An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.

Language settings for an account. These settings correspond to the 'Language settings' feature in the web interface.

ストアドプロシージャ固有の情報

以下のOAuth スコープが必要です。

• https://www.googleapis.com/auth/gmail.settings.basic

EXEC GetLanguage

Result Set Columns

Name	Type	Description
DisplayLanguage	String	The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example en-GB, fr or ja for British English, French, or Japanese respectively).

Query POP settings.

ストアドプロシージャ固有の情報

以下のOAuth スコープが必要です。

• https://www.googleapis.com/auth/gmail.settings.basic

EXEC GetPop

Result Set Columns

Name	Type	Description
AccessWindow	String	The range of messages which are accessible via POP.
Disposition	String	The action that will be executed on a message after it has been fetched via POP.

Gets the current user's Gmail profile.

Result Set Columns

Name	Type	Description
EmailAddress	String	The user's email address
MessagesTotal	Integer	The total number of messages in the mailbox.
ThreadsTotal	Integer	The total number of threads in the mailbox.
HistoryId	String	The ID of the mailbox's current history record.

Gets vacation responder settings.

Result Set Columns

Name	Type	Description
EnableAutoReply	Bool	Flag that controls whether Gmail automatically replies to messages.
ResponseSubject	String	Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.
ResponseBodyPlainText	String	Response body in plain text format. If both responseBodyPlainText and responseBodyHtml are specified, responseBodyHtml will be used.
ResponseBodyHtml	String	Response body in HTML format. Gmail will sanitize the HTML before storing it. If both responseBodyPlainText and responseBodyHtml are specified, responseBodyHtml will be used.
RestrictToContacts	Bool	Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
RestrictToDomain	Bool	Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Workspace users.
StartTime	Datetime	An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.
EndTime	Datetime	An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime.

Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing. This method does not send a message.

Input

Name	Type	Required	Description
Subject	String	False	The subject of the mail message.
To	String	False	The email address(es) of the recipient(s).
From	String	False	The email address of the sender.
CC	String	False	CCed recipient(s).
BCC	String	False	BCCed recipient(s).
Content	String	False	The message body.
Deleted	Bool	False	Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.
NeverMarkSpam	Bool	False	Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.
Attachments	String	False	The attachment content. Either the name of the temp table or the json aggregate.

Result Set Columns

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

Reply to a mail message.

Stored Procedure Specific Information

Reply to an email by using this procedure.

Example on how to include attachments:

By using JSON aggregates

{
    "Attachments": [{"fileName": "filename", "data": "base64Encoded attachment content"}]
}

EXECUTE ReplyToMailMessage  @To = 'email', @From = 'sender_email', @CC = 'email', @BCC = 'email', @Content = 'content', @Attachments = "json aggregate"

By using temporary tables:

INSERT INTO Attachments#TEMP (FileName, Data) VALUES ('MyFile.txt', "base64Encoded data")
INSERT INTO Attachments#TEMP (FileName, Data) VALUES ('C:\\MyDirectory\\MyFile.extensio', "")

EXECUTE ReplyToMailMessage  @To = 'email', @From = 'sender_email', @CC = 'email', @BCC = 'email', @Content = 'content', @Attachments = "Attachments#TEMP"

Input

Name	Type	Required	Description
MessageId	String	True	The id of the message to reply to. Can be retrieved from the Messages table.
From	String	False	The email address of the sender.
To	String	True	The email address(es) of the recipient(s).
CC	String	False	CCed recipient(s).
BCC	String	False	BCCed recipient(s).
Content	String	False	The message body.
Attachments	String	False	The attachment content. Either the name of the temp table or the json aggregate.

Result Set Columns

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

Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers.

Input

Name	Type	Required	Description
DraftId	String	True	The immutable ID of the draft.

Result Set Columns

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

Sends a message to the specified recipient.

ストアドプロシージャ固有の情報

このプロシージャを使用してE メールを送信します。

Example on how to include attachments:

By using JSON aggregates

{
    "Attachments": [{"fileName": "filename", "data": "base64Encoded attachment content"}]
}

EXECUTE SendMailMessage @Subject = 'subject', @To = 'email', @From = 'sender_email', @CC = 'email', @BCC = 'email', @Content = 'content', @Attachments = "json aggregate"

By using temporary tables:

INSERT INTO Attachments#TEMP (FileName, Data) VALUES ('MyFile.txt', "base64Encoded data")
INSERT INTO Attachments#TEMP (FileName, Data) VALUES ('C:\\MyDirectory\\MyFile.extensio', "")

EXECUTE SendMailMessage @Subject = 'subject', @To = 'email', @From = 'sender_email', @CC = 'email', @BCC = 'email', @Content = 'content', @Attachments = "Attachments#TEMP"

The following scenarios still wok but are deprecated and will be removed in future releases.

ファイルを1つだけ添付する例です。

EXECUTE SendMailMessage @Subject = 'subject', @To = 'email', @From = 'sender_email', @CC = 'email', @BCC = 'email', @Content = 'content', @AttachmentPath = 'C:\\MyDirectory\\MyFile.extension'

ディレクトリの最初の階層の、すべてのファイルを添付する例です。

EXECUTE SendMailMessage @Subject = 'subject', @To = 'email', @From = 'sender_email', @CC = 'email', @BCC = 'email', @Content = 'content', @AttachmentPath = 'C:\\MyDirectory'

複数のファイルとフォルダを、組み合わせて添付する例です。

INSERT INTO attach#TEMP (AttachmentPath) VALUES ('C:\\MyDirectory\\MyFile.extension')
INSERT INTO attach#TEMP (AttachmentPath) VALUES ('C:\\MyDirectory2')
EXECUTE SendMailMessage @Subject = 'subject', @To = 'email', @From = 'sender_email', @CC = 'email', @BCC = 'email', @Content = 'content', @AttachmentPath = 'attach#TEMP'

複数のメール受信者を含める場合の例です。

EXECUTE SendMailMessage @Subject = 'subject', @To = '[email protected],[email protected]', @From = 'sender_email', @CC = '[email protected],[email protected]', @BCC = '[email protected],[email protected]', @Content = 'content'

Input

Name	Type	Required	Description
Subject	String	True	The subject of the mail message.
To	String	True	The email address(es) of the recipient(s).
From	String	False	The email address of the sender.
CC	String	False	CCed recipient(s).
BCC	String	False	BCCed recipient(s).
Content	String	True	The message body.
AttachmentPath	String	False	The attachment file names (with the path if reading from a file) to include in the message.

Result Set Columns

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

Sets the default S/MIME config for the specified send-as alias.

Stored Procedure Specific Information

Requires the following OAuth scopes:

• https://www.googleapis.com/auth/gmail.settings.basic
• https://www.googleapis.com/auth/gmail.settings.sharing

EXECUTE GetImap

Input

Name	Type	Required	Description
Id	String	True	The immutable ID for the SmimeInfo.
SendAsEmail	String	True	The email address that appears in the From header for mail sent using this alias.

Result Set Columns

Name	Type	Description
Success	String	Whether the operation was successful or not.

Set up or update a push notification watch on the given user mailbox.

Input

Name	Type	Required	Description
LabelIds	String	False	A comma separated list of labelIds to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated.
LabelFilterBehavior	String	False	Filtering behavior of labelIds list specified.
TopicName	String	True	A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name must already exist in Cloud Pub/Sub and you must have already granted gmail publish permission on it. For example: projects/my-project-identifier/topics/my-topic-name (using the Cloud Pub/Sub v1 topic naming format)

Result Set Columns

Name	Type	Description
HistoryId	String	The ID of the mailbox's current history record.
Expiration	String	When Gmail will stop sending notifications for mailbox updates (epoch millis). Call the procedure again before this time to renew the watch.

Stop receiving push notifications for the given user mailbox.

Result Set Columns

Name	Type	Description
Success	String	Whether the operation was successful or not.

Moves the specified message to the trash.

Input

Name	Type	Required	Description
MessageId	String	True	The ID of the message to Trash.

Result Set Columns

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

Removes the specified message from the trash.

Input

Name	Type	Required	Description
MessageId	String	True	The ID of the message to remove from Trash.

Result Set Columns

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

Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.

ストアドプロシージャ固有の情報

このプロシージャは、ドメイン全体の権限を委任されたサービスアカウントクライアントでのみ利用可能です。

以下のOAuth スコープが必要です。

• https://www.googleapis.com/auth/gmail.settings.sharing

クエリの例：

EXEC UpdateAutoForwarding @enabled='true', @EmailAddress='[email protected]', @Disposition='READ'

Input

Name	Type	Required	Description
Enabled	Bool	True	Whether all incoming mail is automatically forwarded to another address.
EmailAddress	String	True	Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
Disposition	String	True	The state that a message should be left in after it has been forwarded.

Result Set Columns

Name	Type	Description
Success	String	Whether the operation was successful or not.

Updates IMAP settings.

ストアドプロシージャ固有の情報

以下のOAuth スコープが必要です。

• https://www.googleapis.com/auth/gmail.settings.basic

クエリの例：

EXECUTE UpdateImap @enabled='false', @AutoExpunge='false', @expungeBehavior='archive', @maxFolderSize='0'

Input

Name	Type	Required	Description
Enabled	Bool	True	Whether IMAP is enabled for the account.
AutoExpunge	Bool	False	If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.
ExpungeBehavior	String	False	The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.
MaxFolderSize	Integer	False	An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.

Result Set Columns

Name	Type	Description
Success	String	Whether the operation was successful or not.

Update language settings. If successful, the return object contains the displayLanguage that was saved for the user, which may differ from the value passed into the request. This is because the requested displayLanguage may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead.

ストアドプロシージャ固有の情報

以下のOAuth スコープが必要です。

• https://www.googleapis.com/auth/gmail.settings.basic

クエリの例は以下のとおりです。

EXECUTE UpdateLanguage @displaylanguage='en'

Input

Name	Type	Required	Description
DisplayLanguage	String	True	The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example en-GB, fr or ja for British English, French, or Japanese respectively).

Result Set Columns

Name	Type	Description
Success	String	Whether the operation was successful or not.

Update message labels by either adding or removing labels to messages.

Input

Name	Type	Required	Description
MessageIds	String	True	The IDs of the messages to modify. There is a limit of 1000 ids per request.
LabelsToAdd	String	False	A list of IDs of labels to add to this message. Limited to only 100 labels.
LabelsToRemove	String	False	A list IDs of labels to remove from this message. Limited to only 100 labels.

Result Set Columns

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

Updates POP settings.

ストアドプロシージャ固有の情報

以下のOAuth スコープが必要です。

• https://www.googleapis.com/auth/gmail.settings.basic

クエリの例：

EXECUTE UpdatePop @accessWindow='allMail', @disposition='leaveInInbox'

Input

Name	Type	Required	Description
AccessWindow	String	True	The range of messages which are accessible via POP.
Disposition	String	True	The action that will be executed on a message after it has been fetched via POP.

Result Set Columns

Name	Type	Description
Success	String	Whether the operation was successful or not.

Updates vacation responder settings.

Input

Name	Type	Required	Description
EnableAutoReply	Bool	False	Flag that controls whether Gmail automatically replies to messages.
ResponseSubject	String	False	Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.
ResponseBodyPlainText	String	False	Response body in plain text format. If both responseBodyPlainText and responseBodyHtml are specified, responseBodyHtml will be used.
ResponseBodyHtml	String	False	Response body in HTML format. Gmail will sanitize the HTML before storing it. If both responseBodyPlainText and responseBodyHtml are specified, responseBodyHtml will be used.
RestrictToContacts	Bool	False	Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
RestrictToDomain	Bool	False	Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Workspace users.
StartTime	Datetime	False	An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.
EndTime	Datetime	False	An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime.

Result Set Columns

Name	Type	Description
Success	String	Whether the operation was successful or not.

Sends a verification email to the specified send-as alias address. The verification status must be pending. This method is only available to service account clients that have been delegated domain-wide authority.

ストアドプロシージャ固有の情報

このプロシージャは、ドメイン全体の権限を委任されたサービスアカウントクライアントでのみ利用可能です。

以下のOAuth スコープが必要です。

• https://www.googleapis.com/auth/gmail.settings.sharing

クエリの例：

EXEC VerifySendAs @SendAsEmail = '[email protected]'

Input

Name	Type	Required	Description
SendAsEmail	String	True	The send-as alias to be verified.

Result Set Columns

Name	Type	Description
Success	String	Whether this operation was successful or not.

ストアドプロシージャ

ストアドプロシージャ は、Gmail のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、OAuth アクセストークンを取得するなどの、Gmail への操作を実行できます。

Note：ストアドプロシージャへの入力としてGmail のデフォルトのメールボックスを参照している場合には、メールボックスを正しいフォーマットで記述してください。例えば、[Gmail]/送信済みメール です。

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

CData Cloud - Gmail テーブル

Name	Description
MailMessages	Create, update, delete, and query Gmail messages.

Create, update, delete, and query Gmail messages.

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

NOTE：E メールが特殊文字を含む場合には、メッセージボディ内の本文はbase64 でエンコードされます。デコードされたメッセージを取得するには、メッセージボディの本文をデコードするか、GetPart ストアドプロシージャを使用します。

テーブル固有の情報

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

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

デフォルトのGmail テーブル名はバックスラッシュを含み、いくつかはスペースを含みます。デフォルトのGmail フォルダのテーブル名をエスケープするには、角かっこを使うことができます。次に例を示します。

SELECT * FROM [Gmail/All Mail]

Select

このテーブルへのクエリ結果は、以下のデフォルトに従います。

• MessageBody およびHeaders フィールドは、複数のメッセージをリストする場合には返されません。
• 返されるメッセージのデフォルト数は100です。これは、LIMIT もしくはMaxItems を使用して変更できます。メールボックス内のすべてのE メールを返したい場合には、0もしくは-1を設定してください。

メッセージをリスト

特定のメールボックス内のメッセージをリストするには、メールボックスをテーブルとして指定します。E メールは、新しいものから古いものの順でリストされます。別の方法として、メッセージID の範囲を指定することができます。範囲で使用可能なフォーマットは以下のとおりです。

• ID が10のメッセージのみを返す：
  

  SELECT * FROM [Inbox] WHERE Id = 10 

• 10から20までのすべてのメッセージを返す：
  

  SELECT * FROM [Inbox] WHERE Id BETWEEN 10 AND 20

• 1、3、5のメッセージを返す：
  

  SELECT * FROM [Inbox] WHERE Id IN (1, 3, 5)

検索条件の適用

Cloud はE メールを検索する方法をいくつか提供します。下記のソースの検索条件を、SELECT クエリのWHERE 句で使用できます。

• メッセージフィールド：E メールを検索するには、SELECT クエリのWHERE 句で以下のいずれかのカラムの値を指定します：To、From、BCC、CC、Subject、MessageBody、Flags、Labels、Size、またはDate。 括弧でネストされた、複雑なステートメントもサポートされています。

  To、From、BCC、CC、Subject、およびMessageBody は、次の演算子でフィルタ可能です：=、!=、CONTAINS。

  Flags とLabels は、= および!= 演算子のみをサポートします。

  Date は次の演算子でフィルタ可能です：=、<、<=、>、>=。

  Size は、< および> 演算子のみをサポートします。

  CONTAINS 関数には、UI の検索バーと同様に完全な単語（例えば、Tes ではなくTest）が必要であることに注意してください。 例えば、以下のクエリは[email protected] または[email protected] のいずれかから、テキスト'Test' を含むすべてのメッセージを返します。
  

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

• 添付ファイル：標準カラムでの検索に加えて、添付ファイル名での検索および添付ファイルがあるかどうかでのフィルタも可能です。
  

  SELECT * FROM [Gmail/All Mail] WHERE HasAttachment = 'True' AND Attachments = '.txt'

• Gmail-specific：ThreadId およびMsgId を使用して、= および!= 演算子でフィルタリングできます。また、IN 演算子もMsgId カラムに使用できます（演算子は内部的に= 演算子を使用して複数のステートメントに変換されます）。
• IMAP：上記の検索条件の作成方法に代わる方法として、SearchCriteria 疑似カラムを使用して、RFC で指定されている有効なIMAP 検索条件を使って検索することができます。

Insert

Insert ステートメントはE メールの送信に使用します。Subject、To、およびMessageBody フィールドは必須です。

INSERT INTO [Gmail/All Mail] (Subject, MessageBody, To) VALUES ('Test Subject', 'Body Text', '[email protected]')

Update

• E メールをあるメールボックスから他のメールボックスに移動させる場合、UPDATE でメールボックスを指定します。
  

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

  ID はメッセージ番号、':' で区切られた2つのメッセージ番号の範囲（例えば、"1:5"）、または',' で区切られた個別のメッセージ番号（例えば、"1:5,7,10"）を含むことができます。
• E メールをあるメールボックスから他のメールボックスに移動させる場合、追加の更新を同時に指定することはできません。
• フラグを更新するには、フラグを1つもしくはリストでUPDATE に指定します。
  

  UPDATE [Inbox] SET Flags = 'Seen' WHERE Id = 'MessageId'

  IMAP RFC で指定されているフラグの標準値は次のとおりです：'Answered'、'Flagged'、'Deleted'、'Seen'、および'Draft'。

  クエリで指定されたフラグは、すべてのE メールの現在のフラグをオーバーライドします。

Delete

IMAP を使用してGmail からメッセージを削除する場合、メッセージはサーバーからは削除されません。Gmail は現在の受信トレイのラベルを削除して、E メールを"archived" としてマークします。 すべてのフォルダからメッセージを永久に削除したい場合には：

1. [Gmail]/ゴミ箱 へメッセージを移動してください。
2. [Gmail]/ゴミ箱 フォルダからメッセージを削除してください。

Id フィールドが必要です。

DELETE FROM [Inbox] WHERE Id = '2'

補足

• デフォルトで返されるメッセージの最大数は100 です。これは、LIMIT もしくはMaxItems を使用して変更できます。メールボックスのすべてのE メールを返したい場合には、0もしくは-1を設定してください。
• デフォルトで返されるページごとのメッセージ数は25です。ItemsPerPage 疑似カラムを設定することで変更が可能です。
• 返されるすべてのメッセージID はテンポラリID であり、続くサーバーへのリクエストで変わることがあります。

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The identifier of the mail message.
Mailbox	String	False		The current mailbox that the item is listed in. Updating this value moves the message to a new mailbox.
Subject	String	False		The subject of the current message.
FullFrom	String	True		The sender name and email address of the current message.
From	String	True		The sender email address of the current message.
FullTo	String	True		A semicolon-separated list of names and email addresses of the recipients.
To	String	False		A semicolon-separated list of the email addresses of the recipients.
FullCC	String	True		A semicolon-separated list of names and email addresses of the CC'd recipients.
CC	String	False		A semicolon-separated list of the email addresses of the CC'd recipients.
FullBCC	String	True		A semicolon-separated list of the names and email addresses of the BCC'd recipients. This field is only applicable for sent mail.
BCC	String	False		A semicolon-separated list of the email addresses of the BCC'd recipients. This field is only applicable for sent mail.
Date	Datetime	True		The date and time the current message was sent.
MessageBody	String	False		The message body. This field can only be set if you specify a single Id in SELECT.
Attachments	String	False		A semicolon-separated list of the attachment file names (with the path specified if reading from a file) included in the message.
AttachmentData	String	False		A semicolon-separated list of the base-64-encoded attachment data included in the message. The file name in the Attachments field must also be specified to use this field.
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 Gmail message Id associated with the current message. 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. This field is only available if you specify a single Id in SELECT or set IncludeMessage connection property to true.
AttachmentHeaders	String	True		The attachment headers for the specified mail message. This field is only available if you specify a single Id in SELECT or set IncludeMessage connection property to true.
ContentIds	String	True		The content id headers for the specified mail message. This field is only available if you specify a single Id in SELECT or set IncludeMessage connection property to true.

Pseudo-Columns

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

Name	Type	Description
SearchCriteria	String	The search criteria to use for the search operation (i.e., SENTSINCE dd-MMM-yyyy). The IMAP RFCs specifies the exact format of the search criteria. 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'.
ItemsPerPage	String	The maximum number of items to return per page. デフォルト値は25です。
IsHTML	String	This field sets whether the email has an HTML or plain-text encoding. デフォルト値はTRUEです。
Importance	String	The importance of the mail message. 使用できる値は次のとおりです。UNSPECIFIED, LOW, NORMAL, HIGH デフォルト値はUNSPECIFIEDです。
Priority	String	The priority of the mail message. 使用できる値は次のとおりです。UNSPECIFIED, NONURGENT, URGENT, NORMAL デフォルト値はUNSPECIFIEDです。
Sensitivity	String	The sensitivity of the mail message. 使用できる値は次のとおりです。UNSPECIFIED, PERSONAL, PRIVATE, COMPANYCONFIDENTIAL デフォルト値はUNSPECIFIEDです。
DeliveryNotification	String	The email address to send a delivery notification to.
ReadReceipt	String	The email address to send a read receipt to.
ShowLabels	String	This field sets whether to show labels or not. デフォルト値はTRUEです。
ShowThreadId	String	This field sets whether to show the thread Id or not. デフォルト値はTRUEです。
ShowMsgId	String	This field sets whether to show the unique Gmail Id or not. デフォルト値はTRUEです。
UIDMode	String	If this value is set to true, permanent message Ids are used instead of the default temporary Ids. デフォルト値はFALSEです。
HasAttachments	String	If this value is set to true, only messages with attachments are listed. If false, all messages are listed.
DownloadAttachments	String	If true, attachments are downloaded with the messages. Available only when specifying a single message Id or the Include Messages connection property is true. By default organizes attachments in subfolders with the message Id as name. デフォルト値はFALSEです。
AttachmentFolder	String	The folder that is used for downloading attachments. If this is set, the AttachmentData column does not return any data (that is, returns null) and the attachments are instead be written to disk. NOTE: An error is thrown if filters that cannot be supported server-side are included in the criteria. Please refer to the 'Apply Search Criteria' section for a list of supported filters.
EMLFolder	String	The folder where the complete MIME message, which is saved as an EML file, is downloaded to. If multiple messages are selected, subfolders are created for each message.
Overwrite	String	This field sets whether to overwrite attachments and EML files. デフォルト値はFALSEです。
IncludeMessage	String	This field sets whether to include the message content in the response. デフォルト値はFALSEです。

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

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

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

Name	Description
AddMailbox	Adds a mailbox to the authorized Gmail account.
DeleteMailbox	Deletes the specified mailbox for the authorized Gmail account.
GetPart	Gets the message part specified by LocalFile or PartId from the message specified by Id on the Gmail server.
MoveEmails	Moves the messages specified by Ids to the mailbox specified by Mailbox .
RenameMailbox	Renames the specified mailbox for the authorized Gmail account.
SendMailMessage	Sends the message specified to the specified recipient.
SetFlags	Adds or Replaces existing flags with the specified flags.
SetLabels	Adds or replaces existing Labels with the specified Labels.

Adds a mailbox to the authorized Gmail account.

Input

Name	Type	Required	Description
Mailbox	String	True	The name of the mailbox to be created.

Result Set Columns

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

Deletes the specified mailbox for the authorized Gmail account.

Input

Name	Type	Required	Description
Mailbox	String	True	The name of the mailbox you wish to delete.

Result Set Columns

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

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

Input

Name	Type	Required	Description
Id	String	True	The Id of the message that contains the message part. デフォルト値は1です。
LocalFile	String	True	The local file where the content of the message part will be written to.
Mailbox	String	True	The mailbox where the message is currently located. デフォルト値はInboxです。
PartFileName	String	False	The part file name of the part to retrieve. Either the PartId or the PartFileName input must be specified.
PartId	String	False	The part Id of the part to retrieve. Either the PartId or the PartFileName input must be specified.
UIDMode	String	False	If true, permanent message Ids are used instead of the default temporary Ids.
Overwrite	String	False	If true, the file specified in LocalFile input will be overwritten.

Result Set Columns

Name	Type	Description
ContentType	String	The content type.
Size	String	The size of the message part.
FileName	String	The file name of the message part.

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

Input

Name	Type	Required	Description
Mailbox	String	True	The mailbox where the message is currently located. デフォルト値はInboxです。
Id	String	True	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'). デフォルト値は1です。
Destination	String	True	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.

Renames the specified mailbox for the authorized Gmail account.

Input

Name	Type	Required	Description
Mailbox	String	True	The current name of the mailbox you wish to rename.
NewName	String	True	The new name of the mailbox you wish to rename.

Result Set Columns

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

Sends the message specified to the specified recipient.

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

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

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

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

Input

Name	Type	Required	Description
To	String	True	A semicolon-separated list of names and email addresses of the recipients.
Subject	String	True	The subject of the mail message.
From	String	False	The email address of the sender.
MessageBody	String	True	The message body.
CC	String	False	A semicolon-separated list of names and email addresses of the CCed recipients.
BCC	String	False	A semicolon-separated list of names and email addresses of the BCCed recipients.
Attachment#	String	False	A semicolon-separated list of the attachment file names (with the path if reading from a file) included in the message.
AttachmentData#	String	False	A semicolon-separated list of the base-64-encoded attachment data included in the message. To use this field, you must also specify the file name in Attachments.
IsHTML	String	False	Whether the email is HTML or plain text. デフォルト値はTRUEです。
Importance	String	False	The importance of the mail message. 使用できる値は次のとおりです。UNSPECIFIED, LOW, NORMAL, HIGH デフォルト値はUNSPECIFIEDです。
Priority	String	False	The priority of the mail message. 使用できる値は次のとおりです。UNSPECIFIED, NONURGENT, URGENT, NORMAL デフォルト値はUNSPECIFIEDです。
Sensitivity	String	False	The sensitivity of the mail message. 使用できる値は次のとおりです。UNSPECIFIED, PERSONAL, PRIVATE, COMPANYCONFIDENTIAL デフォルト値はUNSPECIFIEDです。
DeliveryNotification	String	False	The email address to send a delivery notification to.
ReadReceipt	String	False	The email address to send a read receipt to.
Charset	String	False	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.

Adds or Replaces existing flags with the specified flags.

Input

Name	Type	Required	Description
Mailbox	String	True	The Gmail mailbox where the message is located. デフォルト値はInboxです。
Id	String	True	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	True	Sets the specified flags to the message specified by message set. (e.g., Seen, Deleted, Draft). Flags should be specified as comma separated list(e.g. Seen,Deleted) デフォルト値はSeenです。
OperationType	String	False	This indicates weather the specified flags should be added,removed or replace existing flags list. 使用できる値は次のとおりです。ADD, REPLACE, REMOVE デフォルト値はREPLACEです。

Result Set Columns

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

Adds or replaces existing Labels with the specified Labels.

Input

Name	Type	Required	Description
Mailbox	String	True	The Gmail mailbox where the message is located. デフォルト値はInboxです。
Id	String	True	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	True	The labels to be set to the message specified by the MessageSet property. This input must be a space-delimited list of labels.
OperationType	String	False	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.

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

スキーマテーブル

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

• 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：バッチ処理または単一の更新に関する情報を返す。

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

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

SELECT * FROM sys_catalogs

Columns

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

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

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

          SELECT * FROM sys_schemas
          

Columns

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

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

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

          SELECT * FROM sys_tables
          

Columns

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

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

次のクエリは、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 が含まれます。

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

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

          SELECT * FROM sys_procedures
          

Columns

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

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

次のクエリは、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	プロシージャがネイティブのGmail プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

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

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

次のクエリは、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	主キーのカラム名。

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

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

         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	外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。

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

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

         SELECT * FROM sys_primarykeys
          

Columns

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

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

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

          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	インデックスのカラムのシーケンスナンバー。

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

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

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	プロパティに関するその他のさまざまな情報。

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

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

データソースのSELECT 機能

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

名前	説明	有効な値
AGGREGATE_FUNCTIONS	サポートされている集計関数。	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	COUNT 関数がサポートされているかどうか。	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_BY	GROUP 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_PROPERTIES	Uniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMAS	プロバイダー用に複数のスキームが存在するかどうかを示します。	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	プロバイダー用に複数のカタログが存在するかどうかを示します。	YES, NO
DATASYNCVERSION	このドライバーにアクセスするために必要な、CData Sync のバージョン。	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	このドライバーのCData Sync カテゴリ。	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	API で提供されている以上の、追加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_PARENTID	CheckCache 構文を親キーカラムに対して実行するかどうかを示します。	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 構文の詳細。

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

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

         SELECT * FROM sys_identity
          

Columns

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

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

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

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	製品名。
Version	String	製品のバージョン番号。
Datasource	String	製品が接続するデータソースの名前。
NodeId	String	製品がインストールされているマシンの固有識別子。
HelpURL	String	製品のヘルプドキュメントのURL。
License	String	製品のライセンス情報。（この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。）
Location	String	製品のライブラリが格納されているファイルパスの場所。
Environment	String	製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersion	String	本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategory	String	CData Sync 機能のカテゴリ（例：Source、Destination）。

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

Authentication

---

プロパティ	説明
AuthScheme	Gmail に接続する際に使用する認証の種類。
Schema	REST（デフォルト）またはIMAP のどちらのGmail API を利用するかを指定するために使用します。
User	認証するユーザーのユーザーID を指定します。
Password	認証するユーザーのパスワードを指定します。

OAuth

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecret	カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）
DelegatedServiceAccounts	委任されたリクエストのためのサービスアカウントE メールをスペース区切りで指定します。
RequestingServiceAccount	委任されたリクエストを行うためのサービスアカウントのE メールを指定します。
Scope	When this is set, the provider will request an access token with this specific scope.

JWT OAuth

---

プロパティ	説明
OAuthJWTCert	クライアント証明書のJWT 証明書ストアの名前を指定します。
OAuthJWTCertType	JWT 証明書を格納しているキーストアの種類を指定します。
OAuthJWTCertPassword	パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubject	ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
OAuthJWTIssuer	Java Web Token の発行者。
OAuthJWTSubject	アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

SSL

---

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

Logging

---

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

Schema

---

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

Miscellaneous

---

プロパティ	説明
AWSWorkloadIdentityConfig	AWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。
AzureWorkloadIdentityConfig	Azure 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。
IncludeMessage	メッセージbody 内容を含めるかどうか。
IsHTML	MessageBody がHTML かプレーンテキストかを決定します。
KeepAlive	この値がtrue の場合は、IMAP 接続が維持されます。
ListMailboxes	すべてのメールボックスをリストするか、サブスクライブされたIMAP メールボックスのみをリストするか。
MaxItems	返すアイテムの最大数。
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MessageCharset	Specifies the session character set for decoding character data transferred from the IMAP server.
PeekMode	True の場合、IMAP に送信されるすべてのFETCH コマンドにPEEK が追加されます。/Seen フラグを設定しないようにするために使用されます。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
QueryFullDetails	メッセージの完全な詳細を含めるかどうかを決定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UIDMode	True に設定された場合、デフォルトのテンポラリーId ではなく、パーマネントメッセージId が使われます。
WorkloadPoolId	Workload Identity Federation プールのID。
WorkloadProjectId	Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。
WorkloadProviderId	Workload Identity Federation プールプロバイダーのID。

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

---

プロパティ	説明
AuthScheme	Gmail に接続する際に使用する認証の種類。
Schema	REST（デフォルト）またはIMAP のどちらのGmail API を利用するかを指定するために使用します。
User	認証するユーザーのユーザーID を指定します。
Password	認証するユーザーのパスワードを指定します。

Gmail に接続する際に使用する認証の種類。

Possible Values

OAuth, OAuthJWT, AWSWorkloadIdentity, AzureWorkloadIdentity, Basic

データ型

string

デフォルト値

"OAuth"

解説

• OAuth：OAuth 認証を実行する場合に設定。
• Basic：BASIC ユーザー / パスワード認証を使用する場合に設定（非推奨）。
• OAuthJWT：OAuth サービスアカウントを使用してOAuth 認証を実行する場合に設定。
• GCPInstanceAccount：Google Cloud Platform インスタンスからアクセストークンを取得する場合に設定。

REST（デフォルト）またはIMAP のどちらのGmail API を利用するかを指定するために使用します。

Possible Values

REST

データ型

string

デフォルト値

"REST"

解説

REST（デフォルト）またはIMAP のどちらのGmail API を利用するかを指定するために使用します。Basic 認証はIMAP スキーマでのみサポートされていることに注意してください。

認証するユーザーのユーザーID を指定します。

データ型

string

デフォルト値

""

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

認証するユーザーのパスワードを指定します。

データ型

string

デフォルト値

""

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

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

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecret	カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）
DelegatedServiceAccounts	委任されたリクエストのためのサービスアカウントE メールをスペース区切りで指定します。
RequestingServiceAccount	委任されたリクエストを行うためのサービスアカウントのE メールを指定します。
Scope	When this is set, the provider will request an access token with this specific scope.

カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります：

• カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
• ドライバーが埋め込みOAuth 資格情報を提供しない場合。

（ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。）

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）

データ型

string

デフォルト値

""

解説

このプロパティ（アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます）は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes：

• この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
• クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

委任されたリクエストのためのサービスアカウントE メールをスペース区切りで指定します。

データ型

string

デフォルト値

""

解説

サービスアカウントE メールは、スペース区切りのリストで指定する必要があります。

各サービスアカウントは、チェーン内の次のサービスアカウントのroles/iam.serviceAccountTokenCreator ロールを付与されている必要があります。

チェーンの最後のサービスアカウントは、リクエストするサービスアカウントのroles/iam.serviceAccountTokenCreator ロールが付与されている必要があります。 リクエストするサービスアカウントはRequestingServiceAccount プロパティで指定されたものです。

委任されたリクエストの場合、リクエストするサービスアカウントは、iam.serviceAccounts.getAccessToken 権限を持つ必要があることに注意してください。これは、serviceAccountTokenCreator ロールを介して付与することもできます。

委任されたリクエストを行うためのサービスアカウントのE メールを指定します。

データ型

string

デフォルト値

""

解説

委任されたリクエストで認証情報が要求されたアカウントのサービスアカウントのE メール。DelegatedServiceAccounts の委任されたサービスアカウントのリストを用いて、このプロパティは、委任されたリクエストを行うために使用されます。

このサービスアカウントには、IAM 権限iam.serviceAccounts.getAccessToken が必要です。

When this is set, the provider will request an access token with this specific scope.

データ型

string

デフォルト値

""

解説

スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。

InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。

InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、このプロパティまたはScope 入力を使用して、要求するスコープを変更できます。

Set this property to retrieve a scoped token with specific privileges.

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

---

プロパティ	説明
OAuthJWTCert	クライアント証明書のJWT 証明書ストアの名前を指定します。
OAuthJWTCertType	JWT 証明書を格納しているキーストアの種類を指定します。
OAuthJWTCertPassword	パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubject	ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
OAuthJWTIssuer	Java Web Token の発行者。
OAuthJWTSubject	アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

クライアント証明書のJWT 証明書ストアの名前を指定します。

データ型

string

デフォルト値

""

解説

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword を使用してパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値が設定され、かつOAuthJWTCertSubject が設定されている場合、CData Cloud は証明書の検索を開始します。 詳しくは、OAuthJWTCertSubject を参照してください。

証明書ストアの指定はプラットフォームに依存します。

注記

• Windows の共通のユーザーとシステム証明書ストアは以下のとおりです。
  • MY：個人証明書と関連付けられた秘密キーを 格納している証明書ストア。
  • CA：証明機関の証明書。
  • ROOT：ルート証明書。
  • SPC：ソフトウェア発行元証明書。
• Javaでは、証明書ストアは通常、証明書および 任意の秘密キーを含むファイルです。
• 証明書ストアの種類がPFXFile の場合は、 このプロパティにファイル名を設定します。
• PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。

JWT 証明書を格納しているキーストアの種類を指定します。

Possible Values

PFXBLOB, JKSBLOB, PEMKEY_BLOB, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, XMLBLOB, BCFKSBLOB, GOOGLEJSONBLOB

データ型

string

デフォルト値

"GOOGLEJSONBLOB"

解説

値	説明	注記
USER	現在のユーザーが所有する証明書ストア。	Windows のみ使用可能です。
MACHINE	マシンストア。	Java やその他の非Windows 環境では使用できません。
PFXFILE	証明書を含むPFX（PKCS12）ファイル。
PFXBLOB	PFX（PKCS12）形式の証明書ストアをbase-64 でエンコードした文字列。
JKSFILE	証明書を含むJava キーストア（JKS）ファイル。	Java 専用。
JKSBLOB	Java キーストア（JKS）形式の証明書ストアをbase-64 でエンコードした文字列。	Java 専用。
PEMKEY_FILE	秘密鍵とオプションの証明書を含むPEM でエンコードされたファイル。
PEMKEY_BLOB	秘密鍵とオプションの証明書をbase-64 でエンコードした文字列。
PUBLIC_KEY_FILE	PEM またはDER でエンコードされた公開鍵証明書を含むファイル。
PUBLIC_KEY_BLOB	PEM またはDER でエンコードされた公開鍵証明書をbase-64 でエンコードした文字列。
SSHPUBLIC_KEY_FILE	SSH 形式の公開鍵を含むファイル。
SSHPUBLIC_KEY_BLOB	SSH 形式の公開鍵ををbase-64 でエンコードした文字列。
P7BFILE	証明書を含むPKCS7 ファイル。
PPKFILE	PuTTY 秘密キー（PPK）を含むファイル。
XMLFILE	XML 形式の証明書を含むファイル。
XMLBLOB	XML 形式の証明書を含む文字列。
BCFKSFILE	Bouncy Castle キーストアを含むファイル。
BCFKSBLOB	Bouncy Castle キーストアを含む文字列（base-64エンコード）。
GOOGLEJSON	サービスアカウント情報を含むJSON ファイル。	Google サービスに接続する場合にのみ有効。
GOOGLEJSONBLOB	サービスアカウントのJSON を含む文字列。	Google サービスに接続する場合にのみ有効。

パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。

データ型

string

デフォルト値

""

解説

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。

GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーは暗号化されていません。

ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。

データ型

string

デフォルト値

"*"

解説

このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。

• サブジェクトに完全に一致する証明書が見つかれば、該当する証明書が選択されます。
• 完全に一致するものがない場合、ストアは、サブジェクトがプロパティ値を含む証明書を検索します。
• 一致する証明書がない場合、証明書は選択されません。

値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例：CN=www.server.com, OU=test, C=US, [email protected]。

一般的なフィールドには以下のものが含まれます。

フィールド	説明
CN	共通名。一般的には、www.server.com のようなホスト名です。
O	法人名
OU	法人の部署名
L	法人の住所（市町村名）
S	法人の住所（都道府県）
C	国名
E	E メールアドレス

フィールド値にカンマが含まれる場合は、引用符で囲んでください。例："O=ACME, Inc."。

Java Web Token の発行者。

データ型

string

デフォルト値

""

解説

Java Web Token の発行者。 通常は、OAuth アプリケーションのクライアントId またはE メールアドレスとなります。 サービスアカウントのE メールアドレスの値を入力します。

GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーには、発行者アカウントのコピーが含まれています。

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

データ型

string

デフォルト値

""

解説

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。通常は、ユーザーのアカウント名またはE メールアドレスとなります。 アプリケーションが委任されたアクセスをリクエストするユーザーのE メールアドレスを入力します。

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

---

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

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

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

---

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

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

データ型

string

デフォルト値

"1"

解説

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

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

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