CommuniGate Pro
Version 5.1
アプリケーション
 
 
 
CLI/API

コマンドラインインターフェイス(API)

CommuniGate Pro サーバーにはコマンドラインインターフェイス(CLI) が用意されています。この インターフェイスは、標準のWebAdmin インターフェイスの代替インターフェイスとして使用できます。

CLI はまた、アプリケーションプログラムインターフェイス(API) として使用することもできます。 したがって、CLI コマンドをスクリプトやプログラムに定義し、そのスクリプトやプログラムでサーバーを管理できます。

CLI には、各種の方法を使ってアクセスが可能です。

例えば、CommuniGate Pro Perl Interfaceドキュメントには各種のPerl 言語ユーティリティが用意され ており、こういったユーティリティを利用し、Perl スクリプトを介してCommuniGate Pro CLI API に アクセスできます。このドキュメントにはまた、サンプルのPerl スクリプト(自動アカウント登録/ 削除など) が置かれているサイトのリンクも掲載されています。

また、CommuniGate Pro Java Interfaceドキュメントには各種のJava 言語クラスが用意されており、 こうしたクラスを使用し、Java プログラムを介してCommuniGate Pro CLI API にアクセスすることも 可能です。このドキュメントにはまた、サンプルのJava プログラムが置かれているサイトのリンクも掲載されています。

PWD モジュールを介したサーバーの管理

CommuniGate Pro サーバーのCLI は、PWDジュールの拡張機能として使用できます。

CLI コマンドは、PWD ユーザー(PWD モジュールのユーザー) の認証後、受け付けられるようにな ります。その場合、サーバーにより、各CLI コマンドについてそれぞれ、認証済みユーザー( コマン ドの実行時に認証されたユーザー) のアクセス権がチェックされます。

CLI コマンドによって何らかのデータが生成される場合、データは、肯定応答のプロトコルラインの 後に送信されます。その後、CR-LF が送られます。

下は、CLI コマンドによるPWD セッションの例です。
C: telnet servername.com 106
S: 200 CommuniGate Pro at mail.communigate.com PWD Server 5.1 ready
C: USER postmaster
S: 300 please send the PASS
C: PASS postmasterpassword
S: 200 login OK
C: CreateAccount "user1"
S: 200 OK
C: CreateAccount "user1"
S: 501 Account with this name already exists
C: RenameAccount "user1" into "user2"
S: 200 OK
C: CreateDomain "client1.com"
S: 200 OK
C: CreateAccount "user1@client1.com" TextMailbox
S: 200 OK
C: QUIT
S: 200 CommuniGate Pro PWD connection closed

CLI のシンタックス

CommuniGate ProのCLI では、辞書フォーマット を使ってコマンドが解析され、出力結果がフォーマッ トされます。

注意: 辞書フォーマットには、引用符を解析する機能があります。そのため、文字列は通常、引用符 で囲わなければなりませんが、文字列が英数字のみで構成されている場合、文字列を引用符なしで指 定できます。ただし、文字列にピリオド(.) やコンマ(,)、その他の英数字以外の記号があるときに は、通常どおり引用符を使わなければなりません。

辞書フォーマットは複数行に対応していますが、CLI パラメータとして配列や辞書を指定する場合、 その配列と辞書はすべて単一のコマンド行に定義しなければなりません。

一方、CLI コマンドの出力データが配列または辞書の場合、出力データを複数行で表示することもで きます。


アカウントの管理

CLI コマンドを使ってアカウントの管理を行うことができます。アカウントの管理に関するCLI コマ ンドを使用する場合、アカウント設定アクセス権 またはドメイン管理アクセス権 が必要です。以下、アカウントの管理に関するCLI コマンドについて説明します。

LISTACCOUNTS [ domainName ]
このコマンドを使って、ドメインの全アカウントのリストを取得できます。出力データは辞書 で、指定した(またはデフォルトの) ドメインのアカウントがすべて出力されます。
domainName : 文字列
オプションのパラメータ。ドメイン名を指定します。指定しなかった場合、管理者の ドメイン(デフォルトのドメイン) が使われます。
CREATEACCOUNT accountName [accountType] [ external ] [settings]
このコマンドを使って、新規のアカウントを作成できます。
accountName : 文字列
このパラメータには、新規のアカウントの名前を指定します。
名前の末尾に@ 記号を付加し、その後にドメイン名を指定できまます。その場合、指定し たドメインにアカウントが作成されます。ドメイン名を指定しなかったときには、管理者の ドメインが使われます。
accountType : MultiMailbox | TextMailbox | MailDirMailbox
オプションのパラメータで、作成するアカウントのタイプを指定します。指定しなかった場 合、タイプとしてはマルチメールボックス(MultiMailbox) が使われます。
external
オプションのフラグ。このフラグを指定しておくとアカウントが外部INBOX (既存のメー ラーで読み取り可能) とともに作成されます。
settings : 辞書
このオプションのパラメータでは、アカウントの作成に使われる初期設定を指定できます。 指定しなかったときには、ターゲットドメインのアカウントテンプレートの設定をもとにア カウントが作成されます。指定した場合、その設定を使ってテンプレートの設定が修正され ます。

このコマンドをドメイン管理者が使用する場合、ドメイン管理者に[CanCreateAccounts] 権限が付与されていなければなりません。
ドメイン管理者が、このコマンドでアカウント設定を修正する場合、修正できるのは、その 管理者のドメインのアカウント設定に限られます。
RENAMEACCOUNT oldAccountName into newAccountName
このコマンドでは、アカウントの名前の変更が可能です。
oldAccountName : 文字列
このパラメータには、既存のアカウントの名前(変更前の名前) を指定します。名前の後に はドメイン名を付加できます(上記を参照)。
newAccountName : 文字列
このパラメータには、新規のアカウントの名前(変更後の名前) を指定します。名前の後に はドメイン名を付加できます(上記を参照)。
このコマンドをドメイン管理者が使用する場合、[CanCreateAccounts] 権限が付与され ていなければなりません。
DELETEACCOUNT oldAccountName
このコマンドを使って、アカウントを削除できます。
oldAccountName : 文字列
このパラメータには、既存のアカウント(削除するアカウント) を指定します。名前の後に はドメイン名を付加できます(上記を参照)。
このコマンドをドメイン管理者が使用する場合、[CanCreateAccounts] 権限が付与され ていなければなりません。
GETACCOUNTSETTINGS accountName
このコマンドを使って、アカウント設定を取得できます。出力データは辞書で、辞書にはアカ ウント設定が格納されています。なお、辞書の内容は、明示的に定義されたアカウント設定だ けで、デフォルトのアカウント設定は含まれません。
accountName : 文字列
このパラメータには、既存の(アカウント設定を取り出したい) アカウントの名前を指定し ます。名前には、ドメイン名を付加することもできます(上記を参照)。
また、このパラメータには、アステリスク(*) を指定することもできます。その場合、ア ステリスクは、カレントの認証済みアカウント( コマンドの実行時に認証されたアカウン ト) と解釈されます。
注意: このGetAccountSettings コマンドは任意のユーザーが使用でき、コマンドを実行 することで自分のアカウント設定を取り出すことができます。
UPDATEACCOUNTSETTINGS accountName newSettings
このコマンドを使って、アカウント設定を更新できます。
accountName : 文字列
このパラメータには、既存の(アカウント設定を更新したい) アカウントの名前を指定しま す。名前には、ドメイン名を付加することもできます(上記を参照)。
newSettings : 辞書
このパラメータには、アカウント設定の辞書を指定します。この辞書を使って、既存のアカ ウント設定の辞書が更新されます。辞書には、設定データをすべて定義する必要はありませ ん。いずれかの設定データが定義されていない場合、既存の辞書の設定データのうち、その 設定データは更新されません(既存の設定データが残ります)。また、いずれかの設定デー タとして文字列default を指定しておいたときには、その設定データはデフォルトの設定 データに置き換えられます。
このコマンドをドメイン管理者が使用する場合、更新できるのは、ドメイン管理者に管理が 許可されているアカウント設定に限られます。
GETACCOUNTEFFECTIVESETTINGS accountName
このコマンドを使って、有効アカウント設定を取得できます。このコマンドでは、データとし て辞書(アカウント設定の辞書) が出力されます。有効アカウント設定とは、明示的に設定されたアカウント設定(デフォルト以外の設定) とデフォルトのアカウント設定の両方をいい、そ の全部が出力データ(辞書) に格納されています。
accountName : 文字列
このパラメータには、既存のアカウントを指定します。名前には、ドメイン名を付加するこ ともできます(上記を参照)。
また、このパラメータには、アステリスク(*) を指定することもできます。その場合、ア ステリスクは、カレントの認証済みアカウント( コマンドの実行時に認証されたアカウン ト) と解釈されます。
注意: このGetAccountEffectiveSettings コマンドは任意のユーザーが使用でき、コ マンドを実行することで自分の有効アカウント設定を取り出すことができます。
SETACCOUNTPASSWORD accountName PASSWORD newPassword
このコマンドを使って、アカウントのパスワードを更新できます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。名前には、ドメイン名を付加 することもできます(上記を参照)。
newPassword : 文字列
このパラメータには、アカウントの新規(変更後) のパスワードを指定します。指定したパ スワードは、そのアカウントの有効パスワード暗号化設定をもとに暗号化され、保存されま す。
このコマンドを使うユーザーには、処理対象のアカウントのドメインについて[基本設定 (Basic Settings)] ドメイン管理者権限が付与されていなければなりません。
VERIFYACCOUNTPASSWORD accountName PASSWORD password
このコマンドを使って、アカウントのパスワードの確認が可能です。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。名前には、ドメイン名を付加 することもできます(上記を参照)。
password : 文字列
このパラメータ(文字列) には、確認対象のパスワードを指定します( クリアテキスト形式 のパスワード)。
このコマンドを使うユーザーには、処理対象のアカウントのドメインについて、いずれかの ドメイン管理者権限が付与されていなければなりません。
GETACCOUNTALIASES accountName
このコマンドを使って、アカウントのエイリアスのリストを取得できます。出力データは、ア カウントのエイリアス名の配列です。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。名前には、ドメイン名 を付加することもできます(上記を参照)。
SETACCOUNTALIASES accountName newAliases
このコマンドを使って、アカウントのエイリアスを設定できます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。名前には、ドメイン名を付加 することもできます(上記を参照)。
newAliases : 配列
このパラメータ(配列) には、アカウントに設定するエイリアスの名前を指定します。既存 のエイリアスがある場合、すべて削除されます。
このコマンドはドメイン管理者が使用でき、その場合、[CanCreateAliases] 権限が付与 されていなければなりません。
GETACCOUNTTELNUMS accountName
このコマンドでは、アカウントに割り当てられている電話番号のリストを取得できます。出 力データは、アカウントに割り当てられている電話番号の配列です。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。名前には、ドメイン名を付加 することもできます(上記を参照)。
SETACCOUNTTELNUMS accountName newAliases
このコマンドを使用して、アカウントに電話番号を割り当てることができます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。名前には、ドメイン名を付加 することもできます(上記を参照)。
newAliases : 配列
このパラメータ(配列) には、電話番号(複数指定可) を指定します。この電話番号がアカ ウントに割り当てられます。既存の電話番号はすべて削除されます。
このコマンドは、[CanCreateTelnums] アクセス権が付与されているドメイン管理者だけ が使用できます。
GETACCOUNTMAILRULES accountName
このコマンドでは、アカウントのルールのリストを取得できます。出力データは、指定したア カウントに設定されているルールです。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。名前には、ドメイン名 を付加することもできます(上記を参照)。
SETACCOUNTMAILRULES accountName newRules
このコマンドを使って、アカウントのルールを設定できます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。名前には、ドメイン名を付加 することもできます(上記を参照)。
newRules : 配列
このパラメータには、アカウントのルールを指定します。既存のアカウントのルールはすべ て削除されます。
このコマンドはドメイン管理者が使用でき、使用する場合、[RulesAllowed] 権限が付与 されていなければなりません。
GETACCOUNTSIGNALRULES accountName
Use this command to get the list of Account Signal Rules. The command produces an output - an array of the Signal Rules specified for the Account.
accountName : 文字列
This parameter specifies the name of an existing Account. The name can include the Domain name (see above).
SETACCOUNTSIGNALRULES accountName newRules
Use this command to set the Account Signal Rules.
accountName : 文字列
This parameter specifies the name of an existing Account. The name can include the Domain name (see above).
newRules : 配列
This array should contain the Account Signal Rules. All old Account Signal Rules are removed.
This command can be used by Domain Administrators only if they have the SignalRulesAllowed access right.
UPDATEACCOUNTMAILRULE accountName newRule
UPDATEACCOUNTMAILRULE accountName DELETE oldRule
UPDATEACCOUNTSIGNALRULE accountName newRule
UPDATEACCOUNTSIGNALRULE accountName DELETE oldRule
Use these commands to update an Account Queue or Signal Rule.
accountName : 文字列
This parameter specifies the name of an existing Account. The name can include the Domain name (see above).
newRule : 配列
This parameter should be an array, its first element specifies the Rule priority, its second element specifies the Rule name. The optional third, forth, and fifth elements specify the Rule conditions, Rule actions, and Rule comment.
If the parameter array contains less than 4 elements, the array first element is used to update the priority of the already existing Rule with the name specified as the second array element. If such a Rule does not exist, the command returns an error.
If the parameter array contains 4 or more elements, the entire parameter array is stored as a new Rule. If there is an existing Rule with the same name, it is removed.
oldRule : 文字列
This string parameter (specified after the DELETE keyword) specifies a name of the Rule to be removed. If such a Rule does not exist, the command does nothing and it does not return an error.
The UpdateAccountMailRule command can be used by Domain Administrators only if they have the RulesAllowed access right.
The UpdateAccountSignalRule command can be used by Domain Administrators only if they have the SignalRulesAllowed access right.
GETACCOUNTRPOP accountName
このコマンドを使って、アカウントのRPOP レコードのリストを取得できます。出力データは、 指定したアカウントのRPOP レコードのリストです。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。名前には、ドメイン名 を付加することもできます(上記を参照)。
SETACCOUNTRPOP accountName newRecords
このコマンドを使って、アカウントのRPOP レコードを設定できます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。名前には、ドメイン名を付加 することもできます(上記を参照)。
newRecords : 配列
このパラメータ(配列) には、指定したアカウントに設定するRPOP レコードを指定しま す。既存のRPOP レコードはすべて削除されます。
このコマンドはドメイン管理者が使用でき、使用する場合、[CanModifyRPOP] 権限が付与されていなければなりません。
GETACCOUNTRIGHTS accountName
このコマンドでは、ユーザーを指定し、そのユーザーに付与されている権限(サーバー管理者 権限またはドメイン管理者権限) を取り出すことができます。出力データは、そのユーザーに 付与されている権限の配列です。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。名前には、ドメイン名 を付加することもできます。
GETACCOUNTINFO accountName [Key keyName | ( keyList) ]
このコマンドでは、アカウントの「情報」辞書の中の要素(「情報」要素) を指定し、その要素 の内容を取り出すことができます。このコマンドの出力データは、指定した要素の内容です。指 定した要素が存在しなかった場合、データとしては空白の文字列、つまり引用符2 つで構成さ れる文字列("") が出力されます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。名前には、ドメイン名を付加 することもできます(上記を参照)。また、アカウント名の代わりにアステリスク(*) を指 定することもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマ ンドの実行時に認証されたアカウント) と解釈されます。
keyList : 配列
This optional parameter specifies the names of the info keys to retrieve. Note that when Account "info" data are stored in .info dictionary files, the "info" elements have dictionary names starting with the hash (#) symbol. You should NOT include the hash symbol into the keyName parameter of the GETACCOUNTINFO command.
例:
GETACCOUNTINFO "user1@domain1.com" (LastLogin LastLoginAddress)
注意: the "info" element names are case-sensitive.
The output is a 辞書 with all those "info" elements that exist and are specified in the keyList array.
keyName : 文字列
このパラメータには、取り出したい「情報」要素の名前を指定します。なお、アカウントの 「情報」要素が.info ファイル(辞書ファイル) に格納される場合、その要素の名前にはハッ シュ記号(#) が付加されます。このハッシュ記号は、keyName パラメータに指定する必要 はありません(下の例で、このパラメータはLastLogin ですが、# は不要です)。
Sample:
GETACCOUNTINFO "user1@domain1.com" Key LastLogin
注意: 「情報」要素の名前は、ケースセンシティブです(大文字小文字が区別されます)。
このGetAccountInfo コマンドは、任意のユーザーが使用できます。その場合、その ユーザーのアカウントの「情報」要素の内容が取り出されます。
GETWEBUSER accountName
このコマンドを使って、アカウントのWebUser 設定を取り出すことができます。このコマンド の出力データは、アカウントのWebUser 設定が格納された辞書です。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。名前には、ドメイン名を付加 することもできます(上記を参照)。
注意: このGetWebUser コマンドは、任意のユーザーが使用できます。その場合、そのユー ザーのWebUser アカウント設定が取り出されます。
SETWEBUSER accountName newSettings
このコマンドを使って、アカウントのWebUser 設定の変更、更新が可能です。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。名前には、ドメイン名を付加 することもできます(上記を参照)。
newSettings : 辞書
このパラメータ(辞書) には、新規のWebUser 設定を指定します。既存のWebUser 設定は すべて削除されます。
このコマンドはドメイン管理者が使用でき、使用する場合、[WebUserSettings] 権限が付 与されていなければなりません。
GETEFFECTIVEWEBUSER accountName
このコマンドを使って、アカウントの有効WebUser 設定を取り出すことができます。このコマ ンドの出力データは、指定したアカウントのWebUser 設定(辞書) です。有効WebUser 設定と は、明示のWebUser 設定とデフォルトのWebUser 設定の両方をいい、この両方が出力データに 格納されます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。名前には、ドメイン名を付加 することもできます(上記を参照)。
注意: このGetEffectiveWebUser コマンドは、任意のユーザーが使用できます。その場合、 そのユーザーの有効WebUser 設定が取り出されます。
KILLACCOUNTSESSIONS accountName
このコマンドを使って、アカウントのセッション(POP、IMAP、FTP、WebUser など) をす べて強制的に停止できます。
accountName : 文字列
既存のアカウントの名前を指定します。このアカウントのセッションが停止されます。名前 には、ドメイン名を付加できます(上記を参照)。
注意: このコマンドは、ドメイン管理者が使用できます。

グループの管理

以下、グループの管理に関するCLI コマンドについて説明します。グループの管理に関するCLI コ マンドを使用する場合、ユーザーには[Can Modify All Domains and Account Settings] アクセス権また はドメイン管理アクセス権 が必要です。

LISTGROUPS [ domainName ]
このコマンドを使って、ドメインのグループのリストを取得できます。
domainName : 文字列
このオプションのパラメータには、ドメイン名を指定します。指定しなかった場合、 管理者のドメインが使われます。
CREATEGROUP groupName [settings]
このコマンドを使って、新規のグループを作成できます。
groupName : 文字列
このパラメータには、新規のグループの名前を指定します。
グループの名前の末尾には@ 記号を付加し、さらにドメイン名を付加することができます。 その場合、指定したドメインに新規のグループが作成されます。
settings : 辞書
オプションのパラメータで、ここには初期グループ設定とメンバーリストを指定できます。
このコマンドをドメイン管理者が使用する場合、[CanCreateGroups] 権限が付与されて いることが必要です。
RENAMEGROUP oldGroupName into newGroupName
このコマンドを使って、既存のグループの名前を変更できます。
oldGroupName : 文字列
このパラメータには、既存のグループ(名前を変更するグループ) の名前を指定します。名 前には、ドメイン名を付加することもできます(上記を参照)。
newGroupName : 文字列
このパラメータには、グループの新規の名前(変更後の名前) を指定します。名前には、ド メイン名を付加することもできます(上記を参照)。
このコマンドをドメイン管理者が使用する場合、[CanCreateGroups] 権限が付与されて いることが必要です。
DELETEGROUP groupName
このコマンドを使って、グループを削除できます。
groupName : 文字列
このパラメータには、既存のグループ(削除するグループ) の名前を指定します。名前に は、ドメイン名を付加することもできます(上記を参照)。
このコマンドをドメイン管理者が使用する場合、[CanCreateGroups] 権限が付与されて いることが必要です。
GETGROUP groupName
このコマンドを使って、グループ設定を取得できます。出力データは、グループの設定とメン バーが格納された辞書です。
groupName : 文字列
このパラメータには、既存のグループの名前を指定します。名前には、ドメイン名を 付加することもできます(上記を参照)。
SETGROUP groupName newSettings
このコマンドを使って、グループ設定を変更、更新できます。
groupName : 文字列
このパラメータには、既存のグループの名前を指定します。名前には、ドメイン名を付加す ることもできます(上記を参照)。
newSettings : 辞書
このパラメータには、グループ設定辞書を指定します。既存のグループ設定辞書は、 この辞書に置き換えられます。

フォワーダの管理

以下、フォワーダの管理に関するCLI コマンドについて説明します。フォワーダの管理に関するCLI コマンドを使用する場合、ユーザーには[Can Modify All Domains and Account Settings ] アクセス権ま たはドメイン管理アクセス権 が必要です。

LISTFORWARDERS [ domainName ]
このコマンドを使って、ドメインの全フォワーダのリストを取得できます。出力データ(配列) は、指定したドメイン(またはデフォルトのドメイン) に設定されている全フォワーダの名前 です。
domainName : 文字列
このパラメータにはドメイン名を指定します。指定しなかった場合、値としては管理 者のドメインが使われます。
CREATEFORWARDER forwarderName TO address
このコマンドを使って、新規のフォワーダを作成できます。
forwarderName : 文字列
このパラメータには、新規のフォワーダを指定します。
フォワーダの名前の末尾には@ 記号を付加し、その右にドメイン名を付加することができ ます。その場合、指定したドメインに新規のフォワーダが作成されます。ドメインを指定し なかったときには、管理者のドメインが値として使われます。
address : 文字列
このパラメータには、フォワーダがメールをリルートする電子メールアドレス( メールの転 送先の電子メールアドレス) を指定します。
このコマンドをドメイン管理者が使用する場合、ドメイン管理者に [CanCreateForwarders] 権限が付与されていることが必要です。
RENAMEFORWARDER oldForwarderName into newForwarderName
このコマンドは、フォワーダの名前の変更に使用します。
oldForwarderName : 文字列
このパラメータには既存のフォワーダの名前を指定します。名前にはドメイン名を付 加できます(上記を参照)。
newForwarderName : 文字列
このパラメータには新規のフォワーダの名前を指定します。名前にはドメイン名を付 加できます(上記を参照)。
このコマンドをドメイン管理者が使用する場合、そのドメイン管理者に [CanCreateForwarders] 権限が付与されていることが必要です。
DELETEFORWARDER forwarderName
このコマンドを使って、フォワーダを削除できます。
forwarderName : 文字列
このパラメータには、既存のフォワーダの名前を指定します。名前には、ドメイン名を付加 することもできます(上記を参照)。
このコマンドをドメイン管理者が使用する場合、そのドメイン管理者に [CanCreateForwarders] 権限が付与されていることが必要です。
GETFORWARDER forwarderName
このコマンドを使って、フォワーダのアドレスを取得できます。出力データ(文字列) は、フォ ワーダがメールをリルートする電子メールアドレスです。
forwarderName : 文字列
このパラメータには、既存のフォワーダの名前を指定します。名前には、ドメイン名 を付加することもできます(上記を参照)。

ドメインの管理

以下、ドメインの管理に関するCLI コマンドについて説明します。ドメインの管理に関するCLI コ マンドを使用する場合、ユーザーに[Can Modify All Domains and Account Settings ] 権限またはドメイン管理アクセス権 が付与されていることが必要です。

GETDOMAINSETTINGS [ domainName ]
このコマンドを使って、ドメイン設定を取得できます。出力データは、ドメイン設定が格納さ れた辞書です。出力された辞書に格納されているのは、明示的に定義された設定(デフォルト 以外の設定) に限られます。
domainName : 文字列
オプションのパラメータで、ここには既存のドメインの名前を指定します。
GETDOMAINEFFECTIVESETTINGS [ domainName ]
このコマンドを使って、有効ドメイン設定を取得できます。出力データは、ドメイン設定が格納 された辞書です。有効ドメイン設定とは、明示的に定義されたドメイン設定とデフォルトのド メイン設定の両方をいいます。
domainName : 文字列
オプションのパラメータで、ここには既存のドメインの名前を指定します。
UPDATEDOMAINSETTINGS [ domainName ] newSettings
このコマンドを使って、ドメイン設定を更新できます。
domainName : 文字列
オプションのパラメータで、ここには既存のドメインの名前を指定します。
newSettings : 辞書
このパラメータには、新規のドメイン設定辞書を指定します。既存のドメイン設定辞書は、 この辞書を使って更新されます。新規のドメイン設定辞書には、設定データをすべて定義す る必要はありません。いずれかの設定データを指定しなかったときには、既存の設定データ がそのまま残ります。また、いずれかの設定データとして文字列default を指定しておいた ときには、その設定データはデフォルトの設定データに置き換えられます。
このコマンドをドメイン管理者が使用する場合、更新できるのは、そのドメイン管理者に管 理が許可されているアカウント設定に限られます。
GETACCOUNTDEFAULTS [ domainName ]
このコマンドを使って、ドメインを指定し、そのドメインのデフォルトのアカウント設定を取 得できます。
domainName : 文字列
オプションのパラメータで、ここにはドメイン名を指定します。指定しなかった場合、 管理者のドメインが使われます。
UPDATEACCOUNTDEFAULTS [ domainName ] newSettings
このコマンドを使って、ドメインを指定し、そのドメインのデフォルトのアカウント設定を変 更できます。
domainName : 文字列
オプションのパラメータで、ここにはドメイン名を指定します。指定しなかった場合、管理 者のドメインが使われます。
newSettings : 辞書
このパラメータには、新規のアカウント設定辞書を指定します。既存のアカウント設定辞書 は、この辞書を使って更新されます。新規のアカウント設定辞書には、設定データをすべて 定義する必要はありません。いずれかの設定データを指定しなかったときには、既存の設定 データがそのまま残ります。また、いずれかの設定データとして文字列default を指定して おいたときには、その設定データは、グローバルのサーバーデフォルトアカウント設定デー タに置き換えられます。
このコマンドをドメイン管理者が使用する場合、更新できるのは、そのドメイン管理者に管 理が許可されているデフォルトアカウント設定に限られます。
GETWEBUSERDEFAULTS [ domainName ]
このコマンドを使って、ドメインを指定し、そのドメインのデフォルトのWebUser インターフェ イス設定を取得できます。
domainName : 文字列
オプションのパラメータで、ここにはドメイン名を指定します。指定しなかった場合、管理者のドメインが使われます。
SETWEBUSERDEFAULTS [ domainName ] newSettings
このコマンドを使って、ドメインを指定し、そのドメインのデフォルトのWebUser インターフェ イス設定を変更できます。
domainName : 文字列
オプションのパラメータで、ここにはドメイン名を指定します。指定しなかった場合、認証 済みユーザー( コマンドの実行時に認証されたユーザー) のドメインが使われます。
newSettings : 辞書
このパラメータには、新規のデフォルトのWebUser インターフェイス設定(辞書) を指定 します。既存のデフォルトのWebUser インターフェイス設定はすべて削除され、この WebUser インターフェイス設定に置き換えられます。
このコマンドをドメイン管理者が使用する場合、[WebUserSettings] 権限が付与されてい ることが必要です。
UPDATEWEBUSERDEFAULTS [ domainName ] newSettings
Use this command to change the Default WebUser Interface settings for the specified Domain.
domainName : 文字列
This optional parameter specifies the Domain name. If the Domain name is not specified, the command applies to the authenticated user Domain.
newSettings : 辞書
This dictionary is used to modify the Domain Default WebUser Interface settings. It does not have to contain all settings data, the omitted settings will be left unmodified.
If a new setting value is specified as the string デフォルト, the Domain Default WebUser Interface setting value is removed, so the default Server-wide (or Cluster-wide) WebUser Interface setting value will be used.
This command can be used by Domain Administrators only if they have the WebUserSettings access right.
GETACCOUNTTEMPLATE [ domainName ]
このコマンドを使って、アカウントテンプレート設定を取得できます。出力データは、テンプ レート設定が格納された辞書です。
domainName : 文字列
オプションのパラメータで、ここにはドメイン名を指定します。指定しなかった場合、 管理者のドメインが使われます。
UPDATEACCOUNTTEMPLATE [ domainName ] newSettings
このコマンドを使って、アカウントテンプレート設定を修正(更新) できます。
domainName : 文字列
オプションのパラメータで、ここにはドメイン名を指定します。指定しなかった場合、管理 者のドメインが使われます。
newSettings : 辞書
このパラメータには、新規のドメインアカウントテンプレート(辞書) を指定します。コマ ンドの実行後、新規のアカウントはすべて、このテンプレート設定を使って作成されるよう になります。新規のアカウントテンプレートには、設定データをすべて定義する必要はあり ません。いずれかの設定データを指定しなかったときには、既存の設定データが残ります。 また、いずれかの設定データとして文字列default を指定しておいたときには、その設定 データは、デフォルトの設定データに置き換えられます。
このコマンドをドメイン管理者が使用する場合、更新できるのは、そのドメイン管理者に管 理が許可されているテンプレート設定に限られます。
GETDOMAINALIASES domainName
このコマンドでは、ドメインを指定し、そのドメインのルール( ドメインルール) のリストを 取得できます。出力データは、ドメインに設定されているルールの配列です。
domainName : 文字列
このパラメータには、既存のドメインの名前を指定します。
GETDOMAINMAILRULES domainName
このコマンドでは、ドメインを指定し、そのドメインのルール( ドメインルール) のリストを 取得できます。出力データは、ドメインに設定されているルールの配列です。
domainName : 文字列
このパラメータには、既存のドメインの名前を指定します。
SETDOMAINMAILRULES domainName newRules
このコマンドを使って、ドメインを指定し、そのドメインのルール( ドメインルール) を更新 できます。
domainName : 文字列
このパラメータには、既存のドメインの名前を指定します。
newRules : 配列
このパラメータには、ドメインルールを配列で指定します。既存のドメインルールは、この ドメインルールに置き換えられます。
このコマンドをドメイン管理者が使用する場合、そのドメイン管理者に[RulesAllowed] 権限が付与されていることが必要です。
GETDOMAINSIGNALRULES domainName
Use this command to get the list of Domain Signal Rules. The command produces an output - an array of the Signal Rules specified for the Domain.
domainName : 文字列
This parameter specifies the name of an existing Domain.
SETDOMAINSIGNALRULES domainName newRules
Use this command to set the Domain Signal Rules.
domainName : 文字列
This parameter specifies the name of an existing Domain.
newRules : 配列
This array should contain the Domain Signal Rules. All old Domain Signal Rules are removed.
This command can be used by Domain Administrators only if they have the SignalRulesAllowed access right.
LISTADMINDOMAINS [ domainName ]
このコマンドでは、ドメイン(domainName) を指定し、そのドメインの管理者( ドメイン管 理者) が管理できるドメインのリストを取得できます。
domainName : 文字列
オプションのパラメータで、ここにはドメインを指定できます。指定しなかった場合、 認証済みユーザー( コマンドの実行時に認証されたユーザー) のドメインが値として 使われます。
INSERTDIRECTORYRECORDS domainName
このコマンドでは、ドメインを指定し、そのドメインにオブジェクト(アカウント、グループ、 メーリングリスト、フォワーダ) レコードを挿入できます。
domainName : 文字列
オプションのパラメータで、ここにはドメインを指定できます。指定しなかった場合、認証 済みユーザー( コマンドの実行時に認証されたユーザー)のドメインが値として使われます。
このコマンドをドメイン管理者が使用する場合、そのドメイン管理者に [CentralDirectory] 権限が付与されていることが必要です。
DELETEDIRECTORYRECORDS domainName
このコマンドを使って、ドメインを指定し、そのドメインのオブジェクトレコードを削除でき ます。
domainName : 文字列
オプションのパラメータで、ここにはドメインを指定できます。指定しなかった場合、認証 済みユーザー( コマンドの実行時に認証されたユーザー)のドメインが値として使われます。
このコマンドをドメイン管理者が使用する場合、そのドメイン管理者に[CentralDirectory] アクセス権が付与されていることが必要です。

以下のコマンドは、システム管理者だけが実行できます。

LISTDOMAINS
このコマンドを使って、ドメインのリストを取得できます。出力データは、サーバーの全ドメ インの名前が格納された配列です。
MAINDOMAINNAME
このコマンドを使って、メインドメインの名前を取得できます。出力データは、メインドメイ ンの名前が格納された文字列です。
GETDOMAINDEFAULTS
このコマンドを使って、サーバーワイドのデフォルトのドメイン設定を取得できます。出力デー タは、デフォルトのドメイン設定が格納された辞書です。
UPDATEDOMAINDEFAULTS newSettings
このコマンドを使って、サーバーワイドのデフォルトのドメイン設定(の任意の設定データ) を 更新できます。
newSettings : 辞書
このパラメータには、新規のドメイン設定辞書を指定します。この辞書を使って、デフォルトのドメイン設定辞書が更新されます。新規のドメイン設定辞書には、設定 データをすべて定義する必要はありません。いずれかの設定データを指定しなかった ときには、その設定データに対応するデフォルトの設定データが使われます。
SETDOMAINDEFAULTS newSettings
このコマンドを使って、サーバーワイドのデフォルトのドメイン設定を変更する(全体を置き 換える) ことができます。
newSettings : 辞書
このパラメータには、新規のデフォルトのドメイン設定辞書を指定します。既存のデフォル トのドメイン設定辞書は、この辞書に置き換えられます。
GETCLUSTERDOMAINDEFAULTS
UPDATECLUSTERDOMAINDEFAULTS newSettings
SETCLUSTERDOMAINDEFAULTS newSettings
上の3 つのコマンドはいずれも、ダイナミッククラスタ環境でのみ使用が可能です。
クラスタワイドのデフォルトのドメイン設定を操作したい場合、 [Get|Update|Set]DomainDefaults の各コマンドの代わりに、それぞれ上記の3 つのコ マンド(取得、更新、変更/ 置換) を使用します。
GETALLACCOUNTSDEFAULTS
このコマンドを使って、サーバーワイドのデフォルトのアカウント設定を取得できます。出力 データは、グローバルのデフォルトのアカウント設定が格納された辞書です。
UPDATEALLACCOUNTSDEFAULTS newSettings
このコマンドを使って、サーバーワイドのデフォルトのアカウント設定を更新できます。
newSettings : 辞書
このパラメータには、新規のデフォルトのアカウント設定(辞書) を指定します。この辞書 を使って、デフォルトのアカウント設定辞書が更新されます。新規のアカウント設定辞書に は、設定データをすべて定義する必要はありません。いずれかの設定データを指定しなかっ たときには、その設定データに対応するデフォルトの設定データが使われます。
SETALLACCOUNTSDEFAULTS newSettings
このコマンドを使って、サーバーワイドのデフォルトのアカウント設定を新規の設定(辞書) に 置き換えることができます。
newSettings : 辞書
このパラメータには、新規のデフォルトのアカウント設定辞書を指定します。既存のデフォ ルトのアカウント設定辞書は、この辞書に置き換えられます。
GETCLUSTERACCOUNTDEFAULTS
UPDATECLUSTERACCOUNTDEFAULTS newSettings
SETCLUSTERACCOUNTDEFAULTS newSettings
上の3 つのコマンドはいずれも、ダイナミッククラスタ環境でのみ使用が可能です。
クラスタワイドのデフォルトのアカウント設定を操作したい場合、 [Get|Update|Set]AllAccountsDefaults の各コマンドの代わりに、それぞれ上記の3 つのコマンド(取得、更新、変更/ 置換) を使用します。
GETSERVERWEBUSERDEFAULTS
このコマンドを使って、サーバーワイドのデフォルトのWebUser インターフェイス設定を取得 できます。出力データは、デフォルトのWebUser インターフェイス設定が格納された辞書です。
SETSERVERWEBUSERDEFAULTS newSettings
このコマンドを使って、サーバーワイドのデフォルトのWebUser インターフェイス設定を変更 (置換) できます。
newSettings : 辞書
このパラメータには、新規のデフォルトのWebUser インターフェイス設定辞書を指定しま す。既存のデフォルトのWebUser インターフェイス設定辞書は、この辞書に置き換えられ ます。
GETCLUSTERWEBUSERDEFAULTS
SETCLUSTERWEBUSERDEFAULTS newSettings
上の2 つのコマンドはいずれも、ダイナミッククラスタ環境でのみ使用が可能です。
クラスタワイドのデフォルトのWebUser インターフェイス設定を操作したい場合、 [Get|Set]ServerWebUserDefaults の各コマンドの代わりに、それぞれ上記の2 つのコマ ンド(取得、変更/ 置換) を使用します。
CREATEDOMAIN domainName [ settings ]
このコマンドを使って、新規のセカンダリドメインを作成できます。
domainName : 文字列
このパラメータには、作成するドメイン(セカンダリドメイン) の名前を指定します。
settings : 辞書
オプションのパラメータで、ここにはドメイン設定(辞書) を指定します。
RENAMEDOMAIN oldDomainName into newDomainName
このコマンドを使って、ドメインの名前を変更できます。
oldDomainName : 文字列
このパラメータには、既存のセカンダリドメインの名前を指定します。ここで指定したドメ インの名前が変更されます。
newDomainName : 文字列
このパラメータには、ドメインの新規(変更後) の名前を指定します。
DELETEDOMAIN oldDomainName [ force ]
このコマンドを使って、ドメインを削除できます。
domainName : 文字列
このパラメータには、削除するドメインの名前を指定します。
force
オプションのパラメータ。このパラメータ(文字列) を指定しなかったときには、そのドメ インが空白でないときにはドメインは削除されません。一方、指定しておくと、ドメインの 内容が空白でなくても強制的に削除されます。したがって、アカウントとメーリングリスト はすべて削除されます。
CREATESHAREDDOMAIN domainName [ settings ]
このコマンドを使って、ダイナミッククラスタ環境に新規の共有セカンダリドメインを作成できます。
domainName : 文字列
このパラメータには、作成するドメインの名前を指定します。
settings : 辞書
オプションのパラメータ。ドメイン設定を指定できます。
CREATEDIRECTORYDOMAIN domainName [ settings ]
このコマンドを使って、ディレクトリベースのドメインを新規に作成できます。
domainName : 文字列
作成するドメインの名前を指定します。
settings : 辞書
オプションのパラメータ。ドメイン設定を指定できます。
このコマンドは、ディレクトリベースのドメインが有効に設定されている場合に限っ て使用できます。
RELOADDIRECTORYDOMAINS
このコマンドを使って、Domains ディレクトリの内部をスキャンし、その中にディレクトリベー スのドメインが作成されているかどうかをチェックできます。この処理は、CommuniGate Pro サーバーをバイパスして実行されます。
このコマンドは、ディレクトリベースのドメインが有効に設定されている場合に限って使用で きます。
SETDOMAINALIASES domainName newAliases
このコマンドを使って、ドメインのエイリアスを変更(置換) できます。
domainName : 文字列
このパラメータには、既存のドメインの名前を指定します。
newAliases : 配列
このパラメータには、エイリアス名(文字列) を格納した配列を指定します。既存のエイリ アスはすべて、この配列のエイリアスに置き換えられます。
GETSERVERTRUSTEDCERTS
Use this command to get the server-wide set of Trusted Certificates. The command produces an output - an array of datablocks. Each datablock contains one X.509 certificate data.
SETSERVERTRUSTEDCERTS newCertificates
Use this command to set the server-wide set of Trusted Certificates.
newCertificates : 配列
This array should contain datablocks with X.509 certificate data. It is used to replace the server-wide list of Trusted Certificates.
GETCLUSTERTRUSTEDCERTS
SETCLUSTERTRUSTEDCERTS newCertificates
These commands are available in the Dynamic Cluster only.
Use these commands instead of the [Get|Set]ServerTrustedCerts commands to work with the cluster-wide set of Trusted Certificates.
GETDIRECTORYINTEGRATION
このコマンドを使って、サーバーワイドのディレクトリ統合設定を取得できます。出力データ は、ディレクトリ統合設定が格納された辞書です。
SETDIRECTORYINTEGRATION newSettings
このコマンドを使って、サーバーワイドのディレクトリ統合設定を変更(置換) できます。
newSettings : 辞書
このパラメータには、新規のディレクトリ統合設定辞書を指定します。既存のサー バーワイドのディレクトリ統合設定辞書は、この辞書に置き換えられます。
GETCLUSTERDIRECTORYINTEGRATION
SETCLUSTERDIRECTORYINTEGRATION newSettings
上の2 つのコマンドはいずれも、ダイナミッククラスタ環境でのみ使用が可能です。
クラスタワイドのディレクトリ統合設定を操作したい場合、 [Get|Set]DirectoryIntegration の各コマンドの代わりに、それぞれ上記の2 つのコ マンド(取得、変更/ 置換) を使用します。
SETDOMAINSETTINGS domainName newSettings
このコマンドを使って、ドメイン設定を変更(置換) できます。
domainName : 文字列
このパラメータには、既存のドメインの名前を指定します。
newSettings : 辞書
このパラメータには、新規のドメイン設定辞書を指定します。既存のドメイン設定辞 書は、この辞書に置き換えられます。
SETACCOUNTSETTINGS accountName newSettings
このコマンドを使って、アカウント設定を変更(置換) できます。
accountName : 文字列
このパラメータには、既存のドメインの名前を指定します。
newSettings : 辞書
このパラメータには、新規のアカウント設定辞書を指定します。既存のアカウント設定辞書 は、この辞書に置き換えられます。
SETACCOUNTDEFAULTS [ domainName ] newSettings
このコマンドでは、ドメインを指定し、そのドメインのデフォルトのアカウント設定を変更(置 換) できます。
domainName : 文字列
このパラメータには、デフォルトのアカウント設定を置き換えたいドメインの名前を指定し ます。
newSettings : 辞書
このパラメータには、新規のデフォルトのアカウント設定辞書を指定します。既存のデフォ ルトのアカウント設定辞書は、この辞書に置き換えられます。
SETACCOUNTTEMPLATE [ domainName ] newSettings
このコマンドでは、ドメインを指定し、そのドメインのアカウントテンプレート設定を変更(置 換) できます。
domainName : 文字列
オプションのパラメータ。ここには、ドメインの名前を指定します。指定しなかったときに は、管理者のドメインが使われます。
newSettings : 辞書
このパラメータには、新規のアカウントテンプレート(辞書) を指定します。コマン ドの実行後、新規のアカウントはすべて、このテンプレート設定を使って作成される ようになります。既存のアカウントテンプレート辞書は、ここで指定した辞書に置き 換えられます。したがって、既存のアカウントテンプレート設定はすべて削除されま す。
GETDOMAINLOCATION [ domainName ]
このコマンドを使って、ドメインファイルディレクトリのパス(サーバーのベースディレクト リからの相対パス) を取得できます。出力データは、ドメインファイルディレクトリのパスが 格納された文字列です。
domainName : 文字列
オプションのパラメータで、ドメイン名を指定できます。指定しなかったときには、管理者 のドメインが値として使われます。
GETACCOUNTLOCATION accountName
このコマンドを使って、アカウントファイルディレクトリのパス(マルチメールボックスアカ ウントの場合)、または、アカウントINBOX メールボックスのパス(シングルメールボックス アカウントの場合) を取得できます。出力データは、アカウントファイルディレクトリのパス が格納された文字列です。このパスは、ドメインディレクトリからの相対パスです。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。このアカウントのアカ ウントファイル(またはINBOX メールボックス) のパスが取り出されます。名前に は、ドメイン名を付加することもできます(上記を参照)。

メールボックスの管理

以下、メールボックスの管理に関するCLI コマンドについて説明します。メールボックスの管理に 関するCLI コマンドを使用する場合、[Can Modify All Domains and Account Settings ] 権限、または [CanAccessMailboxes] 権限(ドメイン管理アクセス権) が必要です。

LISTMAILBOXES accountName [ FILTER filter] [ AUTH authAccountName]
このコマンドでは、既存のアカウントを指定し、そのアカウントのメールボックスのリストを 取得できます。出力データは辞書です。
出力された辞書のキーはいずれもメールボックスの名前です。
パラメータauthAccountName を指定しなかったとき、または、authAccountName を指定し、 accountName で指定したアカウント(ユーザー) に、authAccountName で指定したメールボック スに対する[Select] 権限が付与されていたときには、辞書のキー値に辞書が格納されます。 この辞書にはメールボックス情報が格納されています。
一方、accountName で指定したユーザーにメールボックスの[Select] 権限が付与されていな かったときには、辞書のキー値には空白の配列が格納されます。
辞書のキーが「メールボックスフォルダ」で、その名前の「正規」のメールボックスが存在し なかったときには、キーの値には空白の配列が格納されます。
一方、辞書のキーが「メールボックスフォルダ」で、その名前の「正規」のメールボックスが 存在したときには、キーの値には要素が1 つの配列が格納されます。この配列には、「正規」の メールボックスに関する情報(辞書または空白の配列のいずれか) が格納されます。
accountName : 文字列
このパラメータには、既存のアカウントを指定します。このパラメータには、アステリスク (*) を指定することもできます。その場合、アステリスクは、カレントの認証済みアカウン ト(コマンドの実行時に認証されたアカウント) と解釈されます。
filter : 文字列
このパラメータには、フィルタ文字列を指定できます。フィルタ文字列には、IMAP LIST コ マンドと同じワイルドカード記号(* と%) を使用できます。フィルタ文字列を指定しなかっ た場合、デフォルトのフィルタ文字列として"*" が使われます。したがって、すべてのメー ルボックスが取り出されます。
authAccountName : 文字列
オプションのパラメータ。ここには、このコマンドの実行対象となるアカウント (ユーザー) 名を指定できます。つまり、accountName のアカウントではなく、このア カウントに対してコマンドが実行され、そのメールボックスのリストが出力されます。 なお、指定した場合、メールボックスのうち、accountName のユーザーに付与されて いるメールボックス検索(Lookup) 権限で取得できるメールボックスだけが取り出さ れます。
CREATEMAILBOX accountName MAILBOX mailboxName [ AUTH authAccountName]
このコマンドでは、アカウントを指定し、そのアカウントのメールボックスを作成できます。
accountName : 文字列
このパラメータには、既存のアカウントを指定します。このパラメータには、アステリスク (*) を指定することもできます。その場合、アステリスクは、カレントの認証済みアカウン ト(コマンドの実行時に認証されたアカウント) と解釈されます。
mailboxName : 文字列
このパラメータには、新規のメールボックス(作成されるメールボックス) の名前を指定し ます。
authaccountname : 文字列
オプションのパラメータ。ここには、このコマンドの実行対象となるアカウント (ユーザー) 名を指定できます。つまり、accountName のアカウントではなく、このア カウントに対してコマンドが実行されます。指定した場合、authaccountname のメール ボックスは、accountName のユーザーに「外部」メールボックスの[Create] 権限が付 与されている場合に限って作成されます(accountName のユーザーにアーカイブメー ルボックスに対する「Create」権限が付与されており、したがってアーカイブ/ マー チメールボックスを作成できる権限がなければなりません)。
DELETEMAILBOX accountName MAILBOX mailboxName [ AUTH authAccountName]
DELETEMAILBOX accountName MAILBOXES mailboxName [ AUTH authAccountName]
このコマンドでは、既存のアカウントを指定し、そのアカウントのメールボックスを削除でき ます。キーワードMAILBOXES を指定した場合、入れ子のメールボックス(サブメールボック ス) もすべて削除されます。
accountName : 文字列
このパラメータには、既存のアカウントを指定します。このパラメータには、アステリスク (*) を指定することもできます。その場合、アステリスクは、カレントの認証済みアカウン ト(コマンドの実行時に認証されたアカウント) と解釈されます。
mailboxName : 文字列
このパラメータには、削除するメールボックスの名前を指定します。
authaccountname : 文字列
オプションのパラメータ。ここには、このコマンドの実行対象となるアカウント (ユーザー) 名を指定できます。つまり、accountName のアカウントではなく、このア カウントに対してコマンドが実行されます。指定した場合、authaccountname のメール ボックスは、accountName のユーザーに「外部」メールボックスに関する[Create] 権 限が付与されており(アーカイブメールボックスに対する「Create」権限が付与されており、したがってアーカイブ/ マーチメールボックスの削除が可能)、かつ、 authaccountname のメールボックスについて[DELETE] 権限が付与されている場合に 限って削除されます。
RENAMEMAILBOX accountName MAILBOX mailboxName INTO newMailboxName [ AUTH authAccountName]
RENAMEMAILBOX accountName MAILBOXES mailboxName INTO newMailboxName [ AUTH authAccountName]
このコマンドを使って、アカウントを指定し、そのメールボックスの名前を変更できます。キー ワードMAILBOXES を指定した場合、入れ子のメールボックス(サブメールボックス) の名前 もすべて変更されます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
mailboxName : 文字列
このパラメータには、その名前を変更したいメールボックスの名前を指定します。
newMailboxName : 文字列
このパラメータには、メールボックスの新規(変更後) の名前を指定します。
authaccountname : 文字列
オプションのパラメータ。ここには、このコマンドの実行対象となるアカウント (ユーザー) 名を指定できます。つまり、accountName のアカウントではなく、このア カウントに対してコマンドが実行されます。指定した場合、authaccountname のメール ボックスの名前は、accountName のユーザーに対して、authaccountname の既存のメー ルボックスの名前についてDELETEMAILBOX 処理を実行できる権限、また新規のメー ルボックスの名前についてCREATEMAILBOX 処理を実行できる権限の両方が付与され ている場合に限って変更されます。
GETMAILBOXINFO accountName MAILBOX mailboxName [ AUTH authAccountName]
このコマンドを使って、既存のアカウントを指定し、そのアカウントのメールボックスの内部 情報を取得できます。出力データは、メールボックスの内部情報が格納された辞書です。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
mailboxName : 文字列
このパラメータには、指定したアカウントのメールボックスの名前を指定します。このメー ルボックスの内部情報が取り出されます。
authaccountname : 文字列
オプションのパラメータ。ここには、このコマンドの実行対象となるアカウント (ユーザー) 名を指定できます。つまり、accountName のアカウントではなく、このア カウントに対してコマンドが実行されます。指定した場合、authaccountname のメール ボックスの内部情報は、accountName のユーザーに対して[Select mailbox] 権限が付与 されている場合に限って取得されます。
GETMAILBOXACL accountName MAILBOX mailboxName [ AUTH authAccountName]
このコマンドでは、既存のメールボックスを指定し、そのメールボックスのアクセスコントロー ルリスト(ACL) を取得できます。出力データは、メールボックスに対するアクセス権限情報 が格納された辞書です。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
mailboxName : 文字列
このパラメータには、指定した既存のアカウントのメールボックスの名前を指定します。
authaccountname : 文字列
オプションのパラメータ。ここには、このコマンドの実行対象となるアカウント (ユーザー) 名を指定できます。つまり、accountName のアカウントではなく、このア カウントに対してコマンドが実行されます。指定した場合、authaccountname のアクセ スコントロールリスト(アクセス権限情報) は、accountName のユーザーに対して、 authaccountname のメールボックスの[Admin] 権限が付与されている場合に限って取 得されます。
SETMAILBOXACL accountName MAILBOX mailboxName [ AUTH authAccountName] newACL
このコマンドでは、既存のアカウントを指定し、そのアカウントのメールボックスのアクセス コントロールリストの内容を変更できます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
mailboxName : 文字列
このパラメータには、指定したアカウントのメールボックスの名前を指定します。
authaccountname : 文字列
オプションのパラメータ。ここには、このコマンドの実行対象となるアカウント(ユーザー) 名を指定できます。つまり、accountName のアカウントではなく、このアカウントに対して コマンドが実行されます。指定した場合、authaccountname のアクセスコントロールリスト は、accountName のユーザーに対して、authaccountname のメールボックスに関する[Admin] 権限が付与されている場合に限って修正されます。
newACL : 辞書
このパラメータには、辞書を指定します。辞書のキーには、アクセス権要素(複数のアクセ ス権で構成) の識別子を指定します。キーの値には、キーで指定したアクセス権要素の内容 (アクセス権) を定義した文字列を指定し、下記の要領で先頭に記号を付加します。
既存のアクセス権要素のアクセス権のうち削除したいものがある場合、そのアクセス権(複 数可) を文字列に定義し、文字列の先頭にマイナス記号("-") を付加します。
既存のアクセス権要素に追加したいアクセス権がある場合、そのアクセス権(複数可) を文 字列に定義し、文字列の先頭にプラス記号("+") を付加します。
既存のアクセス権要素のアクセス権のうち置き換えたいものがある場合、そのアクセス権 (複数可) を文字列に指定し、文字列には何も記号を付けないでおきます。
既存のアクセス権要素の中に、キーに指定したアクセス権要素がなかった場合、そのアクセ ス権要素(文字列で指定した各アクセス権が定義されているアクセス権要素) が作成されま す。
アクセス権要素自体を削除したい場合、文字列の内容を空にしておきます。これで、 そのアクセス権要素に対応する既存のアクセス権要素が削除されます。
GETMAILBOXRIGHTS accountName MAILBOX mailboxName AUTH authAccountName
このコマンドでは、既存のアカウントを指定し、そのアカウントのメールボックスのアクセス コントロールリストの内容を取得できます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
mailboxName : 文字列
このパラメータには、指定したアカウントのメールボックスの名前を指定します。このメー ルボックスのアクセス権が取得されます。
authaccountname : 文字列
オプションのパラメータ。ここには、このコマンドの実行対象となるアカウント (ユーザー) 名を指定できます。つまり、accountName のアカウントではなく、このア カウントに対してコマンドが実行されます。指定した場合、authaccountname のユー ザーの有効アクセス権が取り出されます。
SETMAILBOXCLASS accountName MAILBOX mailboxName [ AUTH authAccountName ] CLASS newClass
このコマンドでは、既存のアカウントを指定し、そのアカウントのメールボックスの「クラス」 を設定できます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
mailboxName : 文字列
このパラメータには、指定したアカウントのメールボックスの名前を指定します。このメー ルボックスにクラスが設定されます。
authaccountname : 文字列
オプションのパラメータ。ここには、このコマンドの実行対象となるアカウント(ユーザー) 名を指定できます。つまり、accountName のアカウントではなく、このアカウントに対して コマンドが実行されます。
newClass : 文字列
メールボックスに設定するクラスを指定します。
GETACCOUNTSUBSCRIPTION accountName
このコマンドでは、アカウントを指定し、そのアカウントの「サブスクライブメールボックス」 のリストを取得できます。出力データは、配列です。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
SETACCOUNTSUBSCRIPTION accountName newSubscription
このコマンドでは、アカウントを指定し、そのアカウントの「サブスクライブメールボックス」 を設定できます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
newSubscription : 配列
このパラメータには、サブスクライブメールボックスのリストを配列で指定します。 配列の各要素は文字列で、文字列にはメールボックスの名前を指定します。
GETMAILBOXALIASES accountName
このコマンドでは、既存のアカウントを指定し、そのメールボックスのエイリアスを取得でき ます。出力データは辞書です。辞書のキーはメールボックスのエイリアスの名前で、キーの値 は文字列です。文字列には、そのエイリアスに対応するメールボックスの名前が格納されています。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
SETMAILBOXALIASES accountName newAliases
このコマンドでは、アカウントを指定し、そのアカウントのメールボックスのエイリアスを設 定できます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
newAliases : 辞書
メールボックスに設定するエイリアスのセットです。形式は、辞書です。

アラートの管理

以下、アラートの管理に関するCLI コマンドについて説明します。アラート の管理に関するCLI コ マンドを使用する場合、ユーザーに[Domain Administration access right ] アクセス権、また は[CanPostAlerts] アクセス権(ドメイン管理アクセス権) が付与されていることが必要です。

GETDOMAINALERTS [ domainName ]
このコマンドでは、ドメインアラート( ドメインワイドのアラート) を取得できます。出力デー タは辞書で、辞書にはアラートの文字列とタイムスタンプが格納されています。
domainName : 文字列
オプションのパラメータで、既存のドメインの名前を指定できます。指定した場合、このド メインのアラートが取り出されます。
SETDOMAINALERTS [ domainName ] newAlerts
このコマンドでは、ドメインアラートの設定が可能です。
domainName : 文字列
オプションのパラメータで、既存のドメインの名前を指定できます。指定した場合、そのド メインのアラートの設定が可能です。
newAlerts : 辞書
ここに新規のドメインアラート辞書を指定します。既存のドメインアラート辞書は、この辞 書に置き換えられます。既存のドメインアラートはすべて削除されます。
POSTDOMAINALERT domainName ALERT newAlert
このコマンドでは、ドメインアラート( ドメインワイドのアラートメッセージ) をポスト(送 信) できます。
domainName : 文字列
オプションのパラメータで、既存のドメインの名前を指定できます。指定する場合、名前の 後ろにキーワードとして文字列ALERT を付加しなければなりません。
newAlert : 文字列
ここにアラートのテキスト(本文) を指定します。
REMOVEDOMAINALERT domainName ALERT timeStamp
このコマンドでは、ドメインワイドのアラートメッセージを削除できます。
domainName : 文字列
オプションのパラメータで、既存のドメインの名前を指定できます。指定する場合、名前の 後ろにキーワードとして文字列ALERT を付加しなければなりません。
timeStamp : 文字列
このパラメータには、削除したいアラートのタイムスタンプを指定します。
GETACCOUNTALERTS accountName
このコマンドでは、アカウントを指定し、そのアカウントに出力されたアラート(アカウント アラート) を取得できます。出力データは辞書で、辞書には、アカウントアラートの本文とタ イムスタンプが格納されています。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
SETACCOUNTALERTS accountName newAlerts
このコマンドでは、アカウントを指定し、そのアカウントのアラート(アカウントアラート) の 変更(置換) が可能です。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
newAlerts : 辞書
ここに新規のアカウントアラート辞書を指定します。既存のアカウントアラート辞書は、こ の辞書に置き換えられます。既存のアカウントアラートはすべて削除されます。
POSTACCOUNTALERT accountName ALERT newAlert
このコマンドを使って、アカウントアラートをポスト(送信) できます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
newAlert : 文字列
ここにアラートのテキスト(本文) を指定します。
REMOVEACCOUNTALERT accountName ALERT timeStamp
このコマンドを使って、アカウントアラートを削除できます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
timeStamp : 文字列
このパラメータには、削除したいアラートのタイムスタンプを指定します。

以下のコマンドはいずれも、システム管理者だけが実行できます。

GETSERVERALERTS
このコマンドを使って、サーバーワイドのアラート(サーバーアラート) のリストを取得でき ます。出力データは辞書で、辞書には、サーバーアラートとタイムスタンプが格納されています。
SETSERVERALERTS newAlerts
このコマンドを使って、サーバーワイドのアラート(サーバーアラート) を設定(置換)できます。
newAlerts : 辞書
このパラメータには、新規のサーバーアラート辞書を指定します。既存のサーバーアラート 辞書は、この辞書に置き換えられます。既存のサーバーアラートはすべて削除されます。
POSTSERVERALERT newAlert
このコマンドを使って、サーバーアラートをポスト(送信) できます。
newAlert : 文字列
ここにサーバーアラートのテキスト(本文) を指定します。
REMOVESERVERALERT timeStamp
このコマンドを使って、サーバーアラートを削除できます。
timeStamp : 文字列
このパラメータには、削除したいサーバーアラートのタイムスタンプを指定します。
GETCLUSTERALERTS
SETCLUSTERALERTS newAlerts
POSTCLUSTERALERT newAlert
REMOVECLUSTERALERT timeStamp
上の4 つのコマンドはいずれも、ダイナミッククラスタ環境でのみ使用できます。
クラスタワイドのアラートを操作したい場合、 [Get|Set|Post|Remove]ServerAlert[s] の各コマンドの代わりに、上記のコマンドを 使います。

ファイルストレージの管理

以下のコマンドでは、アカウントのファイルストレージの操作が可能です。private ディレクトリ とそのサブディレクトリにあるファイルを取り出すことができます。以下のコマンドは、そのアカウ ントのオーナーが使用できます。また、[Can Modify All Domains and Account Settings ]アクセス権、 または、そのWeb サイトのドメイン管理アクセス権 を有するユーザーも使用が可能です。

GETWEBFILE accountName FILE fileName [ OFFSET position ] [ SIZE sliceSize ]
このコマンドを使って、アカウントのパーソナルファイルサイトからファイルを取り出すこ とができます。出力は、3 つの文字列で構成される配列です。最初の文字列は、指定した ファイルのbase64 エンコードデータです。2 番目の文字列はファイルが変更された日 (ACAP 時刻フォーマット)、3 番目はカレントのファイルサイズです。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指 定することもできます。その場合、アステリスクは、カレントの認証済みアカウント ( コマンドの実行時に認証されたアカウント) と解釈されます。
fileName : 文字列
このパラメータには、パーソナルWeb サイトファイルの名前を指定します。このファ イルが取り出されます。
position : number
オプションのパラメータ。ここには、パーソナルWeb サイトファイルの読み取りを開始す る位置を指定できます。
sliceSize : number
オプションのパラメータ。ここには、ファイルから読み取るデータの最大量(バイト 数) を指定できます。

ファイルストレージの管理に関するコマンドは、そのアカウントのオーナーが使用できます。また、 [Can Modify All Domains and Account Settings ]アクセス権、または、そのWeb サイトのドメイン管理アクセス権 を有するユーザーも使用が可能です。

PUTWEBFILE accountName FILE fileName [ OFFSET position ] DATA fileData
このコマンドでは、アカウントを指定し、そのアカウントのパーソナルWeb サイトにファイル を格納(送信) できます。指定したファイルと同じ名前のファイルがあった場合、そのファイ ルは置き換えられます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
fileName : 文字列
このパラメータには、パーソナルWeb サイトに送るファイルの名前を指定します。
position : number
このパラメータには、パーソナルWeb サイトの既存のファイルの位置を示す数値(0 以外) を指定できます。数値を指定したときには、その位置から既存のファイルが書き換えまたは 拡張されます。このパラメータを指定する場合、既存のファイルが存在しなければならず、 また、指定する数値は、既存のファイルのサイズより小さくなければなりません。
fileData : 文字列
このパラメータには、既存のパーソナルWeb サイトに送るファイルのデータを指定し ます。データは、Base64 エンコードデータでなければなりません。
RENAMEWEBFILE accountName FILE oldFileName INTO newFileName
このコマンドでは、アカウントを指定し、そのアカウントのパーソナルWeb サイトのファイル 名を変更できます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
oldFileName : 文字列
パーソナルWeb サイトの既存のファイルの名前を指定します。
newFileName : 文字列
パーソナルWeb サイトの既存のファイルの新規(変更後) の名前を指定します。
DELETEWEBFILE accountName FILE fileName
このコマンドでは、アカウントを指定し、そのアカウントのパーソナルWeb サイトのファイル を削除できます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定するこ ともできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンドの実行時 に認証されたアカウント) と解釈されます。
oldFileName : 文字列
パーソナルWeb サイトの既存のファイルの名前を指定します。このファイルが削除さ れます。
LISTWEBFILES accountName [ PATH filePath]
このコマンドでは、アカウントを指定し、そのアカウントのパーソナルWeb サイトの各ファイ ルのリストを取得できます。いずれかのサブディレクトリを指定することもできます。出力デー タは辞書です。辞書のキーにはファイルの名前が、キーの値には、そのファイルのディレクト リが格納されます。辞書のキーがサブディレクトリの場合、値には空白の配列が格納されます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
filePath : 文字列
オプションのパラメータで、ここにはパーソナルWeb サイトのいずれかのサブディレクト リを指定できます。このパラメータを指定しなかったときには(キーワードPATH も記述 しないようにします)、最上位のWeb サイトディレクトリの中のWeb サイトファイルがす べて返ります。
GETWEBFILESINFO accountName
このコマンドでは、アカウントを指定し、そのアカウントのパーソナルWeb サイトのファイル に関する統計情報(合計サイズと合計ファイル数) を取得できます。このコマンドの出力デー タは配列で、配列には2 つの文字列が格納されています。最初の文字列にはパーソナルWeb サ イトの全ファイルの合計サイズ、2 番目の文字列にはパーソナルWeb サイトのファイルの合計 数が格納されています。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指 定することもできます。その場合、アステリスクは、カレントの認証済みアカウント ( コマンドの実行時に認証されたアカウント) と解釈されます。

メーリングリストの管理

以下、メーリングリストの管理に関するCLI コマンドについて説明します。メーリングリストの管 理に関するCLI コマンドを使用する場合、アカウント/ ドメインサーバーアクセス権 またはドメイ ン管理アクセス権 が必要です。

LISTLISTS [ domainName ]
このコマンドでは、ドメインを指定し、そのドメインの全メーリングリストのリストを取得で きます。出力データは文字列の配列です。各文字列にはそれぞれ、指定した(またはデフォル トの) ドメインのメーリングリストの名前が格納されています。
domainName : 文字列
オプションのパラメータで、ここにはドメインの名前を指定できます。このドメインについ て、処理が実行されます。
GETDOMAINLISTS [ domainName ]
このコマンドでは、ドメインを指定し、そのドメインの全メーリングリストのリストを取得で きます。出力データは辞書です。辞書のキーにはそれぞれ、指定した(またはデフォルトの) ド メインのメーリングリストの名前が格納されます。キーの値には、そのメーリングリストの加 入ユーザーの数が格納されます(加入ユーザーの数が不明の場合、"-1" が表示されます)。
domainName : 文字列
オプションのパラメータで、ここにはドメインの名前を指定できます。このドメインについ て、処理が実行されます。
GETACCOUNTLISTS accountName
このコマンドでは、アカウント(ユーザー) を指定し、そのユーザーがオーナーであるメーリ ングリストのリストを取得できます。出力データは辞書です。辞書のキーにはそれぞれ、指定 したユーザーがオーナーであるメーリングリストの名前が格納されます。キーの値には、その メーリングリストの加入ユーザーの数が格納されます(加入ユーザーの数が不明の場合、"-1" が表示されます)。
accountName : 文字列
このパラメータには、アカウント(ユーザー) の名前を指定します。このユーザーが オーナーであるメーリングリストが取り出されます。
CREATELIST listName for accountName
このコマンドでは、メーリングリストの名前とアカウントを指定し、新規のメーリングリスト を作成できます。
listName : 文字列
このパラメータには、作成するメーリングリストの名前を指定します。名前にはドメイン名 を付加することもできます。ドメイン名を付加しなかったときには、ユーザー( このコマン ドを実行するユーザー) のドメインが使われます。
accountName : 文字列
このパラメータには、メーリングリストのオーナーとなるアカウントの名前を指定します。 このアカウントは、メーリングリストが作成されるドメインに存在しなければなりません。
このコマンドをドメイン管理者が使用する場合、処理対象のドメインについて [CanCreateLists] 権限が付与されていることが必要です。
RENAMELIST listName into newName
このコマンドでは、既存のメーリングリストの名前を変更できます。
listName : 文字列
このパラメータには、名前を変更したいメーリングリストの名前を指定します。名前にはド メイン名を付加することもできます。ドメイン名を付加しなかったときには、ユーザー(こ のコマンドを実行するユーザー) のドメインが使われます。
newName : 文字列
このパラメータには、メーリングリストの新規(変更後) の名前を指定します( ドメイン名 は付加できません)。
このコマンドをドメイン管理者が使用する場合、処理対象のドメインについて[CanCreateLists] 権限が付与されていることが必要です。
DELETELIST listName
このコマンドを使って、既存のメーリングリストを削除できます。
listName : 文字列
このパラメータには、削除したいメーリングリストの名前を指定します。名前にはドメイン 名を付加することもできます。ドメイン名を付加しなかったときには、ユーザー( このコマ ンドを実行するユーザー) のドメインがデフォルトとして使われます。
このコマンドをドメイン管理者が使用する場合、処理対象のドメインについて[CanCreateLists] 権限が付与されていることが必要です。

以下のコマンドは、メーリングリストのオーナーだけが使用できます。/p>

GETLIST listName
このコマンドを使って、メーリングリストの設定を取得できます。出力データは辞書で、辞書 にはlistName で指定したメーリングリストの設定が格納されています。
listName : 文字列
このパラメータには、既存のメーリングリストの名前を指定します。名前にはドメイ ン名を付加することもできます。ドメイン名を付加しなかったときには、ユーザー ( このコマンドを実行するユーザー) のドメインがデフォルトとして使われます。
UPDATELIST listName newSettings
このコマンドを使って、メーリングリストの設定を更新できます。
listName : 文字列
このパラメータには、既存のメーリングリストの名前を指定します。名前にはドメイン名を 付加することもできます。ドメイン名を付加しなかったときには、ユーザー( このコマンド を実行するユーザー) のドメインがデフォルトとして使われます。
newSettings : 辞書
このパラメータには、新規のメーリングリスト設定辞書を指定します。辞書には設定 データをすべて定義する必要はありません。いずれかの設定データを定義しなかった 場合、既存の辞書の設定データがそのまま残ります。
LIST listName operation [silently] [confirm] subscriber
このコマンドでは、メーリングリストと加入ユーザーを指定し、その加入ユーザーに関する設 定を変更できます。
listName : 文字列
このパラメータには、既存のメーリングリストの名前を指定します。名前にはドメイン名を 付加することもできます。ドメイン名を付加しなかったときには、ユーザー( このコマンド を実行するユーザー) のドメインがデフォルトとして使われます。
operation : subscribe | feed | digest | index | null | banned | unsubscribe
このパラメータには、処理の種類を指定します (see the LIST モジュール section for the details).
silently
オプションのパラメータ。このパラメータを指定しておくと、加入ユーザーにWelcome/Bye メッセージが送信されなくなります。
confirm
オプションのパラメータ。このパラメータを指定しておくと、加入ユーザーに確認要求が送 信されます。
subscriber : E-mail address
このパラメータには、加入ユーザーの電子メールアドレスを指定します。この加入ユーザー について処理が実行されます。電子メールアドレスの前には、その加入ユーザーの実名をコ メントとして付加することもできます(引用符で囲みます)。
下は、実名を付加する場合の例です。
LIST MyList@mydomain.com FEED confirm "Bill Jones" <BJones@company.com>
LISTSUBSCRIBERS listName [ FILTER filter [ limit ] ]
このコマンドを使って、メーリングリストの加入ユーザーのリストを取得できます。出力デー タは、加入ユーザーの電子メールアドレスが格納された配列です。
listName : 文字列
このパラメータには、既存のメーリングリストの名前を指定します。名前にはドメイン名を 付加することもできます。ドメイン名を付加しなかったときには、ユーザー( このコマンド を実行するユーザー) のドメインがデフォルトとして使われます。
filter : 文字列
オプションのパラメータ。ここに文字列(フィルタ) を指定しておくと、電子メールアドレ スのうち、この文字列が含まれる電子メールアドレスだけが取り出されます。
limit : number
オプションのパラメータ。取り出される電子メールアドレスの数を指定できます。
READSUBSCRIBERS listName [ FILTER filter [ limit ] ]
このコマンドでは、メーリングリストの加入(購読) ユーザーのリストを取り出せます。こ のコマンドの出力は配列で、配列の要素は加入ユーザーの識別子の辞書です。
listName : 文字列
このパラメータには、既存のメーリングリストの名前を指定します。名前にはドメイ ン名を付加できます。ドメイン名を指定しなかったときには、そのユーザーのドメイ ンがデフォルトのドメインとして使用されます。
filter : 文字列
オプションの文字列パラメータで、フィルタです。アドレスを指定しておくと、その アドレスの加入ユーザーだけが取り出されます。
limit : number
オプションのパラメータです。このパラメータには加入ユーザーの数を指定でき、こ の数を上限として加入ユーザーが取り出されます。

加入ユーザーの辞書の要素は次の通りです。

Sub
電子メールアドレス(文字列)
RealName
オプションの文字列で、実名。
mode
加入モード( インデックス、ダイジェスト、NULL など)。
subscribeTime
タイムスタンプデータで、このユーザーが加入したときの日時。
posts
このメーリングリストの投稿数。
lastBounceTime
オプションのタイムスタンプデータ。このユーザーに対するメッセージの送信が失敗 したときの時刻(最新の失敗)
bounces
オプションの数値データ。このユーザーに送信された配信失敗レポートの数。
GETSUBSCRIBERINFO listName NAME subscriberAddress
このコマンドを使って、メーリングリストの加入ユーザーに関する情報を取得できます。出力 データは辞書で、加入ユーザーに関する情報が格納されています。
listName : 文字列
このパラメータには、既存のメーリングリストの名前を指定します。名前にはドメイン名を 付加することもできます。ドメイン名を付加しなかったときには、ユーザー( このコマンド を実行するユーザー) のドメインがデフォルトとして使われます。
subscriberAddress : 文字列
このパラメータには、加入ユーザーの電子メールアドレスを指定します。この加入ユーザー に関する情報が取り出されます。
指定した加入ユーザーが存在しなかったときには、空白の辞書が返ります。存在したときには、 辞書には次の要素が格納されます。
mode
文字列要素で、ここには購読モードを示す文字列(digest、index など) が格納されます。 ユーザーが購読を解除した後、その電子メールアドレスがまだ削除されていない場合、内容 としては購読解除(unsubcribe) という文字列が格納されます。また、新規のユーザーが購 読を開始し、購読がまだ確認されていない場合、購読(subcribe) という文字列が格納され ます。
confirmationID
この要素には、加入ユーザーの確認ID (Confirmation ID) が格納されます。
timeSubscribed
文字列要素で、ここにはユーザーが購読を開始した日時(ACAP 日付/ 時刻フォーマット) が格納されます。
posts
文字列要素で、ここにはメーリングリストへのポストに関する文字列(special、moderateAll、 prohibited) が格納されます。または、加入ユーザーからポストされたメッセージの数が格 納されます。もしくは、この加入ユーザーからのメッセージが以後、モデレートされるよう に設定されている場合、この要素には、今後モデレートされるメッセージの数が格納されま す。
bounces
オプションの文字列要素で、ここには加入ユーザーからバウンスされたメッセージ(宛先不 明などで戻ってきたメッセージ) の数が格納されます。
lastBounced
オプションの文字列要素で、ここにはバウンスされたメッセージのうち、最後にバウンスさ れたメッセージが受信された日付と時刻が格納されます。日付と時刻は、ACAP フォーマッ トで示されます。
RealName
オプションの文字列要素で、ここには加入ユーザーの実名が格納されます。
SETPOSTINGMODE listName FOR subscriberAddress [ UNMODERATED | MODERATEALL | PROHIBITED | SPECIAL | numberOfModerated ]
このコマンドでは、加入ユーザーを指定し、その加入ユーザーのポスティングモードを設定できます。
listName : 文字列
このパラメータには、既存のメーリングリストの名前を指定します。名前にはドメイン名を 付加することもできます。ドメイン名を付加しなかったときには、ユーザー( このコマンド を実行するユーザー) のドメインがデフォルトとして使われます。
subscriberAddress : 文字列
このパラメータには、メーリングリストの加入ユーザーの電子メールアドレスを指定しま す。この加入ユーザーに対して、処理が実行されます。
postingMode : number
オプションのパラメータ。このパラメータでは、ポスティングモード(UNMODERATED な ど) を指定できます。
ポスティングモードとしてnumberOfModerated (数値) を指定した場合、以後、加入ユー ザーからポストされるメッセージのうちnumberOfModeratedで指定されている数だけのメッ セージがモデレートされます。
PROCESSBOUNCE listName [FATAL] FOR subscriberAddress
このコマンドを使って、メーリングリストの加入ユーザーを指定し、その加入ユーザーからの バウンスメッセージをエミュレートできます。この処理は、List Manager の処理と同じです。
listName : 文字列
このパラメータには、既存のメーリングリストの名前を指定します。名前にはドメイン名を 付加することもできます。ドメイン名を付加しなかったときには、ユーザー( このコマンド を実行するユーザー) のドメインがデフォルトとして使われます。
subscriberAddress : 文字列
メーリングリストの加入ユーザーの電子メールアドレスを指定します。
FATAL キーワードを指定すると、「致命的」バウンスをエミュレートできます。そうでない 場合、非致命的バウンスがエミュレートされます。

Web スキンの管理

CommuniGate Pro のWebUser インターフェイスにはスキンが使われます。以下、CommuniGate Pro のスキンの管理に関するCLI コマンドについて説明します。

スキンの管理に関するCLI コマンドを使用する場合、ユーザーにはアカウント設定アクセス権 また は[CanModifySkins] 権限(ドメイン管理アクセス権) が必要です。

LISTDOMAINSKINS [domainName]
このコマンドを使って、カスタムのドメインスキンのリストを取得できます。出力データは配 列で、配列にはスキンの名前が格納されています。
domainName : 文字列
オプションのパラメータで、ここにドメイン名を指定できます。指定しなかった場合、 管理者のドメインがデフォルトとして使われます。
CREATEDOMAINSKIN [domainName SKIN] skinName
このコマンドを使って、カスタムのドメインスキンを作成できます。
domainName : 文字列
オプションのパラメータで、ここにドメイン名を指定できます。指定しなかった場合、管理 者のドメインがデフォルトとして使われます。指定する場合、ドメイン名の右にキーワード SKIN を付加しなければなりません。
skinName : 文字列
作成するスキンの名前を指定します。
RENAMEDOMAINSKIN [domainName SKIN] skinName INTO newSkinName
このコマンドを使って、カスタムのドメインスキンの名前を変更できます。
domainName : 文字列
オプションのパラメータで、ここにドメイン名を指定できます。指定しなかった場合、管理 者のドメインがデフォルトとして使われます。指定する場合、ドメイン名の右にキーワード SKIN を付加しなければなりません。
skinName : 文字列
このパラメータには、既存のスキン(名前を変更するスキン) の名前を指定します。
newSkinName : 文字列
このパラメータには、スキンの新規の名前を指定します。
DELETEDOMAINSKIN [domainName SKIN] skinName
このコマンドを使って、カスタムのドメインスキンを削除できます。
domainName : 文字列
オプションのパラメータで、ここにドメイン名を指定できます。指定しなかった場合、管理 者のドメインがデフォルトとして使われます。指定する場合、ドメイン名の右にキーワード SKIN を付加しなければなりません。
skinName : 文字列
削除するスキンの名前を指定します。
LISTDOMAINSKINFILES [ domainName SKIN] skinName
このコマンドを使って、カスタムのドメインスキンを構成しているファイルのリストを取得で きます。出力データは辞書で、辞書のキーにはスキンのファイルの名前が格納されます。キー の値はディレクトリです(ファイル属性も表示されます)。
domainName : 文字列
Tオプションのパラメータで、ここにドメイン名を指定できます。指定しなかった場合、管理 者のドメインがデフォルトとして使われます。指定する場合、ドメイン名の右にキーワード SKIN を付加しなければなりません。
skinName : 文字列
既存のドメインスキンの名前を指定します。
READDOMAINSKINFILE [ domainName SKIN] skinName FILE fileName
このコマンドでは、カスタムのドメインスキンとスキンファイルを指定し、そのファイルの読 み取りが可能です。出力データは配列です。配列の最初の要素は文字列で、この文字列には、指 定したスキンファイルの内容(BASE64 エンコードデータ) が格納されます。2 番目の要素も文 字列で、ファイルの更新日がACAP フォーマットで格納されます。
domainName : 文字列
オプションのパラメータで、ここにドメイン名を指定できます。指定しなかった場合、管理 者のドメインがデフォルトとして使われます。指定する場合、ドメイン名の右にキーワード SKIN を付加しなければなりません。
skinName : 文字列
このパラメータには、既存のドメインスキンの名前を指定します。
fileName : 文字列
このパラメータには、指定したドメインスキンを構成しているファイルのいずれかを 指定します。このファイルの内容が読み取られます。
STOREDOMAINSKINFILE [ domainName SKIN] skinName FILE fileName DATA fileContent
STOREDOMAINSKINFILE [ domainName SKIN] skinName FILE fileName DELETE
上記の最初のコマンドを使って、カスタムのドメインスキンにファイルを保存できます。2 番目 のコマンドでは、ドメインスキンのファイルを削除できます。
domainName : 文字列
オプションのパラメータで、ここにドメイン名を指定できます。指定しなかった場合、管理 者のドメインがデフォルトとして使われます。指定する場合、ドメイン名の右にキーワード SKIN を付加しなければなりません。
skinName : 文字列
このパラメータには、既存のドメインスキンの名前を指定します。
fileName : 文字列
このパラメータには、保存(または削除) するスキンファイルの名前を指定します。
fileContent : 文字列
このパラメータ(文字列) には、保存するファイルの内容(BASE64 エンコードデータ) を 指定します。このパラメータの前にキーワードDATA を付加しなければなりません。
このパラメータ(文字列) には、保存するファイルの内容(BASE64 エンコードデータ) を 指定します。このパラメータの前にキーワードDATA を付加しなければなりません。キーワードDATA を付加しておいた場合、指定したファイルと同じ名前のファイルがスキンに あったときには、そのファイルは削除されます。指定したファイルは、スキンキャッシュからも削除されます(ダイナミッククラスタ環境では、 各クラスタメンバーのスキンキャッシュからも削除されます)。

下記のコマンドは、システム管理者だけが使用できます。

LISTSERVERSKINS
このコマンドでは、カスタムのサーバースキン(サーバーワイドのスキン) のリストを取得で きます。出力データは、スキンの名前が格納された配列です。
CREATESERVERSKIN skinName
このコマンドを使って、カスタムのサーバースキンを作成できます。
skinName : 文字列
このパラメータには、作成するサーバースキンの名前を指定します。
RENAMESERVERSKIN skinName INTO newSkinName
このコマンドを使って、カスタムのサーバースキンの名前を変更できます。
skinName : 文字列
このパラメータには、名前を変更したいサーバースキンの名前を指定します。
newSkinName : 文字列
このパラメータには、サーバースキンの新規(変更後) の名前を指定します。
DELETESERVERSKIN skinName
このコマンドを使って、カスタムのサーバースキンを削除できます。
skinName : 文字列
このパラメータには、削除するサーバースキンの名前を指定します。
LISTSERVERSKINFILES skinName
このコマンドでは、カスタムのサーバースキンを構成しているファイルのリストを取得できま す。出力データは、各スキンファイルの名前が格納された辞書です。辞書のキーの値は、スキ ンファイルのディレクトリ(ファイル属性を含む) です。
skinName : 文字列
このパラメータには、既存のサーバースキンの名前を指定します。このサーバースキ ンを構成しているファイルのリストが取り出されます。
READSERVERSKINFILE skinName FILE fileName
このコマンドを使って、カスタムのサーバースキンを構成しているファイルを指定し、そのファ イルの内容を読み取ることができます。出力データは、配列です。配列の最初の要素は、ファ イルの内容(BASE64 エンコードデータ) です。配列の2 番目の要素は、ファイルの修正日を示 す文字列(ACAP 日付フォーマット) です。
skinName : 文字列
このパラメータには、既存のサーバースキンの名前を指定します。
fileName : 文字列
このパラメータには、サーバースキンを構成しているいずれかのファイルを指定しま す。このファイルに対して、処理が実行されます。
STORESERVERSKINFILE skinName FILE fileName DATA fileContent
STORESERVERSKINFILE skinName FILE fileName DELETE
上の最初のコマンドを使って、カスタムのサーバースキンに対してファイルを送信し、保存で きます。2 番目のコマンドでは、カスタムのサーバースキンのファイルを指定し、そのファイル を削除できます。
skinName : 文字列
このパラメータには、既存のサーバースキンの名前を指定します。
fileName : 文字列
このパラメータには、処理対象となるファイルの名前を指定します。
fileContent : 文字列
このパラメータ(文字列) には、ファイルの内容(BASE64 エンコードデータ) を指定しま す。このパラメータを指定する場合、その前にキーワードDATA を付加しなければなりま せん。
キーワードDATA を付加しておくと、サーバースキンのファイルの中に同じ名前のファイルが あった場合、そのファイルは削除されます。指定したファイルは、スキンキャッシュからも削除されます(ダイナミッククラスタ環境で は、各クラスタメンバーのスキンキャッシュからも削除されます)。
LISTCLUSTERSKINS
CREATECLUSTERSKIN skinName
RENAMECLUSTERSKIN skinName INTO newSkinName
DELETECLUSTERSKIN skinName
上記のコマンドはいずれも、ダイナミッククラスタ環境でのみ使用が可能です。
クラスタワイドのスキンの場合、[List|Create|Rename|Delete]ServerSkin(s) の各コマンドの代わり に上記のコマンドを使用します。
LISTCLUSTERSKINFILES skinName
READCLUSTERSKINFILE skinName FILE fileName
STORECLUSTERSKINFILE skinName FILE fileName DATA fileContent
STORECLUSTERSKINFILE skinName FILE fileName DELETE
上記のコマンドはいずれも、ダイナミッククラスタ環境でのみ使用が可能です。
クラスタワイドのスキンの場合、[List|Read|Store]ServerSkinFile(s) の各コマンドの代わりに上 記のコマンドを使用します。

WebUser インターフェイスとブラウザとの統合

CommuniGate Pro のWebUser インターフェイスは、サードパーティのアプリケーションと統合する ことができます。以下、この統合に関するCLI コマンドについて説明します。

CREATEWEBUSERSESSION accountName ADDRESS ip-address [ WML | IMode ] [ SKIN skinName ]
このコマンドを使って、アカウントを指定し、そのアカウントのWebUser セッションを作成で きます。出力データは文字列で、作成されたWebUser セッションのID が格納されています。こ の文字列を使ってURL を作成し、そのURL を介してクライアントブラウザ上でWebUser セッ ションに入ることができます。このURL のフォーマットは、次の通りです。
http://cgateproserver:port/Session/rrrrrrrrrrrr/Mailboxes.wssp
上で、rrrrrrrrrrrr は、コマンドで返ったセッションID (文字列) です。
accountName : 文字列
このパラメータには、アカウントの名前を指定します。
ip-address : 文字列
このパラメータには、クライアントブラウザのIP アドレスを指定します。指定したアカウ ントで「固定IP」(WebUser プレファレンス) が有効に設定されている場合、そのIP アドレ スを使ってWebUser セッションに対する接続が可能です。したがって、処理対象のアカウ ントについて「固定IP」オプションを有効にしておくことが必要です。
skinName : 文字列
このパラメータには、スキンを指定します。このスキンが、作成されたWebUser セッショ ンで使われます。
オプションのキーワードとしてWML またはIMode を使うことで、それぞれWML ブラウザまた はI-Mode ブラウザ上でログインをエミュレートできます。
このコマンドを使用する場合、[
Can Modify All Domains and Account Settings] 権限、または、 [CanAccessMailboxes] 権限(ドメイン管理アクセス権) が必要です。
FINDWEBUSERSESSION accountName [ ADDRESS ip-address ]
このコマンドでは、アカウントを指定し、そのアカウントによって実行されているWebUser セッションを検索できます。出力は、WebUser セッションID が格納された文字列です。
accountName : 文字列
このパラメータにはアカウント名を指定します。 
ip-address : 文字列
オプションのパラメータ。クライアントブラウザのセッションのIP アドレスを指定で きます。指定した場合、そのアカウントについて[WebUser Preference] 設定の [Fixed IP] オプションが無効に設定されているときには固定IP アドレス以外のセッ ションが、または、ログインIP アドレスが指定したIP アドレスと同じセッションが検 索されます。
このコマンドを使用する場合、ユーザーに[Can Modify All Domains and Account Settings]権 限または[CanCreateWebUserSessions]権限(ドメイン管理アクセス権) aが必要です。
GETWEBUSERSESSION sessionID [ DOMAIN domainName ]
このコマンドでは、WebUser セッションID を指定し、そのセッションデータを取り出すことが できます。出力データは辞書で、辞書にはセッションデータセットが格納されています。 (「WSSP」のセクションを参照)
sessionID : 文字列
このパラメータには、WebUser セッションのID を指定します。
domainName : 文字列
オプションのパラメータ。WebUser セッションが実行されているドメインの名前を指定で きます。
このコマンドでWebUser セッションデータを取り出す場合、[Can Modify All Domains and Account Settings] 権限が必要です。
このコマンドを実行すると、処理対象のWebUser セッションの無活動タイマー(Inactivity Timer) がリセットされます。
KILLWEBUSERSESSION sessionID [ DOMAIN domainName ]
このコマンドを使って、WebUser セッションを指定し、そのセッションを終了させることがで きます。
sessionID : 文字列
このパラメータには、WebUserセッションのID を指定します。このセッションが終了します。
domainName : 文字列
オプションのパラメータ。WebUser セッションが実行されているドメインの名前を指定で きます。
このコマンドをdomainNameを指定しないで実行する場合、[Can Modify All Domains and Account Settings] 権限が必要です。また、domainNameを指定して実行する場合、そのドメ インについて[CanCreateWebUserSessions] 権限(ドメイン管理アクセス権) が必要です。

リアルタイムアプリケーションの管理

以下のコマンドを使って、CommuniGate Pro のリアルタイムアプリケーション環境の管理が可能です。

ドメインリアルタイムアプリケーション環境を変更する場合、アカウント設定アクセス権 または [CanModifyPBXApps] 権限(ドメイン管理アクセス権) が必要です。

CREATEDOMAINPBX domainName [ FILE language ]
このコマンドでは、ドメインリアルタイムアプリケーション環境の作成が可能です。また、 言語を指定し、国際サブセット(特定の言語の環境) を作成することもできます。
domainName : 文字列
オプションのパラメータで、ドメイン名を指定できます。このドメインに対してコマ ンドが実行されます。ドメイン名を指定しなかったときには、コマンドは管理者のドメインに対して実行されます。
language : language
オプションのパラメータ。国際サブセット(特定の言語) の名前を指定します。
LISTDOMAINPBXFILES domainName [ FILE language ]
このコマンドを使って、ドメインリアルタイムアプリケーション環境のファイルのリストを 取り出せます。出力は、ファイル名をキーとする辞書です。辞書の要素の値は、ファイル属 性の辞書です。
domainName : 文字列
オプションのパラメータで、ドメイン名を指定できます。ドメイン名を指定しなかっ たときには、このコマンドは管理者のドメインに対して実行されます。
language : language
オプションのパラメータ。国際サブセット(特定の言語) の名前を指定します。
READDOMAINPBXFILE domainName FILE fileName
このコマンドを使って、ドメインリアルタイムアプリケーション環境からファイルを取り出 せます。このコマンドの出力は、ファイルの内容を格納したデータブロックです。
domainName : 文字列
ドメイン名を指定します。
fileName : 文字列
ファイル名を指定します。国際サブセット(特定の言語) のファイルを取り出したい 場合、[language/fileName (言語/ ファイル名)] の形式で指定します。
STOREDOMAINPBXFILE domainName FILE fileName DATA fileContent
STORESERVERSKINFILE fileName DELETE
最初のコマンドでは、サーバーワイドリアルタイムアプリケーション環境にファイルを格納 できます。また、2 番目のコマンドでは、サーバーワイドリアルタイムアプリケーション環 境のファイルを削除できます。
domainName : 文字列
このパラメータには、ドメイン名を指定します。
fileName : 文字列
このパラメータには、ファイル名を指定します。国際サブセットにファイルを格納し たい場合、[language/fileName (言語/ ファイル名)] の形式で指定します。
fileContent : 文字列
このパラメータを使用する場合、左側にキーワードDATA を指定します。パラメータ には、ファイルの内容を指定します。
このパラメータ(キーワードDATA 付き) を指定し、また、指定したファイルが環境に存在した場合、そのファイル(同じ名前の既存のファイル) は削除されます。    指定したファイルは、環境のキャッシュから削除されます(ダイナミッククラスタの場合、 全クラスタメンバーのキャッシュから削除されます)。

以下のコマンドはいずれも、システム管理者だけが実行できます。

CREATESERVERPBX [ language ]
このコマンドでは、サーバーワイドリアルタイムアプリケーション環境の作成が可能です。 また、言語を指定し、国際サブセット(特定の言語の環境) を作成することもできます。
language : language
オプションのパラメータ。国際サブセット(特定の言語) の名前を指定します。
LISTSERVERPBXFILES [ language ]
このコマンドを使って、サーバーワイドリアルタイムアプリケーション環境のファイルのリ ストを取り出せます。出力は、ファイル名をキーとする辞書です。辞書の要素(キー) の値 は、ファイル属性の辞書です。
language : 文字列
オプションのパラメータ。国際サブセット(特定の言語) の名前を指定します。
READSERVERPBXFILE fileName
このコマンドを使って、サーバーワイドリアルタイムアプリケーション環境からファイルを 取り出せます。このコマンドの出力は、ファイルの内容を格納したデータブロックです。
fileName : 文字列
ファイル名を指定します。国際サブセット(特定の言語) のファイルを取り出したい 場合、[language/fileName (言語/ ファイル名)] の形式で指定します。
STORESERVERPBXFILE fileName DATA fileContent
STORESERVERPBXFILE fileName DELETE
最初のコマンドでは、サーバーワイドリアルタイムアプリケーション環境にファイルを格納 できます。また、2 番目のコマンドでは、サーバーワイドリアルタイムアプリケーション環 境のファイルを削除できます。
fileName : 文字列
このパラメータには、ファイル名を指定します。国際サブセットにファイルを格納し たい場合、[language/fileName (言語/ ファイル名)] の形式で指定します。
fileContent : 文字列
このパラメータを使用する場合、左側にキーワードDATA を指定します。パラメータ には、ファイルの内容を指定します。
このパラメータ(キーワードDATA 付き) を指定し、また、指定したファイルが環境に存在 した場合、そのファイル(同じ名前の既存のファイル) は削除されます。   指定したファイルは、環境のキャッシュから削除されます(ダイナミッククラスタの場合、 全クラスタメンバーのキャッシュから削除されます)。
CREATECLUSTERPBX [ language ]
LISTCLUSTERPBXFILES [ language ]
READCLUSTERPBXFILE fileName
STORECLUSTERPBXFILE fileName DATA fileContent
STORECLUSTERPBXFILE fileName DELETE
上記の各コマンド(5 つ) は、ダイナミッククラスタでのみ使用が可能です。
上記の各コマンドはいずれもクラスタワイドリアルタイムアプリケーション環境用のコマン ドです。一方、前出の[List|Read|Store]ServerPBXFile[s] コマンドは、サーバーワイ ドリアルタイムアプリケーション環境用です。

リアルタイムアプリケーションの制御

以下の各コマンドを使って、CommuniGate Pro のリアルタイムアプリケーションのタスクの制御が可 能です。

STARTPBXTASK accountName PROGRAM programName [ ENTRY entryName ] [ PARAM parameter ]
このコマンドでは、新規のPBX タスク(プログラム) の起動が可能です。出力は、タスク ID を格納した文字列です。
accountName : 文字列
アカウントの名前を指定します。このアカウントの名前で新規のタスクが開始されま す。
アカウントの名前にはドメイン名を付加できます。ドメイン名を付加しなかった場合、 ユーザーのカレントのドメインがデフォルトのドメインとして使用されます。
programName : 文字列
このパラメータには、プログラム(.sppr ファイル)の名前を指定します。このプログ ラムが起動されます。
entryName : 文字列
オプションのパラメータで、プログラムのエントリポイントを指定できます。このパ ラメータを指定しなかったときには、エントリポイントとしてmain が使用されます。
parameter : object
オプションのパラメータで、プログラムパラメータを指定できます。プログラムパラ メータは、プログラムコードで次のコードを使って取り出せます。
Vars().startParameter
SENDTASKEVENT taskID EVENT eventName [ PARAM parameter ]
このコマンドでは、既存のPBX タスクにイベントを送信できます。
taskID : 文字列
このパラメータには、タスクID を指定します。このタスクにイベントが送られます。
eventName : 文字列
送信するイベントの名前を指定します。
parameter : object
オプションのパラメータで、イベントのパラメータを指定できます。
KILLNODE taskID
このコマンドでは、既存のPBX タスクの終了が可能です。
taskID : 文字列
このパラメータにはタスクID を指定します。このタスクが終了されます。

サーバー設定

以下、サーバー設定に関するCLI コマンドについて説明します。いずれも、実行するにはサーバー設定アクセス権 が必要です。

GETMODULE moduleName
このコマンドを使って、モジュールの設定を取得できます。出力データは、モジュールの設定 が格納された辞書です。
moduleName : 文字列
このパラメータには、CommuniGate Pro サーバーのモジュールの名前を指定します。このモ ジュールの設定が取り出されます。
SETMODULE moduleName newSettings
このコマンドを使って、モジュールの設定を変更(置換) できます。
moduleName : 文字列
このパラメータには、CommuniGate Pro サーバーのモジュールの名前を指定します。このモ ジュールの設定が変更されます。
newSettings : 辞書
このパラメータには、モジュール設定辞書を指定します。既存の辞書は、この辞書に置き換 えられます。
UPDATEMODULE moduleName newSettings
このコマンドを使って、モジュールの設定を更新できます。
moduleName : 文字列
このパラメータには、CommuniGate Pro サーバーのモジュールの名前を指定します。このモ ジュールの更新が変更されます。
newSettings : 辞書
このパラメータには、新規のモジュール設定辞書を指定します。辞書には設定データ をすべて定義する必要はありません。いずれかの設定データを定義しなかった場合、 既存の辞書の設定データがそのまま残ります。
GETLANIPS
このコマンドを使って、LAN のIP アドレスを取り出すことができます。出力データは文字列 (複数行) で、文字列には、LAN のIP アドレス、IP アドレス範囲が格納されています。
GETBLACKLISTEDIPS
このコマンドを使って、ブラックリストに登録されているIP アドレスを取り出すことができま す。出力データは文字列(複数行) で、ブラックリストに登録されているIP アドレス、IP アド レス範囲が格納されています。
GETCLIENTIPS
このコマンドを使って、ブラックリストに登録されているクライアントIP を取り出すことがで きます。出力データは文字列(複数行) で、ブラックリストに登録されているクライアントIP アドレス、クライアントIP アドレス範囲が格納されています。
GETWHITEHOLEIPS
このコマンドを使って、ホワイトホールIP アドレス(ブラックリストから除外されたIP アドレ ス) を取り出すことができます。出力データは文字列(複数行) で、ホワイトホールIP アドレ ス、ホワイトホールIP アドレス範囲が格納されています。
GETPROTECTION
このコマンドを使って、保護に関する設定を取り出すことができます。出力データは辞書で、辞 書にはサーバーの保護に関する設定が格納されています。
GETBANNED
このコマンドを使って、ヘッダ/ 本文によるメールの拒否(Banned Header/Body Lines) に関す る設定を取り出すことができます。出力データは辞書で、ヘッダ/ 本文によるメールの拒否に 関する設定が格納されています。
SETLANIPS newAddresses
このコマンドを使って、LAN のIP アドレスを設定(置換) できます。
newAddresses : 文字列
このパラメータ(複数行文字列) には、変更後のアドレス(またはアドレス範囲) を指定しま す。既存のIP アドレスまたはIP アドレス範囲はすべて、このアドレスまたはアドレス範囲(の セット) に置き換えられます。このコマンドを使って、ブラックリストに登録されているIP ア ドレスを変更できます。
SETBLACKLISTEDIPS newAddresses
Use this command to update the set of Blacklisted IP Addresses.
newAddresses : 文字列
このパラメータ(複数行文字列) には、変更後のブラックリストのIP アドレス(またはア ドレス範囲) を指定します。既存のブラックリストのIP アドレスまたはIP アドレス範囲は すべて、このアドレスまたはアドレス範囲(のセット) に置き換えられます。
SETCLIENTIPS newAddresses
このコマンドを使って、既存のクライアントIP アドレスを変更できます。
newAddresses : 文字列
このパラメータ(複数行文字列) には、変更後のクライアントIP アドレスを指定します。 既存のクライアントIP アドレスはすべて、このクライアントIP アドレス(のセット) に置 き換えられます。
SETWHITEHOLEIPS newAddresses
このコマンドを使って、既存のホワイトホールIP アドレス(ブラックリストから除外されたIP アドレス) を変更できます。
newAddresses : 文字列
このパラメータ(複数行文字列) には、変更後のホワイトホールIP アドレスを指定します。 既存のホワイトホールIP アドレスはすべて、このホワイトホールIP アドレス(のセット) に置き換えられます。
SETPROTECTION newSettings
このコマンドを使って、サーバー保護設定を変更できます。
newSettings : 辞書
このパラメータには、変更後のサーバー保護設定を指定します。
SETBANNED newSettings
このコマンドを使って、サーバーワイドのヘッダ/ 本文によるメールの拒否(Banned Header/ Body Lines) に関する設定を変更できます。
newSettings : 辞書
このパラメータには、新規のヘッダ/ 本文によるメールの拒否に関する設定を指定し ます。既存の設定は、この設定に置き換えられます。
GETCLUSTERLANIPS
GETCLUSTERBLACKLISTEDIPS
GETCLUSTERCLIENTIPS
GETCLUSTERWHITEHOLEIPS
GETCLUSTERPROTECTION
GETCLUSTERBANNED
SETCLUSTERLANIPS newAddresses
SETCLUSTERBLACKLISTEDIPS newAddresses
SETCLUSTERCLIENTIPS newAddresses
SETCLUSTERWHITEHOLEIPS newAddresses
SETCLUSTERPROTECTION newSettings
前述のGetLANIPs からSetBanned までのコマンドはいずれもサーバーワイドの設定に関する コマンドですが、クラスタワイドの場合、上記の11 のコマンドを使用することで同様の処理が 可能です。
GETSERVERMAILRULES
このコマンドを使って、サーバーワイドの自動メール処理ルールを取得できます。出力データ は、サーバーワイドの自動処理ルールが格納された配列です。
SETSERVERMAILRULES newRules
このコマンドを使って、サーバーワイドの自動メール処理ルールを変更できます。
newRules : 配列
このパラメータ(配列) には、新規(変更後) のサーバーワイドの自動メール処理ルールを 指定します。
GETSERVERSIGNALRULES
Use this command to read the Server-Wide Automated Signal Processing Rules. The command produces an output - an array of the Server Signal Rules.
SETSERVERSIGNALRULES newRules
Use this command to set the Server-Wide Automated Signal Processing Rules.
newRules : 配列
An array of new Server Signal Rules.
GETCLUSTERMAILRULES
SETCLUSTERMAILRULES newRules
GETCLUSTERSIGNALRULES
SETCLUSTERSIGNALRULES newRules
このコマンドを使って、クラスタワイドの自動メール処理ルールを取得できます。出力データ は、クラスタワイドの自動処理ルールが格納された配列です。
GETROUTERTABLE
このコマンドを使って、ルータテーブル(Router Table) を取得できます。出力データは複数 行文字列で、ルータテーブルのテキストが格納されています。
SETROUTERTABLE newTable
このコマンドを使って、ルータテーブルを変更できます。
newTable : 文字列
このパラメータ(複数行文字列) には、新規(変更後) のルータテーブルのテキストを指定 します。
GETROUTERSETTINGS
このコマンドを使って、ルータの設定を取得できます。出力データは辞書で、辞書にはルータ の設定が格納されています。
SETROUTERSETTINGS newSettings
このコマンドを使って、ルータの設定を変更できます。
newSettings : 辞書
このパラメータ(辞書) には、新規(変更後) のルータの設定を指定します。
GETCLUSTERROUTERTABLE
SetClusterRouterTable newTable
GetClusterRouterSettings
SetClusterRouterSettings newSettings
上の2 つのコマンドはどちらもクラスタワイドのルータテーブル用のコマンドで、機能はそれ ぞれサーバーワイドのルータテーブル用のコマンドであるGetRouterTable(ルータテーブルの取 得)、SetRouterTable (ルータテーブルの変更) と同じです。
GETSERVERINTERCEPT
このコマンドを使って、合法傍受に関する設定を取得できます。出力データは辞書で、合法傍 受に関する設定が格納されています。
SETSERVERINTERCEPT newSettings
このコマンドを使って、合法傍受に関する設定を変更できます。
newSettings : 辞書
このパラメータ(辞書) には、新規(変更後) の合法傍受に関する設定を指定します。
GETCLUSTERINTERCEPT
SETCLUSTERINTERCEPT newSettings
上の2 つのコマンドはどちらもクラスタワイドの合法傍受用のコマンドで、機能はそれぞれ サーバーワイドの合法傍受用のコマンドであるGetRouterTable (取得)、SetRouterTable (変 更) と同じです。
REFRESHOSDATA
このコマンドを使って、サーバーOS のIP データの再読み取りが可能です。サーバーOS のIP データは、ローカルIP アドレス(複数のアドレスのセット) とDNS アドレス(複数のアドレス のセット) で構成されています。

以下のCLI コマンドを使う場合、サーバー設定アクセス権 または アカウント設定アクセス権 が必要 です。

ROUTE address [ mail | access | signal ]
このコマンドでは、アドレスを指定し、そのアドレスのルーティングに関する設定を取得でき ます。
address : 文字列
このパラメータには、CommuniGate Pro のルータによって処理される電子メールアドレスを 指定します。この電子メールアドレスのルーティングに関する設定が取り出されます。
mail or access or signal
オプションのフラグで、ルーティングタイプを示します(詳しくは、「ルータ」のセクショ ンを参照してください)。デフォルトは、access です。
このコマンドの出力は配列で、配列には次の3 つの文字列が格納されます。
module
指定した電子メールアドレスのルート先のモジュールの名前。電子メールアドレスが内蔵デ スティネーション(例えば、NULL) にルーティングされるときには、値としてSYSTEM が 格納されます。
host
module で示されるモジュールによって処理されるオブジェクトまたはキューの名前。例え ば、SMTP モジュールのインターネットドメイン名、Local Delivery モジュールのローカルア カウント名など。
address
キューに格納されているアドレス(SMTP モジュールの場合は電子メールアドレス、 Local Delivery モジュールの場合はTo: (宛先) アドレスなど)。

モニタリング(監視)

以下、サーバーのモニタリングに関するCLI コマンドについて説明します。使用する場合、いずれ もモニタリングに関するアクセス権 が必要です。

GETSNMPELEMENT ObjectID
このコマンドを使って、サーバー状態(SNMP) 要素のカレントの値を取得できます。
ObjectID : 文字列
このパラメータには、サーバー状態要素のオブジェクトID を指定します(詳しくは、SNMP」 のセクションを参照してください)。
Tこのコマンドの出力データは文字列で、文字列にはサーバー状態要素の値が格納されています。
SHUTDOWN
このコマンドを使って、CommuniGate Pro サーバーを終了できます。

アクセス権の管理

以下、アクセス権(権限) の管理・操作に関するCLI コマンドについて説明します。使用する場合、 いずれも、無制限アクセス権 が必要です。

SETACCOUNTRIGHTS accountName newRights
このコマンドでは、アカウントを指定し、そのアカウントのサーバーアクセス権を設定できま す。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。このアカウントのサーバーアク セス権を設定できます。アカウントの名前にはドメイン名を付加することもできます。
newRights : 配列
このパラメータ(配列) には、設定するアクセス権のコードを指定します。既存のアクセス 権は削除されます。
セカンダリドメインのアカウント(ユーザー) に対してアクセス権(つまりドメイン管理権限) を設 定する場合、[All Account and Domains] 権限(全アカウント・全ドメインに対するアクセス権) が必 要です。

統計

以下、アカウントの統計データに関するCLI コマンドについて説明します。なお、アカウントの統計 データを取得する場合、[Account Statistics] オプションが有効に設定されていなければなりません。 このオプションは、WebUser インターフェイスの[Settings]セクションの[Obscure]ページにあります。

GETACCOUNTSTAT accountName [ KEY keyName ]
このコマンドでは、アカウントを指定し、そのアカウントの統計データを取得できます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
keyName : 文字列
このオプションのパラメータには、取り出したい統計データのエントリの名前を指定できま す。
このコマンドの出力データは文字列で、文字列には指定した統計データが格納されます。また は、オプションのパラメータ(キーワードKEY とパラメータkeyName) を指定した場合には、 取得可能な統計データが格納された辞書が出力されます。
keyNameで指定したキー(エントリ) がなかった場合、空白の文字列が返ります。
このコマンドを使用する場合、指定したアカウントのドメインについてドメイン管理権限が付 与されていなければなりません。なお、各ユーザーはいずれも、このコマンドを使って自分の アカウントの統計データを取得できます。
RESETACCOUNTSTAT accountName [ KEY keyName ]
このコマンドでは、アカウントを指定し、そのアカウントの統計データをリセットできます。
accountName : 文字列
このパラメータには、既存のアカウントの名前を指定します。アステリスク(*) を指定す ることもできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンド の実行時に認証されたアカウント) と解釈されます。
keyName : 文字列
このオプションのパラメータには、リセットしたい統計データのエントリの名前を指定でき ます。
キーワードKEY とパラメータkeyNameを指定しなかったときには、指定したアカウントの統計 データの全エントリがリセットされます。
このコマンドを使う場合、アカウントのドメインについて[Basic Settings] 権限( ドメイン管理 権限) が必要です。

このコマンドでは、次の統計データのキー(エントリ) のリセットが可能です。
Key Name  Value
StatReset The date & time when the last parameterless RESETACCOUNTSTAT command was sent to this Account
MessagesReceived The total number of messages delivered to the Account
BytesReceived The total size of all messages delivered to the Account

GETDOMAINSTAT domainName [ KEY keyName ]
このコマンドでは、ドメインを指定し、そのドメインの統計データを取得できます。
domainName : 文字列
このパラメータには、既存のドメインの名前を指定します。アステリスク(*) を指定する こともできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンドの 実行時に認証されたアカウント) のドメインと解釈されます。
keyName : 文字列
このパラメータには、取り出したい統計データのエントリの名前を指定します。
出力データは、指定した統計データが格納された文字列です。または、オプションのパラメー タ(キーワードKEY とパラメータkeyName) を指定した場合には、取得可能な統計データが格 納された辞書が出力されます。
このコマンドを使う場合、指定したドメインについてドメイン管理権限が必要です。
RESETDOMAINSTAT domainName [ KEY keyName ]
このコマンドでは、ドメインを指定し、そのドメインの統計データをリセットできます。
domainName : 文字列
このパラメータには、既存のドメインの名前を指定します。アステリスク(*) を指定する こともできます。その場合、アステリスクは、カレントの認証済みアカウント( コマンドの 実行時に認証されたアカウント) のドメインと解釈されます。
keyName : 文字列
このパラメータには、リセットしたい統計データのエントリの名前を指定します。
キーワードKEY とパラメータkeyName を指定しなかったときには、すべてのドメインの統計 データの全エントリがリセットされます。
このコマンドを使う場合、指定したドメインについて[Basic Settings] 権限( ドメイン管理権 限) が必要です。

このコマンドでは、次の統計データのキー(エントリ) のリセットが可能です。
Key Name  Value
StatReset The date & time when the last parameterless RESETDOMAINSTAT command was sent to this Domains
MessagesReceived The total number of messages delivered to the Domain
BytesReceived The total size of all messages delivered to the Domain


その他のコマンド

WRITELOG logLevel logRecord
このコマンドでは、レコードをサーバーログに格納できます。
logLevel : number
このパラメータには、レコードのログレベルを指定します。
logRecord : 文字列
このパラメータには文字列を指定します。この文字列がサーバーログに格納されま
このコマンドによって生成されたログレコードには接頭辞SYSTEM が付加されます。
このコマンドを使用する場合、[Can Monitor]権限(サーバー管理アクセス権)が必要です。
RELEASESMTPQUEUE queueName
このコマンドを使って、SMTP キューの解放が可能です。
queueName : 文字列
このパラメータには、キュー(ドメイン)の名前を指定します。このキューが解放さ れます。
ダイナミッククラスタ環境の場合、全サーバーのSMTP キュー(指定したSMTP キュー) が解放されます。
このコマンドを使用する場合、[Can Monitor]権限(サーバー管理アクセス権)が必要
REJECTQUEUEMESSAGE messageID [errorText]
このコマンドを使用して、サーバーキューによるメッセージの処理を拒否できます。
messageID : number
このパラメータには、メッセージID を指定します。
errorText : 文字列
オプションのパラメータで、文字列を指定できます。この文字列がエラー(バウンス) レポートに挿入され、そのエラーレポートがメッセージの差出人に送信されます。
このコマンドを使用する場合、[Can Reject Queues]権限(サーバー管理アクセス権)が必 要です。
GETCURRENTCONTROLLER
このコマンドを使って、カレントのダイナミッククラスタコントローラのIP アドレスを取得 できます。
このコマンドの出力は、ダイナミッククラスタコントローラのIP アドレスを格納した文字列 です。
このコマンドを使用する場合、ユーザーに[Can Monitor]権限(サーバー管理アクセス権) が付与されていることが必要です。
GETTEMPCLIENTIPS
このコマンドを使って、暫定クライアントIP アドレスのリストを取得できます。出力は文字 列で、この文字列には暫定クライアントIP アドレスがコンマ(,) で区切られて格納されて います。
このコマンドを使用する場合、ユーザーに[Can Monitor]権限(サーバー管理アクセス権) が付与されていることが必要です。
GETTEMPBLACKLISTEDIPS
このコマンドを使って、暫定ブラックリストIP アドレス(Blacklisted IP Address) のリスト を取得できます。出力は文字列で、この文字列には暫定ブラックリストIP アドレスがコンマ (,) で区切られて格納されています。
このコマンドを使用する場合、ユーザーに[Can Monitor]権限(サーバー管理アクセス権)が付与されていることが必要です。
SETTEMPBLACKLISTEDIPS addresses
Use this command to add addresses to the Temporary Blacklisted IP Addresses list.
addresses : number
このパラメータには、IP アドレスのリストを指定します。ここで指定したIP アドレスを暫 定ブラックリストIP アドレスとして設定(保存) できます。指定の形式は、上記の GetTempBlacklistedIPs コマンドの出力の形式(コンマ区切り)と同じです。
このコマンドを使用する場合、ユーザーに[Server Settings (サーバー設定)] 権限(サーバー管理ア クセス権) が付与されていることが必要です。
REMOVEACCOUNTSUBSET accountName SUBSET subsetName
このコマンドを使用して、アカウントのデータセット(RepliedAddresses データセットなど) を削除できます。
accountName : 文字列
このパラメータには既存のアカウントの名前を指定します。アステリスク(*) を指定 すると、カレントの正規アカウントとして解釈されます。
subsetName : 文字列
このパラメータには、指定したアカウントの既存のデータセットの名前を指定します。 このデータセットが削除されます。
ユーザーが他のユーザーのデータセットを削除する場合、ドメイン管理者アクセス権が必要です。

CommuniGate® Pro Guide. Copyright © 1998-2007, Stalker Software, Inc.