cgpapi

package module
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 31, 2026 License: MIT Imports: 15 Imported by: 0

README

go-cgp-api

A Go client for the CommuniGate Pro PWD/CLI protocol: the TCP session used to authenticate against a CommuniGate Pro server and then issue CLI administration commands, as documented at CLI.html (command grammar and semantics). The PWD login layer itself is not covered by that document and is implemented here from empirical observation of a live server.

import cgpapi "github.com/gmyzovsky/go-cgp-api"

Data-bearing command arguments and responses use go-cgp-data, the sibling package implementing CommuniGate Pro's Data Format.

This is a from-scratch Go design, not a port of any particular prior client's interface - see Design notes below for what that means concretely.

Connecting

Dial opens a connection, authenticates, and returns a ready-to-use *Client:

c, err := cgpapi.Dial(ctx, cgpapi.Options{
    Addr:     "cgpro.example.com:1106",
    Login:    "admin@example.com",
    Password: "hunter2",
    TLS:      cgpapi.ImplicitTLS,
})
if err != nil {
    log.Fatal(err)
}
defer c.Close(ctx)

Options.SecureLogin selects the authentication method (PlainLogin, APOPLogin, CRAMMD5Login); left at its zero value (AutoSecureLogin), it picks APOP over an unencrypted transport or PLAIN once TLS is already established. Options.TLS selects NoTLS (default), ImplicitTLS (TLS from the first byte, e.g. on port 1106), or StartTLS (plaintext connect, then the STLS command upgrades the connection before authenticating).

[!WARNING] Options.TLS defaults to NoTLS, which is not a safe default. It is the zero value only for backwards compatibility. This is an administrative session: without TLS every command and every response crosses the network in clear text, and the server is never authenticated, so anyone on the path can read the traffic, alter commands, or impersonate the server.

The login exchange is the one part that is not necessarily clear text, and it does not make up for the rest. Under the default AutoSecureLogin the password is not put on the wire at all over an unencrypted transport: APOP is used, so what crosses is the challenge and an MD5 digest over it - captured just as easily, and attackable offline to recover the password. CRAMMD5Login is challenge-response in the same way. PlainLogin does send the password itself in clear text, so never pair it with NoTLS. Set ImplicitTLS or StartTLS on anything but a loopback connection.

Certificate verification is enabled by default and should stay that way. If the handshake fails, put the issuing CA in Options.TLSConfig.RootCAs, or set a ServerName the certificate actually covers - do not reach for InsecureSkipVerify. Connecting to a bare IP address works with verification on, matched against the certificate's IP SANs.

A connection dropped unexpectedly is transparently reopened and re-authenticated on the next call, using the same Options, unless Client.Close was called explicitly - after Close, every method returns ErrClosed instead of reconnecting.

A Client is not safe for concurrent use by multiple goroutines: the protocol is a single stateful request/response session over one TCP connection. Use a separate Client per goroutine, or synchronize access to a shared Client externally.

Sending commands

Client.Send runs any already-formatted CLI command line and returns its decoded response, if the command produced one:

v, err := c.Send(ctx, "GETVERSION")
// v is a cgpdata.Value (here, a cgpdata.String) on a data-bearing
// response, nil on a plain success with no data, and err is non-nil
// (typically a *cgpapi.ResponseError) on failure.

Build data-bearing tokens with cgpdata.Marshal:

name, err := cgpdata.Marshal(cgpdata.String("alice@example.com"))
if err != nil {
    log.Fatal(err)
}
v, err := c.Send(ctx, "SetAccountType "+string(name)+" MultiMailbox")

Send already covers every CLI command, documented or not - it is a deliberately dumb pipe, since the command grammar mixes bare keywords, data tokens, arrays, and dictionaries differently per command (see CLI.html). Typed wrapper methods build on top of Send and cover every command in every CLI.html category - see Coverage below.

Untrusted input

Everything encoded through cgpdata.Marshal (and every data-bearing field of a typed Input) is escaped, so it cannot disturb the command line no matter what it contains. Two things are checked rather than escaped:

  • One call sends one line. A command line containing CR, LF, or NUL is refused before anything is written - by Send and by every typed wrapper alike. Otherwise the server would read whatever follows the line break as a second command, authorized independently with the session's full administrative rights.
  • Bare-keyword fields take one word. A few commands take an unquoted enumeration value rather than a data token (BlockAccount's Mode, CreateAccount's AccountType, Route's Type, ...). Those fields reject a value with a space or a control character in it, so untrusted input cannot append arguments to the command.

Typed wrapper methods

Where a typed wrapper exists, it follows one consistent shape across every command: an Input/Output struct pair per method.

out, err := c.CreateAccount(ctx, &cgpapi.CreateAccountInput{
    AccountName: "alice@example.com",
    AccountType: "MultiMailbox",
    Settings: cgpdata.Dictionary{
        {Key: "RealName", Value: cgpdata.String("Alice Doe")},
    },
})

out, err := c.GetAccountSettings(ctx, &cgpapi.GetAccountSettingsInput{
    AccountName: "alice@example.com",
})
realName, _ := out.Settings.Get("RealName")

Coverage

Full parity with CLI.html: every one of its ~411 documented commands has a typed wrapper method (436 exported *Client methods total, since a few commands - e.g. STOREDOMAINSKINFILE's data/DELETE forms, UPDATEACCOUNTMAILRULE's update/delete forms - are split into two Go methods for a cleaner signature). Plus connect/authenticate (PLAIN, APOP, CRAM-MD5), Send, and ChangePassword.

One file per CLI.html category (see Architecture in CLAUDE.md for the exact command list per file): account.go (Account Administration), domain.go + domainset.go (Domain / Domain Set Administration), group.go (Group Administration), forwarder.go (Forwarder Administration), namedtask.go (Named Task Administration), mailbox.go (Mailbox Administration), alert.go + freebusy.go (Alert Administration, Free/Busy), plugin.go (Plugin Administration), storage.go (Account File Storage), mailinglist.go (Mailing Lists Administration), skin.go (Web Skins Administration), websession.go (Web Interface Integration), pbx.go (Real-Time Application Administration/ Control), fts.go + runscript.go (Full-Text Search, Synchronous Scripts), accountservices.go (Account Services), serversettings_core.go

  • serversettings_ips.go (Server Settings), monitoring.go (Monitoring), stats.go (Statistics), directoryadmin.go (Directory Administration), server.go (Miscellaneous Commands, plus GetVersion).

A handful of commands exist in CLI.html but have no corresponding CGP::API Perl sub (newer server additions - Plugin Administration, Full-Text Search, RUNSCRIPT); those were implemented from CLI.html alone, noted in each file's header comment. Conversely, several CGP::API subs are legacy aliases with no CLI.html heading of their own (e.g. GetAccount → GetAccountSettings, GetWebUser → GetAccountPrefs) and were deliberately not ported.

Client.Send remains available for anything not covered by a typed wrapper, or for building a command line by hand.

Design notes

  • Every method returns (T, error). Protocol failures surface as *cgpapi.ResponseError (Code, Message, Command), checkable via errors.As. Command is always just the command's first word, even for commands that carry a credential as an argument (PASS, SetAccountPassword, ...) - so an error never echoes a secret.
  • context.Context is threaded through every network-touching method, in place of a fixed connect/read timeout option.
  • No config equivalent to a UTF8 toggle is needed: Go strings are UTF-8 byte sequences natively.
  • Options.TLSConfig's ServerName (SNI) is derived from Options.Addr's host part for both ImplicitTLS and StartTLS, but only when that host is an actual hostname, not an IP literal - SNI is only valid for hostnames per RFC 6066.

Testing

go test ./...

Tests run against a minimal in-process fake PWD/CLI server (fakeserver_test.go) rather than a live CommuniGate Pro instance.

Documentation

Overview

Package cgpapi implements a client for the CommuniGate Pro PWD/CLI protocol: the TCP session used to authenticate against a CommuniGate Pro server and then issue CLI administration commands, documented at https://doc.communigatepro.ru/development/CLI.html (command grammar and semantics). The PWD login layer itself is not covered by that document and is implemented here from empirical observation of a live server.

Connecting

Dial opens a connection, authenticates using PLAIN (USER/PASS), APOP, or CRAM-MD5, and returns a ready-to-use Client: 

c, err := cgpapi.Dial(ctx, cgpapi.Options{
	Addr:     "cgpro.example.com:1106",
	Login:    "admin@example.com",
	Password: "hunter2",
	TLS:      cgpapi.ImplicitTLS,
})

A connection dropped unexpectedly is transparently reopened and re-authenticated on the next call, using the same Options, unless Client.Close was called explicitly - after Close, every method returns ErrClosed instead of reconnecting.

A Client is not safe for concurrent use by multiple goroutines: the protocol is a single stateful request/response session over one TCP connection. Use a separate Client per goroutine, or synchronize access to a shared Client externally.

Transport security

Options.TLS defaults to NoTLS, which is the zero value for backwards compatibility and not a safe choice on a real network: the session is an administrative one, and without TLS its commands and responses all cross the network in clear text, with no authentication of the server.

The login exchange is the exception, and not a saving one. Under the default AutoSecureLogin the password itself is never sent over an unencrypted transport - APOP is, so the challenge and an MD5 digest over it cross in the clear and can be attacked offline to recover the password. CRAMMD5Login is challenge-response in the same way. PlainLogin does send the password in clear text, so it must not be combined with NoTLS.

Set ImplicitTLS (conventionally port 1106) or StartTLS for anything but a loopback connection.

Certificate verification is on by default and should stay on. If a handshake fails, supply the issuing CA in Options.TLSConfig's RootCAs, or a ServerName the certificate actually covers, rather than setting InsecureSkipVerify - which disables exactly the protection TLS is there to provide. Connecting to an IP address is supported with verification enabled, against the certificate's IP SANs.

Command lines and untrusted input

Data-bearing arguments - names, settings, file bodies - are encoded as Data Format tokens, which escape anything that could disturb the command line. A few commands additionally take a bare CLI keyword (BLOCKACCOUNT's mode, CREATEACCOUNT's account type, ...); those fields accept one unquoted word only, and a value with a space or a control character in it is rejected before anything is sent. Any command line, from a typed wrapper or from Client.Send, that contains CR, LF, or NUL is likewise refused, so untrusted input can never turn one command into two.

Sending commands

Client.Send runs any already-formatted CLI command line - built using github.com/gmyzovsky/go-cgp-data to encode any data-bearing token the command's own grammar requires - and returns its decoded response value, if the command produced one. Send already covers every CLI command, documented or not. Typed wrapper methods build on top of Send and cover every command in every CLI.html category (e.g. Client.CreateAccount); Send remains available for anything a future CLI.html revision adds before a typed wrapper follows.

Index

Examples

Constants

View Source 
const DefaultMaxResponseLine = 64 << 20 // 64 MiB

DefaultMaxResponseLine is the response-line size limit a Client uses when Options.MaxResponseLine is zero.

A response line carries the whole value of a data-bearing (201) response, and READSTORAGEFILE-style commands return a file body Base64-encoded inside it, so the limit has to be generous; it exists to bound what a hostile or malfunctioning peer can make the client allocate, not to constrain normal traffic.

Variables

View Source 
var ErrClosed = errors.New("cgpapi: client is closed")

ErrClosed is returned by every Client method called after Close, instead of the transparent auto-reconnect that would otherwise happen on a dropped connection.

View Source 
var ErrResponseTooLarge = errors.New("cgpapi: response line exceeds the configured limit")

ErrResponseTooLarge is returned when the server sends a response line longer than the Client's Options.MaxResponseLine limit. The connection is closed when this happens: the unread remainder of the oversized line cannot be resynchronized with.

Functions

This section is empty.

Types

type BalanceInput added in v0.3.0 

type BalanceInput struct {
	AccountName string             // required; "*" names the current authenticated Account
	Parameters  cgpdata.Dictionary // required
}

BalanceInput manages an Account's Billing Balance. Parameters must contain an `op` string element naming the operation to apply: `list`, `reserve`, `release`, `charge`, `credit`, `read`, `readAll`, `history`, or `remove`. Every other Parameters element is operation-specific; see the Billing section at https://doc.communigatepro.ru/admin/misc/Billing.html and https://doc.communigatepro.ru/development/CLI.html#BALANCE for the full per-operation reference.

type BalanceOutput added in v0.3.0 

type BalanceOutput struct {
	Result cgpdata.Dictionary
}

BalanceOutput holds the result of Balance: the operation results, shaped differently per Input.Parameters["op"] (see BalanceInput).

type BlessSessionInput added in v0.3.0 

type BlessSessionInput struct {
	SessionID   string // required
	Secret      string // optional; the Two-factor Authentication one-time secret
	AccountName string // optional; mutually exclusive with DomainName; "*" names the current authenticated Account
	DomainName  string // optional; mutually exclusive with AccountName
}

BlessSessionInput completes the second stage of a Two-factor Authentication process for a Session (CLI.html documents this command under two syntax forms sharing sessionID and an optional PASSWORD secret clause; AccountName corresponds to the first form's "AUTH accountName" clause and DomainName to the second form's "DOMAIN domainName" clause - set at most one of the two).

type BlessSessionOutput added in v0.3.0 

type BlessSessionOutput struct{}

BlessSessionOutput holds the result of BlessSession.

type BlockAccountInput added in v0.3.0 

type BlockAccountInput struct {
	AccountName        string // required
	Mode               string // required bare keyword: "Full" or "Part"
	PreventLogin       bool   // optional; Part mode only
	PreventDel         bool   // optional; Part mode only
	PreventShowFolders bool   // optional; Part mode only - for Part blocking, at least one Prevent* flag must be set
}

BlockAccountInput blocks an Account, fully or partially.

type BlockAccountOutput added in v0.3.0 

type BlockAccountOutput struct{}

BlockAccountOutput holds the result of BlockAccount.

type BuildAccountSearchIndexInput added in v0.3.0 

type BuildAccountSearchIndexInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

BuildAccountSearchIndexInput builds (or, if one already exists, completely rebuilds) the Search Index of a single account.

type BuildAccountSearchIndexOutput added in v0.3.0 

type BuildAccountSearchIndexOutput struct{}

BuildAccountSearchIndexOutput holds the result of BuildAccountSearchIndex.

type BuildDomainSearchIndexInput added in v0.3.0 

type BuildDomainSearchIndexInput struct {
	DomainName   string // required
	EnableForAll bool   // optional: also enables Search Index for every domain user that has not explicitly disabled it
}

BuildDomainSearchIndexInput builds the Search Index for every user in a domain.

type BuildDomainSearchIndexOutput added in v0.3.0 

type BuildDomainSearchIndexOutput struct{}

BuildDomainSearchIndexOutput holds the result of BuildDomainSearchIndex.

type BuildGroupSearchIndexInput added in v0.3.0 

type BuildGroupSearchIndexInput struct {
	DomainName   string // required
	GroupName    string // required
	EnableForAll bool   // optional: also enables Search Index for every group member that has not explicitly disabled it
}

BuildGroupSearchIndexInput builds the Search Index for every user in a group.

type BuildGroupSearchIndexOutput added in v0.3.0 

type BuildGroupSearchIndexOutput struct{}

BuildGroupSearchIndexOutput holds the result of BuildGroupSearchIndex.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client is a connection to a CommuniGate Pro PWD/CLI server. Create one with Dial.

A Client is not safe for concurrent use by multiple goroutines: the underlying protocol is a single stateful request/response session over one TCP connection. Use a separate Client per goroutine, or synchronize access to a shared Client externally.

func Dial 

func Dial(ctx context.Context, opts Options) (*Client, error)

Dial connects to and authenticates with the server described by opts, and returns a ready-to-use Client.

Example 
// A real program dials a live CommuniGate Pro server; this example
// dials a minimal fake one standing in for it, so it can run
// deterministically without network access.
srv, err := startFakeServer("200 fake PWD Server ready", func(line string) []string {
	if r, ok := stdLoginPlain(line); ok {
		return r
	}
	return []string{"200 OK"}
})
if err != nil {
	fmt.Println("error:", err)
	return
}
defer srv.ln.Close()

ctx := context.Background()
c, err := Dial(ctx, Options{
	Addr:        srv.Addr(),
	Login:       "admin@example.com",
	Password:    "hunter2",
	SecureLogin: PlainLogin,
})
if err != nil {
	fmt.Println("error:", err)
	return
}
defer c.Close(ctx)

fmt.Println("connected")

Output:
connected

func (*Client) Balance added in v0.3.0 

func (c *Client) Balance(ctx context.Context, in *BalanceInput) (*BalanceOutput, error)

Balance runs the BALANCE command.

func (*Client) BlessSession added in v0.3.0 

func (c *Client) BlessSession(ctx context.Context, in *BlessSessionInput) (*BlessSessionOutput, error)

BlessSession runs the BLESSSESSION command.

func (*Client) BlockAccount added in v0.3.0 

func (c *Client) BlockAccount(ctx context.Context, in *BlockAccountInput) (*BlockAccountOutput, error)

BlockAccount runs the BLOCKACCOUNT command.

func (*Client) BuildAccountSearchIndex added in v0.3.0 

func (c *Client) BuildAccountSearchIndex(ctx context.Context, in *BuildAccountSearchIndexInput) (*BuildAccountSearchIndexOutput, error)

BuildAccountSearchIndex runs the BUILDACCOUNTSEARCHINDEX command.

func (*Client) BuildDomainSearchIndex added in v0.3.0 

func (c *Client) BuildDomainSearchIndex(ctx context.Context, in *BuildDomainSearchIndexInput) (*BuildDomainSearchIndexOutput, error)

BuildDomainSearchIndex runs the BUILDDOMAINSEARCHINDEX command.

func (*Client) BuildGroupSearchIndex added in v0.3.0 

func (c *Client) BuildGroupSearchIndex(ctx context.Context, in *BuildGroupSearchIndexInput) (*BuildGroupSearchIndexOutput, error)

BuildGroupSearchIndex runs the BUILDGROUPSEARCHINDEX command.

func (*Client) ChangePassword 

func (c *Client) ChangePassword(ctx context.Context, newPassword string) error

ChangePassword changes the password of the currently authenticated account, via the PWD/CLI NEWPASS command.

func (*Client) Close 

func (c *Client) Close(ctx context.Context) error

Close ends the session, sending QUIT if the connection is currently open, and marks the Client closed: subsequent calls return ErrClosed instead of transparently reconnecting. Call Dial again (or build a new Client) to resume use.

func (*Client) CreateAccount 

func (c *Client) CreateAccount(ctx context.Context, in *CreateAccountInput) (*CreateAccountOutput, error)

CreateAccount runs the CREATEACCOUNT command.

Example 
srv, err := startFakeServer("200 fake PWD Server ready", func(line string) []string {
	if r, ok := stdLoginPlain(line); ok {
		return r
	}
	return []string{"200 OK"}
})
if err != nil {
	fmt.Println("error:", err)
	return
}
defer srv.ln.Close()

ctx := context.Background()
c, err := Dial(ctx, Options{
	Addr:        srv.Addr(),
	Login:       "admin@example.com",
	Password:    "hunter2",
	SecureLogin: PlainLogin,
})
if err != nil {
	fmt.Println("error:", err)
	return
}
defer c.Close(ctx)

_, err = c.CreateAccount(ctx, &CreateAccountInput{
	AccountName: "alice@example.com",
	AccountType: "MultiMailbox",
})
if err != nil {
	fmt.Println("error:", err)
	return
}
fmt.Println("account created")

Output:
account created

func (*Client) CreateAccountStorage added in v0.3.0 

func (c *Client) CreateAccountStorage(ctx context.Context, in *CreateAccountStorageInput) (*CreateAccountStorageOutput, error)

CreateAccountStorage runs the CREATEACCOUNTSTORAGE command.

func (*Client) CreateClusterPBX added in v0.3.0 

func (c *Client) CreateClusterPBX(ctx context.Context, in *CreateClusterPBXInput) (*CreateClusterPBXOutput, error)

CreateClusterPBX runs the CREATECLUSTERPBX command.

func (*Client) CreateClusterSkin added in v0.3.0 

func (c *Client) CreateClusterSkin(ctx context.Context, in *CreateClusterSkinInput) (*CreateClusterSkinOutput, error)

CreateClusterSkin runs the CREATECLUSTERSKIN command.

func (*Client) CreateDirectoryDomain added in v0.3.0 

func (c *Client) CreateDirectoryDomain(ctx context.Context, in *CreateDirectoryDomainInput) (*CreateDirectoryDomainOutput, error)

CreateDirectoryDomain runs the CREATEDIRECTORYDOMAIN command.

func (*Client) CreateDirectoryUnit added in v0.3.0 

func (c *Client) CreateDirectoryUnit(ctx context.Context, in *CreateDirectoryUnitInput) (*CreateDirectoryUnitOutput, error)

CreateDirectoryUnit runs the CREATEDIRECTORYUNIT command.

func (*Client) CreateDomain added in v0.3.0 

func (c *Client) CreateDomain(ctx context.Context, in *CreateDomainInput) (*CreateDomainOutput, error)

CreateDomain runs the CREATEDOMAIN command.

func (*Client) CreateDomainPBX added in v0.3.0 

func (c *Client) CreateDomainPBX(ctx context.Context, in *CreateDomainPBXInput) (*CreateDomainPBXOutput, error)

CreateDomainPBX runs the CREATEDOMAINPBX command.

func (*Client) CreateDomainSkin added in v0.2.0 

func (c *Client) CreateDomainSkin(ctx context.Context, in *CreateDomainSkinInput) (*CreateDomainSkinOutput, error)

CreateDomainSkin runs the CREATEDOMAINSKIN command.

func (*Client) CreateDomainStorage added in v0.3.0 

func (c *Client) CreateDomainStorage(ctx context.Context, in *CreateDomainStorageInput) (*CreateDomainStorageOutput, error)

CreateDomainStorage runs the CREATEDOMAINSTORAGE command.

func (*Client) CreateForwarder added in v0.3.0 

func (c *Client) CreateForwarder(ctx context.Context, in *CreateForwarderInput) (*CreateForwarderOutput, error)

CreateForwarder runs the CREATEFORWARDER command.

func (*Client) CreateGroup added in v0.3.0 

func (c *Client) CreateGroup(ctx context.Context, in *CreateGroupInput) (*CreateGroupOutput, error)

CreateGroup runs the CREATEGROUP command.

func (*Client) CreateList added in v0.3.0 

func (c *Client) CreateList(ctx context.Context, in *CreateListInput) (*CreateListOutput, error)

CreateList runs the CREATELIST command.

func (*Client) CreateLiteSession added in v0.3.0 

func (c *Client) CreateLiteSession(ctx context.Context, in *CreateLiteSessionInput) (*CreateLiteSessionOutput, error)

CreateLiteSession runs the CREATELITESESSION command.

func (*Client) CreateMailbox added in v0.3.0 

func (c *Client) CreateMailbox(ctx context.Context, in *CreateMailboxInput) (*CreateMailboxOutput, error)

CreateMailbox runs the CREATEMAILBOX command.

func (*Client) CreateNamedTask added in v0.3.0 

func (c *Client) CreateNamedTask(ctx context.Context, in *CreateNamedTaskInput) (*CreateNamedTaskOutput, error)

CreateNamedTask runs the CREATENAMEDTASK command.

func (*Client) CreateServerPBX added in v0.3.0 

func (c *Client) CreateServerPBX(ctx context.Context, in *CreateServerPBXInput) (*CreateServerPBXOutput, error)

CreateServerPBX runs the CREATESERVERPBX command.

func (*Client) CreateServerSkin added in v0.3.0 

func (c *Client) CreateServerSkin(ctx context.Context, in *CreateServerSkinInput) (*CreateServerSkinOutput, error)

CreateServerSkin runs the CREATESERVERSKIN command.

func (*Client) CreateWebUserSession added in v0.3.0 

func (c *Client) CreateWebUserSession(ctx context.Context, in *CreateWebUserSessionInput) (*CreateWebUserSessionOutput, error)

CreateWebUserSession runs the CREATEWEBUSERSESSION command.

func (*Client) CreateXIMSSSession added in v0.3.0 

func (c *Client) CreateXIMSSSession(ctx context.Context, in *CreateXIMSSSessionInput) (*CreateXIMSSSessionOutput, error)

CreateXIMSSSession runs the CREATEXIMSSSESSION command.

func (*Client) Dataset added in v0.3.0 

func (c *Client) Dataset(ctx context.Context, in *DatasetInput) (*DatasetOutput, error)

Dataset runs the DATASET command.

func (*Client) DeleteAccount 

func (c *Client) DeleteAccount(ctx context.Context, in *DeleteAccountInput) (*DeleteAccountOutput, error)

DeleteAccount runs the DELETEACCOUNT command.

func (*Client) DeleteAccountMailRule added in v0.3.0 

func (c *Client) DeleteAccountMailRule(ctx context.Context, in *DeleteAccountMailRuleInput) (*DeleteAccountMailRuleOutput, error)

DeleteAccountMailRule runs the "DELETE oldRule" form of the UPDATEACCOUNTMAILRULE command (there is no separate CLI verb for it, matching skin.go's DeleteDomainSkinFile precedent). It does not error if RuleName does not exist.

func (*Client) DeleteAccountSignalRule added in v0.3.0 

func (c *Client) DeleteAccountSignalRule(ctx context.Context, in *DeleteAccountSignalRuleInput) (*DeleteAccountSignalRuleOutput, error)

DeleteAccountSignalRule runs the "DELETE oldRule" form of the UPDATEACCOUNTSIGNALRULE command (there is no separate CLI verb for it, matching skin.go's DeleteDomainSkinFile precedent). It does not error if RuleName does not exist.

func (*Client) DeleteClusterPBX added in v0.3.0 

func (c *Client) DeleteClusterPBX(ctx context.Context, in *DeleteClusterPBXInput) (*DeleteClusterPBXOutput, error)

DeleteClusterPBX runs the DELETECLUSTERPBX command.

func (*Client) DeleteClusterPBXFile added in v0.3.0 

func (c *Client) DeleteClusterPBXFile(ctx context.Context, in *DeleteClusterPBXFileInput) (*DeleteClusterPBXFileOutput, error)

DeleteClusterPBXFile deletes a cluster-wide PBX file, via the DELETE form of the STORECLUSTERPBXFILE command (there is no separate CLI verb for it).

func (*Client) DeleteClusterSkin added in v0.3.0 

func (c *Client) DeleteClusterSkin(ctx context.Context, in *DeleteClusterSkinInput) (*DeleteClusterSkinOutput, error)

DeleteClusterSkin runs the DELETECLUSTERSKIN command.

func (*Client) DeleteClusterSkinFile added in v0.3.0 

func (c *Client) DeleteClusterSkinFile(ctx context.Context, in *DeleteClusterSkinFileInput) (*DeleteClusterSkinFileOutput, error)

DeleteClusterSkinFile deletes a Skin file, via the DELETE form of the STORECLUSTERSKINFILE command (there is no separate CLI verb for it).

func (*Client) DeleteDirectoryRecords added in v0.3.0 

func (c *Client) DeleteDirectoryRecords(ctx context.Context, in *DeleteDirectoryRecordsInput) (*DeleteDirectoryRecordsOutput, error)

DeleteDirectoryRecords runs the DELETEDIRECTORYRECORDS command. A nil Input is allowed and applies to the authenticated user Domain. This command can be used by Domain Administrators only if they have the CentralDirectory access right.

func (*Client) DeleteDirectoryUnit added in v0.3.0 

func (c *Client) DeleteDirectoryUnit(ctx context.Context, in *DeleteDirectoryUnitInput) (*DeleteDirectoryUnitOutput, error)

DeleteDirectoryUnit runs the DELETEDIRECTORYUNIT command.

func (*Client) DeleteDomain added in v0.3.0 

func (c *Client) DeleteDomain(ctx context.Context, in *DeleteDomainInput) (*DeleteDomainOutput, error)

DeleteDomain runs the DELETEDOMAIN command.

func (*Client) DeleteDomainPBX added in v0.3.0 

func (c *Client) DeleteDomainPBX(ctx context.Context, in *DeleteDomainPBXInput) (*DeleteDomainPBXOutput, error)

DeleteDomainPBX runs the DELETEDOMAINPBX command.

func (*Client) DeleteDomainPBXFile added in v0.3.0 

func (c *Client) DeleteDomainPBXFile(ctx context.Context, in *DeleteDomainPBXFileInput) (*DeleteDomainPBXFileOutput, error)

DeleteDomainPBXFile deletes a Domain PBX file, via the DELETE form of the STOREDOMAINPBXFILE command (there is no separate CLI verb for it).

func (*Client) DeleteDomainSkin added in v0.3.0 

func (c *Client) DeleteDomainSkin(ctx context.Context, in *DeleteDomainSkinInput) (*DeleteDomainSkinOutput, error)

DeleteDomainSkin runs the DELETEDOMAINSKIN command.

func (*Client) DeleteDomainSkinFile added in v0.2.0 

func (c *Client) DeleteDomainSkinFile(ctx context.Context, in *DeleteDomainSkinFileInput) (*DeleteDomainSkinFileOutput, error)

DeleteDomainSkinFile deletes a Skin file, via the DELETE form of the STOREDOMAINSKINFILE command (there is no separate CLI verb for it).

func (*Client) DeleteForwarder added in v0.3.0 

func (c *Client) DeleteForwarder(ctx context.Context, in *DeleteForwarderInput) (*DeleteForwarderOutput, error)

DeleteForwarder runs the DELETEFORWARDER command.

func (*Client) DeleteGroup added in v0.3.0 

func (c *Client) DeleteGroup(ctx context.Context, in *DeleteGroupInput) (*DeleteGroupOutput, error)

DeleteGroup runs the DELETEGROUP command.

func (*Client) DeleteList added in v0.3.0 

func (c *Client) DeleteList(ctx context.Context, in *DeleteListInput) (*DeleteListOutput, error)

DeleteList runs the DELETELIST command.

func (*Client) DeleteMailbox added in v0.3.0 

func (c *Client) DeleteMailbox(ctx context.Context, in *DeleteMailboxInput) (*DeleteMailboxOutput, error)

DeleteMailbox runs the DELETEMAILBOX command, in its MAILBOX form or, when Input.Recursive is set, its MAILBOXES form.

func (*Client) DeleteNamedTask added in v0.3.0 

func (c *Client) DeleteNamedTask(ctx context.Context, in *DeleteNamedTaskInput) (*DeleteNamedTaskOutput, error)

DeleteNamedTask runs the DELETENAMEDTASK command.

func (*Client) DeleteServerPBX added in v0.3.0 

func (c *Client) DeleteServerPBX(ctx context.Context, in *DeleteServerPBXInput) (*DeleteServerPBXOutput, error)

DeleteServerPBX runs the DELETESERVERPBX command.

func (*Client) DeleteServerPBXFile added in v0.3.0 

func (c *Client) DeleteServerPBXFile(ctx context.Context, in *DeleteServerPBXFileInput) (*DeleteServerPBXFileOutput, error)

DeleteServerPBXFile deletes a Server-wide PBX file, via the DELETE form of the STORESERVERPBXFILE command (there is no separate CLI verb for it).

func (*Client) DeleteServerSkin added in v0.3.0 

func (c *Client) DeleteServerSkin(ctx context.Context, in *DeleteServerSkinInput) (*DeleteServerSkinOutput, error)

DeleteServerSkin runs the DELETESERVERSKIN command.

func (*Client) DeleteServerSkinFile added in v0.3.0 

func (c *Client) DeleteServerSkinFile(ctx context.Context, in *DeleteServerSkinFileInput) (*DeleteServerSkinFileOutput, error)

DeleteServerSkinFile deletes a Skin file, via the DELETE form of the STORESERVERSKINFILE command (there is no separate CLI verb for it).

func (*Client) DeleteStorageFile added in v0.3.0 

func (c *Client) DeleteStorageFile(ctx context.Context, in *DeleteStorageFileInput) (*DeleteStorageFileOutput, error)

DeleteStorageFile runs the DELETESTORAGEFILE command.

func (*Client) DumpAllObjects added in v0.3.0 

func (c *Client) DumpAllObjects(ctx context.Context, in *DumpAllObjectsInput) (*DumpAllObjectsOutput, error)

DumpAllObjects runs the DUMPALLOBJECTS command. A nil Input is allowed - every field is optional.

func (*Client) Echo added in v0.3.0 

func (c *Client) Echo(ctx context.Context, in *EchoInput) (*EchoOutput, error)

Echo runs the ECHO command.

func (*Client) FindAccountSession added in v0.3.0 

func (c *Client) FindAccountSession(ctx context.Context, in *FindAccountSessionInput) (*FindAccountSessionOutput, error)

FindAccountSession runs the FINDACCOUNTSESSION command.

func (*Client) FindForwarders added in v0.3.0 

func (c *Client) FindForwarders(ctx context.Context, in *FindForwardersInput) (*FindForwardersOutput, error)

FindForwarders runs the FINDFORWARDERS command.

func (*Client) GetAccountACL added in v0.3.0 

func (c *Client) GetAccountACL(ctx context.Context, in *GetAccountACLInput) (*GetAccountACLOutput, error)

GetAccountACL runs the GETACCOUNTACL command. This command can be used by the Account owner and by Domain Administrators who have the CanImpersonate access right.

func (*Client) GetAccountACLRights added in v0.3.0 

func (c *Client) GetAccountACLRights(ctx context.Context, in *GetAccountACLRightsInput) (*GetAccountACLRightsOutput, error)

GetAccountACLRights runs the GETACCOUNTACLRIGHTS command. This command can be used by the Account owner and by Domain Administrators who have the CanImpersonate access right.

func (*Client) GetAccountAirSyncDevices added in v0.3.0 

func (c *Client) GetAccountAirSyncDevices(ctx context.Context, in *GetAccountAirSyncDevicesInput) (*GetAccountAirSyncDevicesOutput, error)

GetAccountAirSyncDevices runs the GETACCOUNTAIRSYNCDEVICES command.

func (*Client) GetAccountAlerts added in v0.3.0 

func (c *Client) GetAccountAlerts(ctx context.Context, in *GetAccountAlertsInput) (*GetAccountAlertsOutput, error)

GetAccountAlerts runs the GETACCOUNTALERTS command.

func (*Client) GetAccountAliases added in v0.3.0 

func (c *Client) GetAccountAliases(ctx context.Context, in *GetAccountAliasesInput) (*GetAccountAliasesOutput, error)

GetAccountAliases runs the GETACCOUNTALIASES command.

func (*Client) GetAccountDefaultPrefs added in v0.3.0 

func (c *Client) GetAccountDefaultPrefs(ctx context.Context, in *GetAccountDefaultPrefsInput) (*GetAccountDefaultPrefsOutput, error)

GetAccountDefaultPrefs runs the GETACCOUNTDEFAULTPREFS command. A nil Input is allowed and applies to the administrator Domain.

func (*Client) GetAccountDefaults added in v0.3.0 

func (c *Client) GetAccountDefaults(ctx context.Context, in *GetAccountDefaultsInput) (*GetAccountDefaultsOutput, error)

GetAccountDefaults runs the GETACCOUNTDEFAULTS command. A nil Input is allowed and applies to the administrator Domain.

func (*Client) GetAccountEffectivePrefs added in v0.3.0 

func (c *Client) GetAccountEffectivePrefs(ctx context.Context, in *GetAccountEffectivePrefsInput) (*GetAccountEffectivePrefsOutput, error)

GetAccountEffectivePrefs runs the GETACCOUNTEFFECTIVEPREFS command.

func (*Client) GetAccountEffectiveSettings 

func (c *Client) GetAccountEffectiveSettings(ctx context.Context, in *GetAccountEffectiveSettingsInput) (*GetAccountEffectiveSettingsOutput, error)

GetAccountEffectiveSettings runs the GETACCOUNTEFFECTIVESETTINGS command.

func (*Client) GetAccountInfo added in v0.3.0 

func (c *Client) GetAccountInfo(ctx context.Context, in *GetAccountInfoInput) (*GetAccountInfoOutput, error)

GetAccountInfo runs the GETACCOUNTINFO command.

func (*Client) GetAccountLists added in v0.3.0 

func (c *Client) GetAccountLists(ctx context.Context, in *GetAccountListsInput) (*GetAccountListsOutput, error)

GetAccountLists runs the GETACCOUNTLISTS command.

func (*Client) GetAccountLocation added in v0.3.0 

func (c *Client) GetAccountLocation(ctx context.Context, in *GetAccountLocationInput) (*GetAccountLocationOutput, error)

GetAccountLocation runs the GETACCOUNTLOCATION command.

func (*Client) GetAccountMailRules added in v0.3.0 

func (c *Client) GetAccountMailRules(ctx context.Context, in *GetAccountMailRulesInput) (*GetAccountMailRulesOutput, error)

GetAccountMailRules runs the GETACCOUNTMAILRULES command.

func (*Client) GetAccountOneSetting added in v0.3.0 

func (c *Client) GetAccountOneSetting(ctx context.Context, in *GetAccountOneSettingInput) (*GetAccountOneSettingOutput, error)

GetAccountOneSetting runs the GETACCOUNTONESETTING command.

func (*Client) GetAccountPrefs added in v0.3.0 

func (c *Client) GetAccountPrefs(ctx context.Context, in *GetAccountPrefsInput) (*GetAccountPrefsOutput, error)

GetAccountPrefs runs the GETACCOUNTPREFS command.

func (*Client) GetAccountPresence added in v0.3.0 

func (c *Client) GetAccountPresence(ctx context.Context, in *GetAccountPresenceInput) (*GetAccountPresenceOutput, error)

GetAccountPresence runs the GETACCOUNTPRESENCE command.

func (*Client) GetAccountRIMAPs added in v0.3.0 

func (c *Client) GetAccountRIMAPs(ctx context.Context, in *GetAccountRIMAPsInput) (*GetAccountRIMAPsOutput, error)

GetAccountRIMAPs runs the GETACCOUNTRIMAPS command.

func (*Client) GetAccountRPOPs added in v0.3.0 

func (c *Client) GetAccountRPOPs(ctx context.Context, in *GetAccountRPOPsInput) (*GetAccountRPOPsOutput, error)

GetAccountRPOPs runs the GETACCOUNTRPOPS command.

func (*Client) GetAccountRSIPs added in v0.3.0 

func (c *Client) GetAccountRSIPs(ctx context.Context, in *GetAccountRSIPsInput) (*GetAccountRSIPsOutput, error)

GetAccountRSIPs runs the GETACCOUNTRSIPS command.

func (*Client) GetAccountRights added in v0.3.0 

func (c *Client) GetAccountRights(ctx context.Context, in *GetAccountRightsInput) (*GetAccountRightsOutput, error)

GetAccountRights runs the GETACCOUNTRIGHTS command.

func (*Client) GetAccountSearchIndexSize added in v0.3.0 

func (c *Client) GetAccountSearchIndexSize(ctx context.Context, in *GetAccountSearchIndexSizeInput) (*GetAccountSearchIndexSizeOutput, error)

GetAccountSearchIndexSize runs the GETACCOUNTSEARCHINDEXSIZE command.

func (*Client) GetAccountSearchIndexState added in v0.3.0 

func (c *Client) GetAccountSearchIndexState(ctx context.Context, in *GetAccountSearchIndexStateInput) (*GetAccountSearchIndexStateOutput, error)

GetAccountSearchIndexState runs the GETACCOUNTSEARCHINDEXSTATE command.

func (*Client) GetAccountSettings 

func (c *Client) GetAccountSettings(ctx context.Context, in *GetAccountSettingsInput) (*GetAccountSettingsOutput, error)

GetAccountSettings runs the GETACCOUNTSETTINGS command.

func (*Client) GetAccountSignalRules added in v0.3.0 

func (c *Client) GetAccountSignalRules(ctx context.Context, in *GetAccountSignalRulesInput) (*GetAccountSignalRulesOutput, error)

GetAccountSignalRules runs the GETACCOUNTSIGNALRULES command.

func (*Client) GetAccountStat added in v0.3.0 

func (c *Client) GetAccountStat(ctx context.Context, in *GetAccountStatInput) (*GetAccountStatOutput, error)

GetAccountStat runs the GETACCOUNTSTAT command.

func (*Client) GetAccountTelnums added in v0.3.0 

func (c *Client) GetAccountTelnums(ctx context.Context, in *GetAccountTelnumsInput) (*GetAccountTelnumsOutput, error)

GetAccountTelnums runs the GETACCOUNTTELNUMS command.

func (*Client) GetAccountTemplate added in v0.3.0 

func (c *Client) GetAccountTemplate(ctx context.Context, in *GetAccountTemplateInput) (*GetAccountTemplateOutput, error)

GetAccountTemplate runs the GETACCOUNTTEMPLATE command. A nil Input is allowed and applies to the administrator Domain.

func (*Client) GetAccountWebAuthSession added in v0.3.0 

func (c *Client) GetAccountWebAuthSession(ctx context.Context, in *GetAccountWebAuthSessionInput) (*GetAccountWebAuthSessionOutput, error)

GetAccountWebAuthSession runs the GETACCOUNTWEBAUTHSESSION command.

func (*Client) GetBanned added in v0.3.0 

func (c *Client) GetBanned(ctx context.Context, in *GetBannedInput) (*GetBannedOutput, error)

GetBanned runs the GETBANNED command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetBlacklistedIPs added in v0.3.0 

func (c *Client) GetBlacklistedIPs(ctx context.Context, in *GetBlacklistedIPsInput) (*GetBlacklistedIPsOutput, error)

GetBlacklistedIPs runs the GETBLACKLISTEDIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClientIPs added in v0.3.0 

func (c *Client) GetClientIPs(ctx context.Context, in *GetClientIPsInput) (*GetClientIPsOutput, error)

GetClientIPs runs the GETCLIENTIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterAccountDefaults added in v0.3.0 

func (c *Client) GetClusterAccountDefaults(ctx context.Context, in *GetClusterAccountDefaultsInput) (*GetClusterAccountDefaultsOutput, error)

GetClusterAccountDefaults runs the GETCLUSTERACCOUNTDEFAULTS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterAccountPrefs added in v0.3.0 

func (c *Client) GetClusterAccountPrefs(ctx context.Context, in *GetClusterAccountPrefsInput) (*GetClusterAccountPrefsOutput, error)

GetClusterAccountPrefs runs the GETCLUSTERACCOUNTPREFS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterAlerts added in v0.3.0 

func (c *Client) GetClusterAlerts(ctx context.Context, in *GetClusterAlertsInput) (*GetClusterAlertsOutput, error)

GetClusterAlerts runs the GETCLUSTERALERTS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterBanned added in v0.3.0 

func (c *Client) GetClusterBanned(ctx context.Context, in *GetClusterBannedInput) (*GetClusterBannedOutput, error)

GetClusterBanned runs the GETCLUSTERBANNED command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterBlacklistedIPs added in v0.3.0 

func (c *Client) GetClusterBlacklistedIPs(ctx context.Context, in *GetClusterBlacklistedIPsInput) (*GetClusterBlacklistedIPsOutput, error)

GetClusterBlacklistedIPs runs the GETCLUSTERBLACKLISTEDIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterClientIPs added in v0.3.0 

func (c *Client) GetClusterClientIPs(ctx context.Context, in *GetClusterClientIPsInput) (*GetClusterClientIPsOutput, error)

GetClusterClientIPs runs the GETCLUSTERCLIENTIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterDebugIPs added in v0.3.0 

func (c *Client) GetClusterDebugIPs(ctx context.Context, in *GetClusterDebugIPsInput) (*GetClusterDebugIPsOutput, error)

GetClusterDebugIPs runs the GETCLUSTERDEBUGIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterDeniedIPs added in v0.3.0 

func (c *Client) GetClusterDeniedIPs(ctx context.Context, in *GetClusterDeniedIPsInput) (*GetClusterDeniedIPsOutput, error)

GetClusterDeniedIPs runs the GETCLUSTERDENIEDIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterDirectoryIntegration added in v0.3.0 

func (c *Client) GetClusterDirectoryIntegration(ctx context.Context, in *GetClusterDirectoryIntegrationInput) (*GetClusterDirectoryIntegrationOutput, error)

GetClusterDirectoryIntegration runs the GETCLUSTERDIRECTORYINTEGRATION command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterDomainDefaults added in v0.3.0 

func (c *Client) GetClusterDomainDefaults(ctx context.Context, in *GetClusterDomainDefaultsInput) (*GetClusterDomainDefaultsOutput, error)

GetClusterDomainDefaults runs the GETCLUSTERDOMAINDEFAULTS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterIntercept added in v0.3.0 

func (c *Client) GetClusterIntercept(ctx context.Context, in *GetClusterInterceptInput) (*GetClusterInterceptOutput, error)

GetClusterIntercept runs the GETCLUSTERINTERCEPT command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterLANIPs added in v0.3.0 

func (c *Client) GetClusterLANIPs(ctx context.Context, in *GetClusterLANIPsInput) (*GetClusterLANIPsOutput, error)

GetClusterLANIPs runs the GETCLUSTERLANIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterMailRules added in v0.3.0 

func (c *Client) GetClusterMailRules(ctx context.Context, in *GetClusterMailRulesInput) (*GetClusterMailRulesOutput, error)

GetClusterMailRules runs the GETCLUSTERMAILRULES command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterNATSiteIPs added in v0.3.0 

func (c *Client) GetClusterNATSiteIPs(ctx context.Context, in *GetClusterNATSiteIPsInput) (*GetClusterNATSiteIPsOutput, error)

GetClusterNATSiteIPs runs the GETCLUSTERNATSITEIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterNATedIPs added in v0.3.0 

func (c *Client) GetClusterNATedIPs(ctx context.Context, in *GetClusterNATedIPsInput) (*GetClusterNATedIPsOutput, error)

GetClusterNATedIPs runs the GETCLUSTERNATEDIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterNetwork added in v0.3.0 

func (c *Client) GetClusterNetwork(ctx context.Context, in *GetClusterNetworkInput) (*GetClusterNetworkOutput, error)

GetClusterNetwork runs the GETCLUSTERNETWORK command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterProxyIPs added in v0.3.0 

func (c *Client) GetClusterProxyIPs(ctx context.Context, in *GetClusterProxyIPsInput) (*GetClusterProxyIPsOutput, error)

GetClusterProxyIPs runs the GETCLUSTERPROXYIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterRouterSettings added in v0.3.0 

func (c *Client) GetClusterRouterSettings(ctx context.Context, in *GetClusterRouterSettingsInput) (*GetClusterRouterSettingsOutput, error)

GetClusterRouterSettings runs the GETCLUSTERROUTERSETTINGS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterRouterTable added in v0.3.0 

func (c *Client) GetClusterRouterTable(ctx context.Context, in *GetClusterRouterTableInput) (*GetClusterRouterTableOutput, error)

GetClusterRouterTable runs the GETCLUSTERROUTERTABLE command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterSettings added in v0.3.0 

func (c *Client) GetClusterSettings(ctx context.Context, in *GetClusterSettingsInput) (*GetClusterSettingsOutput, error)

GetClusterSettings runs the GETCLUSTERSETTINGS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterSignalRules added in v0.3.0 

func (c *Client) GetClusterSignalRules(ctx context.Context, in *GetClusterSignalRulesInput) (*GetClusterSignalRulesOutput, error)

GetClusterSignalRules runs the GETCLUSTERSIGNALRULES command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterTrustedCerts added in v0.3.0 

func (c *Client) GetClusterTrustedCerts(ctx context.Context, in *GetClusterTrustedCertsInput) (*GetClusterTrustedCertsOutput, error)

GetClusterTrustedCerts runs the GETCLUSTERTRUSTEDCERTS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetClusterWhiteHoleIPs added in v0.3.0 

func (c *Client) GetClusterWhiteHoleIPs(ctx context.Context, in *GetClusterWhiteHoleIPsInput) (*GetClusterWhiteHoleIPsOutput, error)

GetClusterWhiteHoleIPs runs the GETCLUSTERWHITEHOLEIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetCurrentController added in v0.3.0 

func (c *Client) GetCurrentController(ctx context.Context, in *GetCurrentControllerInput) (*GetCurrentControllerOutput, error)

GetCurrentController runs the GETCURRENTCONTROLLER command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetCurrentTime added in v0.3.0 

func (c *Client) GetCurrentTime(ctx context.Context, in *GetCurrentTimeInput) (*GetCurrentTimeOutput, error)

GetCurrentTime runs the GETCURRENTTIME command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetDNRSettings added in v0.3.0 

func (c *Client) GetDNRSettings(ctx context.Context, in *GetDNRSettingsInput) (*GetDNRSettingsOutput, error)

GetDNRSettings runs the GETDNRSETTINGS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetDebugIPs added in v0.3.0 

func (c *Client) GetDebugIPs(ctx context.Context, in *GetDebugIPsInput) (*GetDebugIPsOutput, error)

GetDebugIPs runs the GETDEBUGIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetDeniedIPs added in v0.3.0 

func (c *Client) GetDeniedIPs(ctx context.Context, in *GetDeniedIPsInput) (*GetDeniedIPsOutput, error)

GetDeniedIPs runs the GETDENIEDIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetDialogInfo added in v0.3.0 

func (c *Client) GetDialogInfo(ctx context.Context, in *GetDialogInfoInput) (*GetDialogInfoOutput, error)

GetDialogInfo runs the GETDIALOGINFO command.

func (*Client) GetDirectoryAccessRights added in v0.3.0 

func (c *Client) GetDirectoryAccessRights(ctx context.Context, in *GetDirectoryAccessRightsInput) (*GetDirectoryAccessRightsOutput, error)

GetDirectoryAccessRights runs the GETDIRECTORYACCESSRIGHTS command. A nil Input is allowed and reads the local (non-shared) Access Rights.

func (*Client) GetDirectoryIntegration added in v0.3.0 

func (c *Client) GetDirectoryIntegration(ctx context.Context, in *GetDirectoryIntegrationInput) (*GetDirectoryIntegrationOutput, error)

GetDirectoryIntegration runs the GETDIRECTORYINTEGRATION command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetDirectoryUnit added in v0.3.0 

func (c *Client) GetDirectoryUnit(ctx context.Context, in *GetDirectoryUnitInput) (*GetDirectoryUnitOutput, error)

GetDirectoryUnit runs the GETDIRECTORYUNIT command.

func (*Client) GetDomainAlerts added in v0.3.0 

func (c *Client) GetDomainAlerts(ctx context.Context, in *GetDomainAlertsInput) (*GetDomainAlertsOutput, error)

GetDomainAlerts runs the GETDOMAINALERTS command. A nil Input is allowed and applies to the administrator Domain.

func (*Client) GetDomainAliases added in v0.2.0 

func (c *Client) GetDomainAliases(ctx context.Context, in *GetDomainAliasesInput) (*GetDomainAliasesOutput, error)

GetDomainAliases runs the GETDOMAINALIASES command.

func (*Client) GetDomainDefaults added in v0.3.0 

func (c *Client) GetDomainDefaults(ctx context.Context, in *GetDomainDefaultsInput) (*GetDomainDefaultsOutput, error)

GetDomainDefaults runs the GETDOMAINDEFAULTS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetDomainEffectiveSettings added in v0.2.0 

func (c *Client) GetDomainEffectiveSettings(ctx context.Context, in *GetDomainEffectiveSettingsInput) (*GetDomainEffectiveSettingsOutput, error)

GetDomainEffectiveSettings runs the GETDOMAINEFFECTIVESETTINGS command. A nil Input is allowed and applies to the administrator Domain.

func (*Client) GetDomainFreeBusy added in v0.3.0 

func (c *Client) GetDomainFreeBusy(ctx context.Context, in *GetDomainFreeBusyInput) (*GetDomainFreeBusyOutput, error)

GetDomainFreeBusy runs the GETDOMAINFREEBUSY command. A nil Input is allowed and applies to the administrator Domain.

func (*Client) GetDomainLists added in v0.3.0 

func (c *Client) GetDomainLists(ctx context.Context, in *GetDomainListsInput) (*GetDomainListsOutput, error)

GetDomainLists runs the GETDOMAINLISTS command. A nil Input is allowed and applies to the administrator Domain.

func (*Client) GetDomainLocation added in v0.3.0 

func (c *Client) GetDomainLocation(ctx context.Context, in *GetDomainLocationInput) (*GetDomainLocationOutput, error)

GetDomainLocation runs the GETDOMAINLOCATION command. A nil Input is allowed and applies to the administrator Domain.

func (*Client) GetDomainMailRules added in v0.3.0 

func (c *Client) GetDomainMailRules(ctx context.Context, in *GetDomainMailRulesInput) (*GetDomainMailRulesOutput, error)

GetDomainMailRules runs the GETDOMAINMAILRULES command.

func (*Client) GetDomainPluginsSettings added in v0.3.0 

func (c *Client) GetDomainPluginsSettings(ctx context.Context, in *GetDomainPluginsSettingsInput) (*GetDomainPluginsSettingsOutput, error)

GetDomainPluginsSettings runs the GETDOMAINPLUGINSSETTINGS command. A nil Input is allowed and applies to the administrator Domain.

func (*Client) GetDomainSearchIndexState added in v0.3.0 

func (c *Client) GetDomainSearchIndexState(ctx context.Context, in *GetDomainSearchIndexStateInput) (*GetDomainSearchIndexStateOutput, error)

GetDomainSearchIndexState runs the GETDOMAINSEARCHINDEXSTATE command.

func (*Client) GetDomainSettings added in v0.2.0 

func (c *Client) GetDomainSettings(ctx context.Context, in *GetDomainSettingsInput) (*GetDomainSettingsOutput, error)

GetDomainSettings runs the GETDOMAINSETTINGS command. A nil Input is allowed and applies to the administrator Domain.

func (*Client) GetDomainSignalRules added in v0.3.0 

func (c *Client) GetDomainSignalRules(ctx context.Context, in *GetDomainSignalRulesInput) (*GetDomainSignalRulesOutput, error)

GetDomainSignalRules runs the GETDOMAINSIGNALRULES command.

func (*Client) GetDomainStat added in v0.3.0 

func (c *Client) GetDomainStat(ctx context.Context, in *GetDomainStatInput) (*GetDomainStatOutput, error)

GetDomainStat runs the GETDOMAINSTAT command.

func (*Client) GetFileSubscription added in v0.3.0 

func (c *Client) GetFileSubscription(ctx context.Context, in *GetFileSubscriptionInput) (*GetFileSubscriptionOutput, error)

GetFileSubscription runs the GETFILESUBSCRIPTION command.

func (*Client) GetForwarder added in v0.3.0 

func (c *Client) GetForwarder(ctx context.Context, in *GetForwarderInput) (*GetForwarderOutput, error)

GetForwarder runs the GETFORWARDER command.

func (*Client) GetGroup added in v0.3.0 

func (c *Client) GetGroup(ctx context.Context, in *GetGroupInput) (*GetGroupOutput, error)

GetGroup runs the GETGROUP command.

func (*Client) GetIPState added in v0.3.0 

func (c *Client) GetIPState(ctx context.Context, in *GetIPStateInput) (*GetIPStateOutput, error)

GetIPState runs the GETIPSTATE command.

func (*Client) GetLANIPs added in v0.3.0 

func (c *Client) GetLANIPs(ctx context.Context, in *GetLANIPsInput) (*GetLANIPsOutput, error)

GetLANIPs runs the GETLANIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetList added in v0.3.0 

func (c *Client) GetList(ctx context.Context, in *GetListInput) (*GetListOutput, error)

GetList runs the GETLIST command.

func (*Client) GetLogSettings added in v0.3.0 

func (c *Client) GetLogSettings(ctx context.Context, in *GetLogSettingsInput) (*GetLogSettingsOutput, error)

GetLogSettings runs the GETLOGSETTINGS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetMailboxACL added in v0.3.0 

func (c *Client) GetMailboxACL(ctx context.Context, in *GetMailboxACLInput) (*GetMailboxACLOutput, error)

GetMailboxACL runs the GETMAILBOXACL command.

func (*Client) GetMailboxAliases added in v0.3.0 

func (c *Client) GetMailboxAliases(ctx context.Context, in *GetMailboxAliasesInput) (*GetMailboxAliasesOutput, error)

GetMailboxAliases runs the GETMAILBOXALIASES command.

func (*Client) GetMailboxAliasesUTF8 added in v0.3.0 

func (c *Client) GetMailboxAliasesUTF8(ctx context.Context, in *GetMailboxAliasesUTF8Input) (*GetMailboxAliasesUTF8Output, error)

GetMailboxAliasesUTF8 runs the GETMAILBOXALIASESUTF8 command - identical to GetMailboxAliases, except alias and target Mailbox names are returned UTF-8-encoded.

func (*Client) GetMailboxInfo added in v0.3.0 

func (c *Client) GetMailboxInfo(ctx context.Context, in *GetMailboxInfoInput) (*GetMailboxInfoOutput, error)

GetMailboxInfo runs the GETMAILBOXINFO command.

func (*Client) GetMailboxRights added in v0.3.0 

func (c *Client) GetMailboxRights(ctx context.Context, in *GetMailboxRightsInput) (*GetMailboxRightsOutput, error)

GetMailboxRights runs the GETMAILBOXRIGHTS command.

func (*Client) GetMailboxSubscription added in v0.3.0 

func (c *Client) GetMailboxSubscription(ctx context.Context, in *GetMailboxSubscriptionInput) (*GetMailboxSubscriptionOutput, error)

GetMailboxSubscription runs the GETMAILBOXSUBSCRIPTION command.

func (*Client) GetMailboxSubscriptionUTF8 added in v0.3.0 

func (c *Client) GetMailboxSubscriptionUTF8(ctx context.Context, in *GetMailboxSubscriptionUTF8Input) (*GetMailboxSubscriptionUTF8Output, error)

GetMailboxSubscriptionUTF8 runs the GETMAILBOXSUBSCRIPTIONUTF8 command - identical to GetMailboxSubscription, except Mailbox names are returned UTF-8-encoded.

func (*Client) GetMediaServerSettings added in v0.3.0 

func (c *Client) GetMediaServerSettings(ctx context.Context, in *GetMediaServerSettingsInput) (*GetMediaServerSettingsOutput, error)

GetMediaServerSettings runs the GETMEDIASERVERSETTINGS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetMessageQueueInfo added in v0.3.0 

func (c *Client) GetMessageQueueInfo(ctx context.Context, in *GetMessageQueueInfoInput) (*GetMessageQueueInfoOutput, error)

GetMessageQueueInfo runs the GETMESSAGEQUEUEINFO command.

func (*Client) GetModule added in v0.3.0 

func (c *Client) GetModule(ctx context.Context, in *GetModuleInput) (*GetModuleOutput, error)

GetModule runs the GETMODULE command.

func (*Client) GetNATSiteIPs added in v0.3.0 

func (c *Client) GetNATSiteIPs(ctx context.Context, in *GetNATSiteIPsInput) (*GetNATSiteIPsOutput, error)

GetNATSiteIPs runs the GETNATSITEIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetNATedIPs added in v0.3.0 

func (c *Client) GetNATedIPs(ctx context.Context, in *GetNATedIPsInput) (*GetNATedIPsOutput, error)

GetNATedIPs runs the GETNATEDIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetNamedTask added in v0.3.0 

func (c *Client) GetNamedTask(ctx context.Context, in *GetNamedTaskInput) (*GetNamedTaskOutput, error)

GetNamedTask runs the GETNAMEDTASK command.

func (*Client) GetNetwork added in v0.3.0 

func (c *Client) GetNetwork(ctx context.Context, in *GetNetworkInput) (*GetNetworkOutput, error)

GetNetwork runs the GETNETWORK command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetNextStatName added in v0.3.0 

func (c *Client) GetNextStatName(ctx context.Context, in *GetNextStatNameInput) (*GetNextStatNameOutput, error)

GetNextStatName runs the GETNEXTSTATNAME command. A nil Input is allowed and starts enumeration at the first available element, same as an empty Input.ObjectID. The server returns an error (surfaced as a *ResponseError) if Input.ObjectID names an element that does not exist, or the last available one.

func (*Client) GetProxyIPs added in v0.3.0 

func (c *Client) GetProxyIPs(ctx context.Context, in *GetProxyIPsInput) (*GetProxyIPsOutput, error)

GetProxyIPs runs the GETPROXYIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetQueueSettings added in v0.3.0 

func (c *Client) GetQueueSettings(ctx context.Context, in *GetQueueSettingsInput) (*GetQueueSettingsOutput, error)

GetQueueSettings runs the GETQUEUESETTINGS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetRouterSettings added in v0.3.0 

func (c *Client) GetRouterSettings(ctx context.Context, in *GetRouterSettingsInput) (*GetRouterSettingsOutput, error)

GetRouterSettings runs the GETROUTERSETTINGS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetRouterTable added in v0.3.0 

func (c *Client) GetRouterTable(ctx context.Context, in *GetRouterTableInput) (*GetRouterTableOutput, error)

GetRouterTable runs the GETROUTERTABLE command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetServerAccountDefaults added in v0.3.0 

func (c *Client) GetServerAccountDefaults(ctx context.Context, in *GetServerAccountDefaultsInput) (*GetServerAccountDefaultsOutput, error)

GetServerAccountDefaults runs the GETSERVERACCOUNTDEFAULTS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetServerAccountPrefs added in v0.3.0 

func (c *Client) GetServerAccountPrefs(ctx context.Context, in *GetServerAccountPrefsInput) (*GetServerAccountPrefsOutput, error)

GetServerAccountPrefs runs the GETSERVERACCOUNTPREFS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetServerAlerts added in v0.3.0 

func (c *Client) GetServerAlerts(ctx context.Context, in *GetServerAlertsInput) (*GetServerAlertsOutput, error)

GetServerAlerts runs the GETSERVERALERTS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetServerIntercept added in v0.3.0 

func (c *Client) GetServerIntercept(ctx context.Context, in *GetServerInterceptInput) (*GetServerInterceptOutput, error)

GetServerIntercept runs the GETSERVERINTERCEPT command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetServerMailRules added in v0.3.0 

func (c *Client) GetServerMailRules(ctx context.Context, in *GetServerMailRulesInput) (*GetServerMailRulesOutput, error)

GetServerMailRules runs the GETSERVERMAILRULES command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetServerSettings added in v0.3.0 

func (c *Client) GetServerSettings(ctx context.Context, in *GetServerSettingsInput) (*GetServerSettingsOutput, error)

GetServerSettings runs the GETSERVERSETTINGS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetServerSignalRules added in v0.3.0 

func (c *Client) GetServerSignalRules(ctx context.Context, in *GetServerSignalRulesInput) (*GetServerSignalRulesOutput, error)

GetServerSignalRules runs the GETSERVERSIGNALRULES command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetServerTrustedCerts added in v0.3.0 

func (c *Client) GetServerTrustedCerts(ctx context.Context, in *GetServerTrustedCertsInput) (*GetServerTrustedCertsOutput, error)

GetServerTrustedCerts runs the GETSERVERTRUSTEDCERTS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetSession added in v0.3.0 

func (c *Client) GetSession(ctx context.Context, in *GetSessionInput) (*GetSessionOutput, error)

GetSession runs the GETSESSION command. This operation resets the session's inactivity timer.

func (*Client) GetSessionSettings added in v0.3.0 

func (c *Client) GetSessionSettings(ctx context.Context, in *GetSessionSettingsInput) (*GetSessionSettingsOutput, error)

GetSessionSettings runs the GETSESSIONSETTINGS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetSignalSettings added in v0.3.0 

func (c *Client) GetSignalSettings(ctx context.Context, in *GetSignalSettingsInput) (*GetSignalSettingsOutput, error)

GetSignalSettings runs the GETSIGNALSETTINGS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetStatElement added in v0.3.0 

func (c *Client) GetStatElement(ctx context.Context, in *GetStatElementInput) (*GetStatElementOutput, error)

GetStatElement runs the GETSTATELEMENT command.

func (*Client) GetStorageFileInfo added in v0.3.0 

func (c *Client) GetStorageFileInfo(ctx context.Context, in *GetStorageFileInfoInput) (*GetStorageFileInfoOutput, error)

GetStorageFileInfo runs the GETSTORAGEFILEINFO command.

func (*Client) GetSubscriberInfo added in v0.3.0 

func (c *Client) GetSubscriberInfo(ctx context.Context, in *GetSubscriberInfoInput) (*GetSubscriberInfoOutput, error)

GetSubscriberInfo runs the GETSUBSCRIBERINFO command.

func (*Client) GetSystemInfo added in v0.3.0 

func (c *Client) GetSystemInfo(ctx context.Context, in *GetSystemInfoInput) (*GetSystemInfoOutput, error)

GetSystemInfo runs the GETSYSTEMINFO command.

func (*Client) GetTempBlacklistedIPs added in v0.3.0 

func (c *Client) GetTempBlacklistedIPs(ctx context.Context, in *GetTempBlacklistedIPsInput) (*GetTempBlacklistedIPsOutput, error)

GetTempBlacklistedIPs runs the GETTEMPBLACKLISTEDIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetTempClientIPs added in v0.3.0 

func (c *Client) GetTempClientIPs(ctx context.Context, in *GetTempClientIPsInput) (*GetTempClientIPsOutput, error)

GetTempClientIPs runs the GETTEMPCLIENTIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetTempUnblockableIPs added in v0.3.0 

func (c *Client) GetTempUnblockableIPs(ctx context.Context, in *GetTempUnblockableIPsInput) (*GetTempUnblockableIPsOutput, error)

GetTempUnblockableIPs runs the GETTEMPUNBLOCKABLEIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetVersion added in v0.2.0 

func (c *Client) GetVersion(ctx context.Context, in *GetVersionInput) (*GetVersionOutput, error)

GetVersion runs the GETVERSION command. A nil Input is allowed - the command takes no parameters.

func (*Client) GetWhiteHoleIPs added in v0.3.0 

func (c *Client) GetWhiteHoleIPs(ctx context.Context, in *GetWhiteHoleIPsInput) (*GetWhiteHoleIPsOutput, error)

GetWhiteHoleIPs runs the GETWHITEHOLEIPS command. A nil Input is allowed - the command takes no parameters.

func (*Client) InsertDirectoryRecords added in v0.3.0 

func (c *Client) InsertDirectoryRecords(ctx context.Context, in *InsertDirectoryRecordsInput) (*InsertDirectoryRecordsOutput, error)

InsertDirectoryRecords runs the INSERTDIRECTORYRECORDS command. A nil Input is allowed and applies to the authenticated user Domain. This command can be used by Domain Administrators only if they have the CentralDirectory access right.

func (*Client) KillAccountSessions added in v0.3.0 

func (c *Client) KillAccountSessions(ctx context.Context, in *KillAccountSessionsInput) (*KillAccountSessionsOutput, error)

KillAccountSessions runs the KILLACCOUNTSESSIONS command.

func (*Client) KillAccountWebAuthSession added in v0.3.0 

func (c *Client) KillAccountWebAuthSession(ctx context.Context, in *KillAccountWebAuthSessionInput) (*KillAccountWebAuthSessionOutput, error)

KillAccountWebAuthSession runs the KILLACCOUNTWEBAUTHSESSION command.

func (*Client) KillNode added in v0.3.0 

func (c *Client) KillNode(ctx context.Context, in *KillNodeInput) (*KillNodeOutput, error)

KillNode runs the KILLNODE command.

func (*Client) KillSession added in v0.3.0 

func (c *Client) KillSession(ctx context.Context, in *KillSessionInput) (*KillSessionOutput, error)

KillSession runs the KILLSESSION command.

func (*Client) LastCommand 

func (c *Client) LastCommand() string

LastCommand returns the first word of the most recently sent command line, for debugging - never the full line, so it never echoes a credential argument.

func (*Client) ListAccountNamedTasks added in v0.3.0 

func (c *Client) ListAccountNamedTasks(ctx context.Context, in *ListAccountNamedTasksInput) (*ListAccountNamedTasksOutput, error)

ListAccountNamedTasks runs the LISTACCOUNTNAMEDTASKS command.

func (*Client) ListAccountSessions added in v0.3.0 

func (c *Client) ListAccountSessions(ctx context.Context, in *ListAccountSessionsInput) (*ListAccountSessionsOutput, error)

ListAccountSessions runs the LISTACCOUNTSESSIONS command.

func (*Client) ListAccountStorage added in v0.3.0 

func (c *Client) ListAccountStorage(ctx context.Context, in *ListAccountStorageInput) (*ListAccountStorageOutput, error)

ListAccountStorage runs the LISTACCOUNTSTORAGE command.

func (*Client) ListAccountWebAuthSessions added in v0.3.0 

func (c *Client) ListAccountWebAuthSessions(ctx context.Context, in *ListAccountWebAuthSessionsInput) (*ListAccountWebAuthSessionsOutput, error)

ListAccountWebAuthSessions runs the LISTACCOUNTWEBAUTHSESSIONS command.

func (*Client) ListAccounts 

func (c *Client) ListAccounts(ctx context.Context, in *ListAccountsInput) (*ListAccountsOutput, error)

ListAccounts runs the LISTACCOUNTS command.

func (*Client) ListAdminDomains added in v0.3.0 

func (c *Client) ListAdminDomains(ctx context.Context, in *ListAdminDomainsInput) (*ListAdminDomainsOutput, error)

ListAdminDomains runs the LISTADMINDOMAINS command. A nil Input is allowed and applies to the authenticated user Domain.

func (*Client) ListCLICommands added in v0.3.0 

func (c *Client) ListCLICommands(ctx context.Context, in *ListCLICommandsInput) (*ListCLICommandsOutput, error)

ListCLICommands runs the LISTCLICOMMANDS command. A nil Input is allowed - the command takes no parameters.

func (*Client) ListClusterPBXFiles added in v0.3.0 

func (c *Client) ListClusterPBXFiles(ctx context.Context, in *ListClusterPBXFilesInput) (*ListClusterPBXFilesOutput, error)

ListClusterPBXFiles runs the LISTCLUSTERPBXFILES command. A nil Input is allowed - Language is the command's only, optional, parameter.

func (*Client) ListClusterSkinFiles added in v0.3.0 

func (c *Client) ListClusterSkinFiles(ctx context.Context, in *ListClusterSkinFilesInput) (*ListClusterSkinFilesOutput, error)

ListClusterSkinFiles runs the LISTCLUSTERSKINFILES command.

func (*Client) ListClusterSkins added in v0.3.0 

func (c *Client) ListClusterSkins(ctx context.Context, in *ListClusterSkinsInput) (*ListClusterSkinsOutput, error)

ListClusterSkins runs the LISTCLUSTERSKINS command. A nil Input is allowed - the command takes no parameters.

func (*Client) ListClusterTelnums added in v0.3.0 

func (c *Client) ListClusterTelnums(ctx context.Context, in *ListClusterTelnumsInput) (*ListClusterTelnumsOutput, error)

ListClusterTelnums runs the LISTCLUSTERTELNUMS command; the same as ListServerTelnums, but for shared Cluster Domains.

func (*Client) ListDeletions added in v0.3.0 

func (c *Client) ListDeletions(ctx context.Context, in *ListDeletionsInput) (*ListDeletionsOutput, error)

ListDeletions runs the LISTDELETIONS command. A user should have the "Can manage Deletions" access right to use this command.

func (*Client) ListDirectoryUnits added in v0.3.0 

func (c *Client) ListDirectoryUnits(ctx context.Context, in *ListDirectoryUnitsInput) (*ListDirectoryUnitsOutput, error)

ListDirectoryUnits runs the LISTDIRECTORYUNITS command. A nil Input is allowed and lists the local (non-shared) Units.

func (*Client) ListDomainNamedTasks added in v0.3.0 

func (c *Client) ListDomainNamedTasks(ctx context.Context, in *ListDomainNamedTasksInput) (*ListDomainNamedTasksOutput, error)

ListDomainNamedTasks runs the LISTDOMAINNAMEDTASKS command. A nil Input is allowed and applies to the administrator Domain.

func (*Client) ListDomainObjects 

func (c *Client) ListDomainObjects(ctx context.Context, in *ListDomainObjectsInput) (*ListDomainObjectsOutput, error)

ListDomainObjects runs the LISTDOMAINOBJECTS command.

func (*Client) ListDomainPBXFiles added in v0.3.0 

func (c *Client) ListDomainPBXFiles(ctx context.Context, in *ListDomainPBXFilesInput) (*ListDomainPBXFilesOutput, error)

ListDomainPBXFiles runs the LISTDOMAINPBXFILES command. A nil Input is allowed and applies to the administrator Domain.

func (*Client) ListDomainSkinFiles added in v0.3.0 

func (c *Client) ListDomainSkinFiles(ctx context.Context, in *ListDomainSkinFilesInput) (*ListDomainSkinFilesOutput, error)

ListDomainSkinFiles runs the LISTDOMAINSKINFILES command.

func (*Client) ListDomainSkins added in v0.2.0 

func (c *Client) ListDomainSkins(ctx context.Context, in *ListDomainSkinsInput) (*ListDomainSkinsOutput, error)

ListDomainSkins runs the LISTDOMAINSKINS command. A nil Input is allowed and applies to the administrator Domain.

func (*Client) ListDomainStorage added in v0.3.0 

func (c *Client) ListDomainStorage(ctx context.Context, in *ListDomainStorageInput) (*ListDomainStorageOutput, error)

ListDomainStorage runs the LISTDOMAINSTORAGE command. A nil Input is allowed and lists non-shared "storage mount points".

func (*Client) ListDomainTelnums 

func (c *Client) ListDomainTelnums(ctx context.Context, in *ListDomainTelnumsInput) (*ListDomainTelnumsOutput, error)

ListDomainTelnums runs the LISTDOMAINTELNUMS command.

func (*Client) ListDomains added in v0.2.0 

func (c *Client) ListDomains(ctx context.Context, in *ListDomainsInput) (*ListDomainsOutput, error)

ListDomains runs the LISTDOMAINS command. A nil Input is allowed - the command takes no parameters.

func (*Client) ListForwarders added in v0.3.0 

func (c *Client) ListForwarders(ctx context.Context, in *ListForwardersInput) (*ListForwardersOutput, error)

ListForwarders runs the LISTFORWARDERS command. A nil Input is allowed - every field is optional.

func (*Client) ListGroups added in v0.3.0 

func (c *Client) ListGroups(ctx context.Context, in *ListGroupsInput) (*ListGroupsOutput, error)

ListGroups runs the LISTGROUPS command. A nil Input is allowed - it applies to the administrator Domain.

func (*Client) ListLists added in v0.3.0 

func (c *Client) ListLists(ctx context.Context, in *ListListsInput) (*ListListsOutput, error)

ListLists runs the LISTLISTS command. A nil Input is allowed and applies to the administrator Domain.

func (*Client) ListLiteSessions added in v0.3.0 

func (c *Client) ListLiteSessions(ctx context.Context, in *ListLiteSessionsInput) (*ListLiteSessionsOutput, error)

ListLiteSessions runs the LISTLITESESSIONS command. A nil Input is allowed - every parameter is optional.

func (*Client) ListMailboxes added in v0.3.0 

func (c *Client) ListMailboxes(ctx context.Context, in *ListMailboxesInput) (*ListMailboxesOutput, error)

ListMailboxes runs the LISTMAILBOXES command.

func (*Client) ListModules added in v0.3.0 

func (c *Client) ListModules(ctx context.Context, in *ListModulesInput) (*ListModulesOutput, error)

ListModules runs the LISTMODULES command. A nil Input is allowed - the command takes no parameters.

func (*Client) ListServerPBXFiles added in v0.3.0 

func (c *Client) ListServerPBXFiles(ctx context.Context, in *ListServerPBXFilesInput) (*ListServerPBXFilesOutput, error)

ListServerPBXFiles runs the LISTSERVERPBXFILES command. A nil Input is allowed - Language is the command's only, optional, parameter.

func (*Client) ListServerSkinFiles added in v0.3.0 

func (c *Client) ListServerSkinFiles(ctx context.Context, in *ListServerSkinFilesInput) (*ListServerSkinFilesOutput, error)

ListServerSkinFiles runs the LISTSERVERSKINFILES command.

func (*Client) ListServerSkins added in v0.3.0 

func (c *Client) ListServerSkins(ctx context.Context, in *ListServerSkinsInput) (*ListServerSkinsOutput, error)

ListServerSkins runs the LISTSERVERSKINS command. A nil Input is allowed - the command takes no parameters. It is available to System Administrators only.

func (*Client) ListServerTelnums added in v0.3.0 

func (c *Client) ListServerTelnums(ctx context.Context, in *ListServerTelnumsInput) (*ListServerTelnumsOutput, error)

ListServerTelnums runs the LISTSERVERTELNUMS command.

func (*Client) ListStockPBXFiles added in v0.3.0 

func (c *Client) ListStockPBXFiles(ctx context.Context, in *ListStockPBXFilesInput) (*ListStockPBXFilesOutput, error)

ListStockPBXFiles runs the LISTSTOCKPBXFILES command. A nil Input is allowed - Language is the command's only, optional, parameter.

func (*Client) ListStockSkinFiles added in v0.3.0 

func (c *Client) ListStockSkinFiles(ctx context.Context, in *ListStockSkinFilesInput) (*ListStockSkinFilesOutput, error)

ListStockSkinFiles runs the LISTSTOCKSKINFILES command.

func (*Client) ListStorageFiles added in v0.3.0 

func (c *Client) ListStorageFiles(ctx context.Context, in *ListStorageFilesInput) (*ListStorageFilesOutput, error)

ListStorageFiles runs the LISTSTORAGEFILES command.

func (*Client) ListSubscribers added in v0.3.0 

func (c *Client) ListSubscribers(ctx context.Context, in *ListSubscribersInput) (*ListSubscribersOutput, error)

ListSubscribers runs the LISTSUBSCRIBERS command.

func (*Client) MainDomainName added in v0.2.0 

func (c *Client) MainDomainName(ctx context.Context, in *MainDomainNameInput) (*MainDomainNameOutput, error)

MainDomainName runs the MAINDOMAINNAME command. A nil Input is allowed - the command takes no parameters.

func (*Client) ModifyAccountTelnums added in v0.3.0 

func (c *Client) ModifyAccountTelnums(ctx context.Context, in *ModifyAccountTelnumsInput) (*ModifyAccountTelnumsOutput, error)

ModifyAccountTelnums runs the MODIFYACCOUNTTELNUMS command. This command can be used by Domain Administrators only if they have the CanCreateTelnums access right.

func (*Client) Noop added in v0.3.0 

func (c *Client) Noop(ctx context.Context, in *NoopInput) (*NoopOutput, error)

Noop runs the NOOP command. A nil Input is allowed - the command takes no parameters.

func (*Client) PostAccountAlert added in v0.3.0 

func (c *Client) PostAccountAlert(ctx context.Context, in *PostAccountAlertInput) (*PostAccountAlertOutput, error)

PostAccountAlert runs the POSTACCOUNTALERT command.

func (*Client) PostClusterAlert added in v0.3.0 

func (c *Client) PostClusterAlert(ctx context.Context, in *PostClusterAlertInput) (*PostClusterAlertOutput, error)

PostClusterAlert runs the POSTCLUSTERALERT command.

func (*Client) PostDomainAlert added in v0.3.0 

func (c *Client) PostDomainAlert(ctx context.Context, in *PostDomainAlertInput) (*PostDomainAlertOutput, error)

PostDomainAlert runs the POSTDOMAINALERT command.

func (*Client) PostServerAlert added in v0.3.0 

func (c *Client) PostServerAlert(ctx context.Context, in *PostServerAlertInput) (*PostServerAlertOutput, error)

PostServerAlert runs the POSTSERVERALERT command.

func (*Client) ProcessBounce added in v0.3.0 

func (c *Client) ProcessBounce(ctx context.Context, in *ProcessBounceInput) (*ProcessBounceOutput, error)

ProcessBounce runs the PROCESSBOUNCE command.

func (*Client) ReadClusterPBXFile added in v0.3.0 

func (c *Client) ReadClusterPBXFile(ctx context.Context, in *ReadClusterPBXFileInput) (*ReadClusterPBXFileOutput, error)

ReadClusterPBXFile runs the READCLUSTERPBXFILE command.

func (*Client) ReadClusterSkinFile added in v0.3.0 

func (c *Client) ReadClusterSkinFile(ctx context.Context, in *ReadClusterSkinFileInput) (*ReadClusterSkinFileOutput, error)

ReadClusterSkinFile runs the READCLUSTERSKINFILE command.

func (*Client) ReadDomainPBXFile added in v0.3.0 

func (c *Client) ReadDomainPBXFile(ctx context.Context, in *ReadDomainPBXFileInput) (*ReadDomainPBXFileOutput, error)

ReadDomainPBXFile runs the READDOMAINPBXFILE command.

func (*Client) ReadDomainSkinFile added in v0.2.0 

func (c *Client) ReadDomainSkinFile(ctx context.Context, in *ReadDomainSkinFileInput) (*ReadDomainSkinFileOutput, error)

ReadDomainSkinFile runs the READDOMAINSKINFILE command.

func (*Client) ReadNodeStatus added in v0.3.0 

func (c *Client) ReadNodeStatus(ctx context.Context, in *ReadNodeStatusInput) (*ReadNodeStatusOutput, error)

ReadNodeStatus runs the READNODESTATUS command.

func (*Client) ReadServerPBXFile added in v0.3.0 

func (c *Client) ReadServerPBXFile(ctx context.Context, in *ReadServerPBXFileInput) (*ReadServerPBXFileOutput, error)

ReadServerPBXFile runs the READSERVERPBXFILE command.

func (*Client) ReadServerSkinFile added in v0.3.0 

func (c *Client) ReadServerSkinFile(ctx context.Context, in *ReadServerSkinFileInput) (*ReadServerSkinFileOutput, error)

ReadServerSkinFile runs the READSERVERSKINFILE command.

func (*Client) ReadStockPBXFile added in v0.3.0 

func (c *Client) ReadStockPBXFile(ctx context.Context, in *ReadStockPBXFileInput) (*ReadStockPBXFileOutput, error)

ReadStockPBXFile runs the READSTOCKPBXFILE command.

func (*Client) ReadStockSkinFile added in v0.3.0 

func (c *Client) ReadStockSkinFile(ctx context.Context, in *ReadStockSkinFileInput) (*ReadStockSkinFileOutput, error)

ReadStockSkinFile runs the READSTOCKSKINFILE command.

func (*Client) ReadStorageFile added in v0.2.0 

func (c *Client) ReadStorageFile(ctx context.Context, in *ReadStorageFileInput) (*ReadStorageFileOutput, error)

ReadStorageFile runs the READSTORAGEFILE command.

func (*Client) ReadStorageFileAttr added in v0.3.0 

func (c *Client) ReadStorageFileAttr(ctx context.Context, in *ReadStorageFileAttrInput) (*ReadStorageFileAttrOutput, error)

ReadStorageFileAttr runs the READSTORAGEFILEATTR command.

func (*Client) ReadSubscribers added in v0.3.0 

func (c *Client) ReadSubscribers(ctx context.Context, in *ReadSubscribersInput) (*ReadSubscribersOutput, error)

ReadSubscribers runs the READSUBSCRIBERS command.

func (*Client) ReconnectClusterAdmin added in v0.3.0 

func (c *Client) ReconnectClusterAdmin(ctx context.Context, in *ReconnectClusterAdminInput) (*ReconnectClusterAdminOutput, error)

ReconnectClusterAdmin runs the RECONNECTCLUSTERADMIN command. A nil Input is allowed - the command takes no parameters.

func (*Client) RefreshOSData added in v0.3.0 

func (c *Client) RefreshOSData(ctx context.Context, in *RefreshOSDataInput) (*RefreshOSDataOutput, error)

RefreshOSData runs the REFRESHOSDATA command. A nil Input is allowed - the command takes no parameters.

func (*Client) RejectQueueMessage added in v0.3.0 

func (c *Client) RejectQueueMessage(ctx context.Context, in *RejectQueueMessageInput) (*RejectQueueMessageOutput, error)

RejectQueueMessage runs the REJECTQUEUEMESSAGE command.

func (*Client) RejectQueueMessages added in v0.3.0 

func (c *Client) RejectQueueMessages(ctx context.Context, in *RejectQueueMessagesInput) (*RejectQueueMessagesOutput, error)

RejectQueueMessages runs the REJECTQUEUEMESSAGES command.

func (*Client) ReleaseSMTPQueue added in v0.3.0 

func (c *Client) ReleaseSMTPQueue(ctx context.Context, in *ReleaseSMTPQueueInput) (*ReleaseSMTPQueueOutput, error)

ReleaseSMTPQueue runs the RELEASESMTPQUEUE command.

func (*Client) ReloadDirectoryDomains added in v0.3.0 

func (c *Client) ReloadDirectoryDomains(ctx context.Context, in *ReloadDirectoryDomainsInput) (*ReloadDirectoryDomainsOutput, error)

ReloadDirectoryDomains runs the RELOADDIRECTORYDOMAINS command. A nil Input is allowed - the command takes no parameters.

func (*Client) ReloadPluginSkins added in v0.3.0 

func (c *Client) ReloadPluginSkins(ctx context.Context, in *ReloadPluginSkinsInput) (*ReloadPluginSkinsOutput, error)

ReloadPluginSkins runs the RELOADPLUGINSKINS command. A nil Input is allowed and reloads Skins for all domains.

func (*Client) RelocateDirectoryUnit added in v0.3.0 

func (c *Client) RelocateDirectoryUnit(ctx context.Context, in *RelocateDirectoryUnitInput) (*RelocateDirectoryUnitOutput, error)

RelocateDirectoryUnit runs the RELOCATEDIRECTORYUNIT command.

func (*Client) RemoveAccountAlert added in v0.3.0 

func (c *Client) RemoveAccountAlert(ctx context.Context, in *RemoveAccountAlertInput) (*RemoveAccountAlertOutput, error)

RemoveAccountAlert runs the REMOVEACCOUNTALERT command.

func (*Client) RemoveAccountSearchIndex added in v0.3.0 

func (c *Client) RemoveAccountSearchIndex(ctx context.Context, in *RemoveAccountSearchIndexInput) (*RemoveAccountSearchIndexOutput, error)

RemoveAccountSearchIndex runs the REMOVEACCOUNTSEARCHINDEX command.

func (*Client) RemoveAccountSubset added in v0.3.0 

func (c *Client) RemoveAccountSubset(ctx context.Context, in *RemoveAccountSubsetInput) (*RemoveAccountSubsetOutput, error)

RemoveAccountSubset runs the REMOVEACCOUNTSUBSET command.

func (*Client) RemoveClusterAlert added in v0.3.0 

func (c *Client) RemoveClusterAlert(ctx context.Context, in *RemoveClusterAlertInput) (*RemoveClusterAlertOutput, error)

RemoveClusterAlert runs the REMOVECLUSTERALERT command.

func (*Client) RemoveDomainAlert added in v0.3.0 

func (c *Client) RemoveDomainAlert(ctx context.Context, in *RemoveDomainAlertInput) (*RemoveDomainAlertOutput, error)

RemoveDomainAlert runs the REMOVEDOMAINALERT command.

func (*Client) RemoveDomainSearchIndex added in v0.3.0 

func (c *Client) RemoveDomainSearchIndex(ctx context.Context, in *RemoveDomainSearchIndexInput) (*RemoveDomainSearchIndexOutput, error)

RemoveDomainSearchIndex runs the REMOVEDOMAINSEARCHINDEX command.

func (*Client) RemovePlugin added in v0.3.0 

func (c *Client) RemovePlugin(ctx context.Context, in *RemovePluginInput) (*RemovePluginOutput, error)

RemovePlugin runs the REMOVEPLUGIN command.

func (*Client) RemoveServerAlert added in v0.3.0 

func (c *Client) RemoveServerAlert(ctx context.Context, in *RemoveServerAlertInput) (*RemoveServerAlertOutput, error)

RemoveServerAlert runs the REMOVESERVERALERT command.

func (*Client) RenameAccount 

func (c *Client) RenameAccount(ctx context.Context, in *RenameAccountInput) (*RenameAccountOutput, error)

RenameAccount runs the RENAMEACCOUNT command.

func (*Client) RenameClusterSkin added in v0.3.0 

func (c *Client) RenameClusterSkin(ctx context.Context, in *RenameClusterSkinInput) (*RenameClusterSkinOutput, error)

RenameClusterSkin runs the RENAMECLUSTERSKIN command.

func (*Client) RenameDomain added in v0.3.0 

func (c *Client) RenameDomain(ctx context.Context, in *RenameDomainInput) (*RenameDomainOutput, error)

RenameDomain runs the RENAMEDOMAIN command.

func (*Client) RenameDomainSkin added in v0.3.0 

func (c *Client) RenameDomainSkin(ctx context.Context, in *RenameDomainSkinInput) (*RenameDomainSkinOutput, error)

RenameDomainSkin runs the RENAMEDOMAINSKIN command.

func (*Client) RenameForwarder added in v0.3.0 

func (c *Client) RenameForwarder(ctx context.Context, in *RenameForwarderInput) (*RenameForwarderOutput, error)

RenameForwarder runs the RENAMEFORWARDER command.

func (*Client) RenameGroup added in v0.3.0 

func (c *Client) RenameGroup(ctx context.Context, in *RenameGroupInput) (*RenameGroupOutput, error)

RenameGroup runs the RENAMEGROUP command.

func (*Client) RenameList added in v0.3.0 

func (c *Client) RenameList(ctx context.Context, in *RenameListInput) (*RenameListOutput, error)

RenameList runs the RENAMELIST command.

func (*Client) RenameMailbox added in v0.3.0 

func (c *Client) RenameMailbox(ctx context.Context, in *RenameMailboxInput) (*RenameMailboxOutput, error)

RenameMailbox runs the RENAMEMAILBOX command, in its MAILBOX form or, when Input.Recursive is set, its MAILBOXES form.

func (*Client) RenameNamedTask added in v0.3.0 

func (c *Client) RenameNamedTask(ctx context.Context, in *RenameNamedTaskInput) (*RenameNamedTaskOutput, error)

RenameNamedTask runs the RENAMENAMEDTASK command.

func (*Client) RenameServerSkin added in v0.3.0 

func (c *Client) RenameServerSkin(ctx context.Context, in *RenameServerSkinInput) (*RenameServerSkinOutput, error)

RenameServerSkin runs the RENAMESERVERSKIN command.

func (*Client) RenameStorageFile added in v0.2.0 

func (c *Client) RenameStorageFile(ctx context.Context, in *RenameStorageFileInput) (*RenameStorageFileOutput, error)

RenameStorageFile runs the RENAMESTORAGEFILE command.

func (*Client) ReportFailedLoginAddress added in v0.3.0 

func (c *Client) ReportFailedLoginAddress(ctx context.Context, in *ReportFailedLoginAddressInput) (*ReportFailedLoginAddressOutput, error)

ReportFailedLoginAddress runs the REPORTFAILEDLOGINADDRESS command.

func (*Client) ResetAccountStat added in v0.3.0 

func (c *Client) ResetAccountStat(ctx context.Context, in *ResetAccountStatInput) (*ResetAccountStatOutput, error)

ResetAccountStat runs the RESETACCOUNTSTAT command.

func (*Client) ResetDomainStat added in v0.3.0 

func (c *Client) ResetDomainStat(ctx context.Context, in *ResetDomainStatInput) (*ResetDomainStatOutput, error)

ResetDomainStat runs the RESETDOMAINSTAT command.

func (*Client) ResetTotpSecret added in v0.3.0 

func (c *Client) ResetTotpSecret(ctx context.Context, in *ResetTotpSecretInput) (*ResetTotpSecretOutput, error)

ResetTotpSecret runs the RESETTOTPSECRET command.

func (*Client) RestoreDeletion added in v0.3.0 

func (c *Client) RestoreDeletion(ctx context.Context, in *RestoreDeletionInput) (*RestoreDeletionOutput, error)

RestoreDeletion runs the RESTOREDELETION command. A user should have the "Can manage Deletions" access right to use this command.

func (*Client) ResumeDomain added in v0.3.0 

func (c *Client) ResumeDomain(ctx context.Context, in *ResumeDomainInput) (*ResumeDomainOutput, error)

ResumeDomain runs the RESUMEDOMAIN command.

func (*Client) Roster added in v0.3.0 

func (c *Client) Roster(ctx context.Context, in *RosterInput) (*RosterOutput, error)

Roster runs the ROSTER command.

func (*Client) Route added in v0.3.0 

func (c *Client) Route(ctx context.Context, in *RouteInput) (*RouteOutput, error)

Route runs the ROUTE command.

func (*Client) RunScript added in v0.3.0 

func (c *Client) RunScript(ctx context.Context, in *RunScriptInput) (*RunScriptOutput, error)

RunScript runs the RUNSCRIPT command.

func (*Client) SearchInIndex added in v0.3.0 

func (c *Client) SearchInIndex(ctx context.Context, in *SearchInIndexInput) (*SearchInIndexOutput, error)

SearchInIndex runs the SEARCHININDEX command. A malformed SearchString is rejected by the server with an "Invalid Query" error (a *ResponseError).

func (*Client) Send 

func (c *Client) Send(ctx context.Context, line string) (cgpdata.Value, error)

Send runs line - a single, already-formatted CLI command line, using github.com/gmyzovsky/go-cgp-data to encode any data-bearing token it contains - against the server. It returns the decoded response value for a data-bearing (201) response, nil for a plain success (200) with no data, and a non-nil error for anything else, including a connection failure.

Send is a deliberately dumb pipe: it does not parse or generate CLI command grammar itself, since that grammar mixes bare keywords, data tokens, arrays, and dictionaries differently per command (see https://doc.communigatepro.ru/development/CLI.html). Building the right line for a specific command is the caller's job today, and typed wrapper methods' job for the commands that have one.

line is one command line, and that is enforced rather than assumed: a line containing CR, LF, or NUL is rejected before any byte is written, because the server would otherwise read what follows as a second command issued with the session's administrative rights. Values that may contain those bytes belong in a Data Format token (via github.com/gmyzovsky/go-cgp-data), which escapes them.

Example 
srv, err := startFakeServer("200 fake PWD Server ready", func(line string) []string {
	if r, ok := stdLoginPlain(line); ok {
		return r
	}
	if commandVerb(line) == "GETVERSION" {
		return []string{`201 "6.4.1"`}
	}
	return []string{"200 OK"}
})
if err != nil {
	fmt.Println("error:", err)
	return
}
defer srv.ln.Close()

ctx := context.Background()
c, err := Dial(ctx, Options{
	Addr:        srv.Addr(),
	Login:       "admin@example.com",
	Password:    "hunter2",
	SecureLogin: PlainLogin,
})
if err != nil {
	fmt.Println("error:", err)
	return
}
defer c.Close(ctx)

v, err := c.Send(ctx, "GETVERSION")
if err != nil {
	fmt.Println("error:", err)
	return
}
fmt.Println(v)

Output:
6.4.1

func (*Client) SendTaskEvent added in v0.3.0 

func (c *Client) SendTaskEvent(ctx context.Context, in *SendTaskEventInput) (*SendTaskEventOutput, error)

SendTaskEvent runs the SENDTASKEVENT command.

func (*Client) SetAccountACL added in v0.3.0 

func (c *Client) SetAccountACL(ctx context.Context, in *SetAccountACLInput) (*SetAccountACLOutput, error)

SetAccountACL runs the SETACCOUNTACL command. This command can be used by the Account owner and by Domain Administrators who have the CanImpersonate access right.

func (*Client) SetAccountAlerts added in v0.3.0 

func (c *Client) SetAccountAlerts(ctx context.Context, in *SetAccountAlertsInput) (*SetAccountAlertsOutput, error)

SetAccountAlerts runs the SETACCOUNTALERTS command.

func (*Client) SetAccountAliases added in v0.3.0 

func (c *Client) SetAccountAliases(ctx context.Context, in *SetAccountAliasesInput) (*SetAccountAliasesOutput, error)

SetAccountAliases runs the SETACCOUNTALIASES command. This command can be used by Domain Administrators only if they have the CanCreateAliases access right.

func (*Client) SetAccountDefaultPrefs added in v0.3.0 

func (c *Client) SetAccountDefaultPrefs(ctx context.Context, in *SetAccountDefaultPrefsInput) (*SetAccountDefaultPrefsOutput, error)

SetAccountDefaultPrefs runs the SETACCOUNTDEFAULTPREFS command. This command can be used by Domain Administrators only if they have the WebUserSettings access right.

func (*Client) SetAccountDefaults added in v0.3.0 

func (c *Client) SetAccountDefaults(ctx context.Context, in *SetAccountDefaultsInput) (*SetAccountDefaultsOutput, error)

SetAccountDefaults runs the SETACCOUNTDEFAULTS command.

func (*Client) SetAccountMailRules added in v0.3.0 

func (c *Client) SetAccountMailRules(ctx context.Context, in *SetAccountMailRulesInput) (*SetAccountMailRulesOutput, error)

SetAccountMailRules runs the SETACCOUNTMAILRULES command. This command can be used by Domain Administrators only if they have the RulesAllowed access right, and by any Account user to modify their own Rules.

func (*Client) SetAccountPassword 

func (c *Client) SetAccountPassword(ctx context.Context, in *SetAccountPasswordInput) (*SetAccountPasswordOutput, error)

SetAccountPassword runs the SETACCOUNTPASSWORD command.

func (*Client) SetAccountPrefs added in v0.3.0 

func (c *Client) SetAccountPrefs(ctx context.Context, in *SetAccountPrefsInput) (*SetAccountPrefsOutput, error)

SetAccountPrefs runs the SETACCOUNTPREFS command. This command can be used by Domain Administrators only if they have the WebUserSettings access right.

func (*Client) SetAccountRIMAPs added in v0.3.0 

func (c *Client) SetAccountRIMAPs(ctx context.Context, in *SetAccountRIMAPsInput) (*SetAccountRIMAPsOutput, error)

SetAccountRIMAPs runs the SETACCOUNTRIMAPS command. This command can be used by Domain Administrators only if they have the CanModifyRPOP access right.

func (*Client) SetAccountRPOPs added in v0.3.0 

func (c *Client) SetAccountRPOPs(ctx context.Context, in *SetAccountRPOPsInput) (*SetAccountRPOPsOutput, error)

SetAccountRPOPs runs the SETACCOUNTRPOPS command. This command can be used by Domain Administrators only if they have the CanModifyRPOP access right.

func (*Client) SetAccountRSIPs added in v0.3.0 

func (c *Client) SetAccountRSIPs(ctx context.Context, in *SetAccountRSIPsInput) (*SetAccountRSIPsOutput, error)

SetAccountRSIPs runs the SETACCOUNTRSIPS command. This command can be used by Domain Administrators only if they have the CanModifyRSIP access right.

func (*Client) SetAccountRights added in v0.3.0 

func (c *Client) SetAccountRights(ctx context.Context, in *SetAccountRightsInput) (*SetAccountRightsOutput, error)

SetAccountRights runs the SETACCOUNTRIGHTS command. To set Domain Administration Rights for an Account in a secondary Domain, the user must have the All Domains Server access right.

func (*Client) SetAccountSettings 

func (c *Client) SetAccountSettings(ctx context.Context, in *SetAccountSettingsInput) (*SetAccountSettingsOutput, error)

SetAccountSettings runs the SETACCOUNTSETTINGS command.

func (*Client) SetAccountSignalRules added in v0.3.0 

func (c *Client) SetAccountSignalRules(ctx context.Context, in *SetAccountSignalRulesInput) (*SetAccountSignalRulesOutput, error)

SetAccountSignalRules runs the SETACCOUNTSIGNALRULES command. This command can be used by Domain Administrators only if they have the SignalRulesAllowed access right.

func (*Client) SetAccountTelnums added in v0.3.0 

func (c *Client) SetAccountTelnums(ctx context.Context, in *SetAccountTelnumsInput) (*SetAccountTelnumsOutput, error)

SetAccountTelnums runs the SETACCOUNTTELNUMS command. This command can be used by Domain Administrators only if they have the CanCreateTelnums access right.

func (*Client) SetAccountTemplate added in v0.3.0 

func (c *Client) SetAccountTemplate(ctx context.Context, in *SetAccountTemplateInput) (*SetAccountTemplateOutput, error)

SetAccountTemplate runs the SETACCOUNTTEMPLATE command.

func (*Client) SetAccountType added in v0.3.0 

func (c *Client) SetAccountType(ctx context.Context, in *SetAccountTypeInput) (*SetAccountTypeOutput, error)

SetAccountType runs the SETACCOUNTTYPE command.

func (*Client) SetBanned added in v0.3.0 

func (c *Client) SetBanned(ctx context.Context, in *SetBannedInput) (*SetBannedOutput, error)

SetBanned runs the SETBANNED command.

func (*Client) SetBlacklistedIPs added in v0.3.0 

func (c *Client) SetBlacklistedIPs(ctx context.Context, in *SetBlacklistedIPsInput) (*SetBlacklistedIPsOutput, error)

SetBlacklistedIPs runs the SETBLACKLISTEDIPS command.

func (*Client) SetClientIPs added in v0.3.0 

func (c *Client) SetClientIPs(ctx context.Context, in *SetClientIPsInput) (*SetClientIPsOutput, error)

SetClientIPs runs the SETCLIENTIPS command.

func (*Client) SetClusterAccountDefaults added in v0.3.0 

func (c *Client) SetClusterAccountDefaults(ctx context.Context, in *SetClusterAccountDefaultsInput) (*SetClusterAccountDefaultsOutput, error)

SetClusterAccountDefaults runs the SETCLUSTERACCOUNTDEFAULTS command.

func (*Client) SetClusterAccountPrefs added in v0.3.0 

func (c *Client) SetClusterAccountPrefs(ctx context.Context, in *SetClusterAccountPrefsInput) (*SetClusterAccountPrefsOutput, error)

SetClusterAccountPrefs runs the SETCLUSTERACCOUNTPREFS command.

func (*Client) SetClusterAlerts added in v0.3.0 

func (c *Client) SetClusterAlerts(ctx context.Context, in *SetClusterAlertsInput) (*SetClusterAlertsOutput, error)

SetClusterAlerts runs the SETCLUSTERALERTS command.

func (*Client) SetClusterBanned added in v0.3.0 

func (c *Client) SetClusterBanned(ctx context.Context, in *SetClusterBannedInput) (*SetClusterBannedOutput, error)

SetClusterBanned runs the SETCLUSTERBANNED command.

func (*Client) SetClusterBlacklistedIPs added in v0.3.0 

func (c *Client) SetClusterBlacklistedIPs(ctx context.Context, in *SetClusterBlacklistedIPsInput) (*SetClusterBlacklistedIPsOutput, error)

SetClusterBlacklistedIPs runs the SETCLUSTERBLACKLISTEDIPS command.

func (*Client) SetClusterClientIPs added in v0.3.0 

func (c *Client) SetClusterClientIPs(ctx context.Context, in *SetClusterClientIPsInput) (*SetClusterClientIPsOutput, error)

SetClusterClientIPs runs the SETCLUSTERCLIENTIPS command.

func (*Client) SetClusterDebugIPs added in v0.3.0 

func (c *Client) SetClusterDebugIPs(ctx context.Context, in *SetClusterDebugIPsInput) (*SetClusterDebugIPsOutput, error)

SetClusterDebugIPs runs the SETCLUSTERDEBUGIPS command.

func (*Client) SetClusterDeniedIPs added in v0.3.0 

func (c *Client) SetClusterDeniedIPs(ctx context.Context, in *SetClusterDeniedIPsInput) (*SetClusterDeniedIPsOutput, error)

SetClusterDeniedIPs runs the SETCLUSTERDENIEDIPS command.

func (*Client) SetClusterDirectoryIntegration added in v0.3.0 

func (c *Client) SetClusterDirectoryIntegration(ctx context.Context, in *SetClusterDirectoryIntegrationInput) (*SetClusterDirectoryIntegrationOutput, error)

SetClusterDirectoryIntegration runs the SETCLUSTERDIRECTORYINTEGRATION command.

func (*Client) SetClusterDomainDefaults added in v0.3.0 

func (c *Client) SetClusterDomainDefaults(ctx context.Context, in *SetClusterDomainDefaultsInput) (*SetClusterDomainDefaultsOutput, error)

SetClusterDomainDefaults runs the SETCLUSTERDOMAINDEFAULTS command.

func (*Client) SetClusterIntercept added in v0.3.0 

func (c *Client) SetClusterIntercept(ctx context.Context, in *SetClusterInterceptInput) (*SetClusterInterceptOutput, error)

SetClusterIntercept runs the SETCLUSTERINTERCEPT command.

func (*Client) SetClusterLANIPs added in v0.3.0 

func (c *Client) SetClusterLANIPs(ctx context.Context, in *SetClusterLANIPsInput) (*SetClusterLANIPsOutput, error)

SetClusterLANIPs runs the SETCLUSTERLANIPS command.

func (*Client) SetClusterMailRules added in v0.3.0 

func (c *Client) SetClusterMailRules(ctx context.Context, in *SetClusterMailRulesInput) (*SetClusterMailRulesOutput, error)

SetClusterMailRules runs the SETCLUSTERMAILRULES command.

func (*Client) SetClusterNATSiteIPs added in v0.3.0 

func (c *Client) SetClusterNATSiteIPs(ctx context.Context, in *SetClusterNATSiteIPsInput) (*SetClusterNATSiteIPsOutput, error)

SetClusterNATSiteIPs runs the SETCLUSTERNATSITEIPS command.

func (*Client) SetClusterNATedIPs added in v0.3.0 

func (c *Client) SetClusterNATedIPs(ctx context.Context, in *SetClusterNATedIPsInput) (*SetClusterNATedIPsOutput, error)

SetClusterNATedIPs runs the SETCLUSTERNATEDIPS command.

func (*Client) SetClusterNetwork added in v0.3.0 

func (c *Client) SetClusterNetwork(ctx context.Context, in *SetClusterNetworkInput) (*SetClusterNetworkOutput, error)

SetClusterNetwork runs the SETCLUSTERNETWORK command.

func (*Client) SetClusterProxyIPs added in v0.3.0 

func (c *Client) SetClusterProxyIPs(ctx context.Context, in *SetClusterProxyIPsInput) (*SetClusterProxyIPsOutput, error)

SetClusterProxyIPs runs the SETCLUSTERPROXYIPS command.

func (*Client) SetClusterRouterSettings added in v0.3.0 

func (c *Client) SetClusterRouterSettings(ctx context.Context, in *SetClusterRouterSettingsInput) (*SetClusterRouterSettingsOutput, error)

SetClusterRouterSettings runs the SETCLUSTERROUTERSETTINGS command.

func (*Client) SetClusterRouterTable added in v0.3.0 

func (c *Client) SetClusterRouterTable(ctx context.Context, in *SetClusterRouterTableInput) (*SetClusterRouterTableOutput, error)

SetClusterRouterTable runs the SETCLUSTERROUTERTABLE command.

func (*Client) SetClusterSettings added in v0.3.0 

func (c *Client) SetClusterSettings(ctx context.Context, in *SetClusterSettingsInput) (*SetClusterSettingsOutput, error)

SetClusterSettings runs the SETCLUSTERSETTINGS command.

func (*Client) SetClusterSignalRules added in v0.3.0 

func (c *Client) SetClusterSignalRules(ctx context.Context, in *SetClusterSignalRulesInput) (*SetClusterSignalRulesOutput, error)

SetClusterSignalRules runs the SETCLUSTERSIGNALRULES command.

func (*Client) SetClusterTrustedCerts added in v0.3.0 

func (c *Client) SetClusterTrustedCerts(ctx context.Context, in *SetClusterTrustedCertsInput) (*SetClusterTrustedCertsOutput, error)

SetClusterTrustedCerts runs the SETCLUSTERTRUSTEDCERTS command.

func (*Client) SetClusterWhiteHoleIPs added in v0.3.0 

func (c *Client) SetClusterWhiteHoleIPs(ctx context.Context, in *SetClusterWhiteHoleIPsInput) (*SetClusterWhiteHoleIPsOutput, error)

SetClusterWhiteHoleIPs runs the SETCLUSTERWHITEHOLEIPS command.

func (*Client) SetDNRSettings added in v0.3.0 

func (c *Client) SetDNRSettings(ctx context.Context, in *SetDNRSettingsInput) (*SetDNRSettingsOutput, error)

SetDNRSettings runs the SETDNRSETTINGS command.

func (*Client) SetDebugIPs added in v0.3.0 

func (c *Client) SetDebugIPs(ctx context.Context, in *SetDebugIPsInput) (*SetDebugIPsOutput, error)

SetDebugIPs runs the SETDEBUGIPS command.

func (*Client) SetDeniedIPs added in v0.3.0 

func (c *Client) SetDeniedIPs(ctx context.Context, in *SetDeniedIPsInput) (*SetDeniedIPsOutput, error)

SetDeniedIPs runs the SETDENIEDIPS command.

func (*Client) SetDirectoryAccessRights added in v0.3.0 

func (c *Client) SetDirectoryAccessRights(ctx context.Context, in *SetDirectoryAccessRightsInput) (*SetDirectoryAccessRightsOutput, error)

SetDirectoryAccessRights runs the SETDIRECTORYACCESSRIGHTS command.

func (*Client) SetDirectoryIntegration added in v0.3.0 

func (c *Client) SetDirectoryIntegration(ctx context.Context, in *SetDirectoryIntegrationInput) (*SetDirectoryIntegrationOutput, error)

SetDirectoryIntegration runs the SETDIRECTORYINTEGRATION command.

func (*Client) SetDirectoryUnit added in v0.3.0 

func (c *Client) SetDirectoryUnit(ctx context.Context, in *SetDirectoryUnitInput) (*SetDirectoryUnitOutput, error)

SetDirectoryUnit runs the SETDIRECTORYUNIT command.

func (*Client) SetDomainAlerts added in v0.3.0 

func (c *Client) SetDomainAlerts(ctx context.Context, in *SetDomainAlertsInput) (*SetDomainAlertsOutput, error)

SetDomainAlerts runs the SETDOMAINALERTS command.

func (*Client) SetDomainAliases added in v0.3.0 

func (c *Client) SetDomainAliases(ctx context.Context, in *SetDomainAliasesInput) (*SetDomainAliasesOutput, error)

SetDomainAliases runs the SETDOMAINALIASES command.

func (*Client) SetDomainDefaults added in v0.3.0 

func (c *Client) SetDomainDefaults(ctx context.Context, in *SetDomainDefaultsInput) (*SetDomainDefaultsOutput, error)

SetDomainDefaults runs the SETDOMAINDEFAULTS command.

func (*Client) SetDomainFreeBusy added in v0.3.0 

func (c *Client) SetDomainFreeBusy(ctx context.Context, in *SetDomainFreeBusyInput) (*SetDomainFreeBusyOutput, error)

SetDomainFreeBusy runs the SETDOMAINFREEBUSY command.

func (*Client) SetDomainMailRules added in v0.3.0 

func (c *Client) SetDomainMailRules(ctx context.Context, in *SetDomainMailRulesInput) (*SetDomainMailRulesOutput, error)

SetDomainMailRules runs the SETDOMAINMAILRULES command. This command can be used by Domain Administrators only if they have the RulesAllowed access right.

func (*Client) SetDomainPluginsSettings added in v0.3.0 

func (c *Client) SetDomainPluginsSettings(ctx context.Context, in *SetDomainPluginsSettingsInput) (*SetDomainPluginsSettingsOutput, error)

SetDomainPluginsSettings runs the SETDOMAINPLUGINSSETTINGS command.

func (*Client) SetDomainSettings added in v0.3.0 

func (c *Client) SetDomainSettings(ctx context.Context, in *SetDomainSettingsInput) (*SetDomainSettingsOutput, error)

SetDomainSettings runs the SETDOMAINSETTINGS command.

func (*Client) SetDomainSignalRules added in v0.3.0 

func (c *Client) SetDomainSignalRules(ctx context.Context, in *SetDomainSignalRulesInput) (*SetDomainSignalRulesOutput, error)

SetDomainSignalRules runs the SETDOMAINSIGNALRULES command. This command can be used by Domain Administrators only if they have the SignalRulesAllowed access right.

func (*Client) SetFileSubscription added in v0.3.0 

func (c *Client) SetFileSubscription(ctx context.Context, in *SetFileSubscriptionInput) (*SetFileSubscriptionOutput, error)

SetFileSubscription runs the SETFILESUBSCRIPTION command.

func (*Client) SetGroup added in v0.3.0 

func (c *Client) SetGroup(ctx context.Context, in *SetGroupInput) (*SetGroupOutput, error)

SetGroup runs the SETGROUP command.

func (*Client) SetLANIPs added in v0.3.0 

func (c *Client) SetLANIPs(ctx context.Context, in *SetLANIPsInput) (*SetLANIPsOutput, error)

SetLANIPs runs the SETLANIPS command.

func (*Client) SetListSubscription added in v0.3.0 

func (c *Client) SetListSubscription(ctx context.Context, in *SetListSubscriptionInput) (*SetListSubscriptionOutput, error)

SetListSubscription runs the bare LIST command - a distinct CLI verb from LISTLISTS/LISTSUBSCRIBERS/etc despite the shared name - to update one subscriber's standing on a mailing list. Sample wire line (from CLI.html): LIST MyList@mydomain.com FEED confirm "Bill Jones" <BJones@company.com>

func (*Client) SetLogAll added in v0.3.0 

func (c *Client) SetLogAll(ctx context.Context, in *SetLogAllInput) (*SetLogAllOutput, error)

SetLogAll runs the SETLOGALL command. A nil Input is allowed - every field is optional.

func (*Client) SetMailboxACL added in v0.3.0 

func (c *Client) SetMailboxACL(ctx context.Context, in *SetMailboxACLInput) (*SetMailboxACLOutput, error)

SetMailboxACL runs the SETMAILBOXACL command.

func (*Client) SetMailboxAliases added in v0.3.0 

func (c *Client) SetMailboxAliases(ctx context.Context, in *SetMailboxAliasesInput) (*SetMailboxAliasesOutput, error)

SetMailboxAliases runs the SETMAILBOXALIASES command.

func (*Client) SetMailboxAliasesUTF8 added in v0.3.0 

func (c *Client) SetMailboxAliasesUTF8(ctx context.Context, in *SetMailboxAliasesUTF8Input) (*SetMailboxAliasesUTF8Output, error)

SetMailboxAliasesUTF8 runs the SETMAILBOXALIASESUTF8 command - identical to SetMailboxAliases, except it expects UTF-8-encoded values in AccountName and NewAliases.

func (*Client) SetMailboxClass added in v0.3.0 

func (c *Client) SetMailboxClass(ctx context.Context, in *SetMailboxClassInput) (*SetMailboxClassOutput, error)

SetMailboxClass runs the SETMAILBOXCLASS command.

func (*Client) SetMailboxSubscription added in v0.3.0 

func (c *Client) SetMailboxSubscription(ctx context.Context, in *SetMailboxSubscriptionInput) (*SetMailboxSubscriptionOutput, error)

SetMailboxSubscription runs the SETMAILBOXSUBSCRIPTION command.

func (*Client) SetMailboxSubscriptionUTF8 added in v0.3.0 

func (c *Client) SetMailboxSubscriptionUTF8(ctx context.Context, in *SetMailboxSubscriptionUTF8Input) (*SetMailboxSubscriptionUTF8Output, error)

SetMailboxSubscriptionUTF8 runs the SETMAILBOXSUBSCRIPTIONUTF8 command - identical to SetMailboxSubscription, except it expects UTF-8-encoded Mailbox names.

func (*Client) SetMediaServerSettings added in v0.3.0 

func (c *Client) SetMediaServerSettings(ctx context.Context, in *SetMediaServerSettingsInput) (*SetMediaServerSettingsOutput, error)

SetMediaServerSettings runs the SETMEDIASERVERSETTINGS command.

func (*Client) SetModule added in v0.3.0 

func (c *Client) SetModule(ctx context.Context, in *SetModuleInput) (*SetModuleOutput, error)

SetModule runs the SETMODULE command.

func (*Client) SetNATSiteIPs added in v0.3.0 

func (c *Client) SetNATSiteIPs(ctx context.Context, in *SetNATSiteIPsInput) (*SetNATSiteIPsOutput, error)

SetNATSiteIPs runs the SETNATSITEIPS command.

func (*Client) SetNATedIPs added in v0.3.0 

func (c *Client) SetNATedIPs(ctx context.Context, in *SetNATedIPsInput) (*SetNATedIPsOutput, error)

SetNATedIPs runs the SETNATEDIPS command.

func (*Client) SetNetwork added in v0.3.0 

func (c *Client) SetNetwork(ctx context.Context, in *SetNetworkInput) (*SetNetworkOutput, error)

SetNetwork runs the SETNETWORK command.

func (*Client) SetPostingMode added in v0.3.0 

func (c *Client) SetPostingMode(ctx context.Context, in *SetPostingModeInput) (*SetPostingModeOutput, error)

SetPostingMode runs the SETPOSTINGMODE command.

func (*Client) SetProxyIPs added in v0.3.0 

func (c *Client) SetProxyIPs(ctx context.Context, in *SetProxyIPsInput) (*SetProxyIPsOutput, error)

SetProxyIPs runs the SETPROXYIPS command.

func (*Client) SetQueueSettings added in v0.3.0 

func (c *Client) SetQueueSettings(ctx context.Context, in *SetQueueSettingsInput) (*SetQueueSettingsOutput, error)

SetQueueSettings runs the SETQUEUESETTINGS command.

func (*Client) SetRouterSettings added in v0.3.0 

func (c *Client) SetRouterSettings(ctx context.Context, in *SetRouterSettingsInput) (*SetRouterSettingsOutput, error)

SetRouterSettings runs the SETROUTERSETTINGS command.

func (*Client) SetRouterTable added in v0.3.0 

func (c *Client) SetRouterTable(ctx context.Context, in *SetRouterTableInput) (*SetRouterTableOutput, error)

SetRouterTable runs the SETROUTERTABLE command.

func (*Client) SetServerAccountDefaults added in v0.3.0 

func (c *Client) SetServerAccountDefaults(ctx context.Context, in *SetServerAccountDefaultsInput) (*SetServerAccountDefaultsOutput, error)

SetServerAccountDefaults runs the SETSERVERACCOUNTDEFAULTS command.

func (*Client) SetServerAccountPrefs added in v0.3.0 

func (c *Client) SetServerAccountPrefs(ctx context.Context, in *SetServerAccountPrefsInput) (*SetServerAccountPrefsOutput, error)

SetServerAccountPrefs runs the SETSERVERACCOUNTPREFS command.

func (*Client) SetServerAlerts added in v0.3.0 

func (c *Client) SetServerAlerts(ctx context.Context, in *SetServerAlertsInput) (*SetServerAlertsOutput, error)

SetServerAlerts runs the SETSERVERALERTS command.

func (*Client) SetServerIntercept added in v0.3.0 

func (c *Client) SetServerIntercept(ctx context.Context, in *SetServerInterceptInput) (*SetServerInterceptOutput, error)

SetServerIntercept runs the SETSERVERINTERCEPT command.

func (*Client) SetServerMailRules added in v0.3.0 

func (c *Client) SetServerMailRules(ctx context.Context, in *SetServerMailRulesInput) (*SetServerMailRulesOutput, error)

SetServerMailRules runs the SETSERVERMAILRULES command.

func (*Client) SetServerSignalRules added in v0.3.0 

func (c *Client) SetServerSignalRules(ctx context.Context, in *SetServerSignalRulesInput) (*SetServerSignalRulesOutput, error)

SetServerSignalRules runs the SETSERVERSIGNALRULES command.

func (*Client) SetServerTrustedCerts added in v0.3.0 

func (c *Client) SetServerTrustedCerts(ctx context.Context, in *SetServerTrustedCertsInput) (*SetServerTrustedCertsOutput, error)

SetServerTrustedCerts runs the SETSERVERTRUSTEDCERTS command.

func (*Client) SetSessionSettings added in v0.3.0 

func (c *Client) SetSessionSettings(ctx context.Context, in *SetSessionSettingsInput) (*SetSessionSettingsOutput, error)

SetSessionSettings runs the SETSESSIONSETTINGS command.

func (*Client) SetSignalSettings added in v0.3.0 

func (c *Client) SetSignalSettings(ctx context.Context, in *SetSignalSettingsInput) (*SetSignalSettingsOutput, error)

SetSignalSettings runs the SETSIGNALSETTINGS command.

func (*Client) SetStatElement added in v0.3.0 

func (c *Client) SetStatElement(ctx context.Context, in *SetStatElementInput) (*SetStatElementOutput, error)

SetStatElement runs the SETSTATELEMENT command.

func (*Client) SetTempBlacklistedIPs added in v0.3.0 

func (c *Client) SetTempBlacklistedIPs(ctx context.Context, in *SetTempBlacklistedIPsInput) (*SetTempBlacklistedIPsOutput, error)

SetTempBlacklistedIPs runs the SETTEMPBLACKLISTEDIPS command.

func (*Client) SetTempUnblockableIPs added in v0.3.0 

func (c *Client) SetTempUnblockableIPs(ctx context.Context, in *SetTempUnblockableIPsInput) (*SetTempUnblockableIPsOutput, error)

SetTempUnblockableIPs runs the SETTEMPUNBLOCKABLEIPS command.

func (*Client) SetTotpSecret added in v0.3.0 

func (c *Client) SetTotpSecret(ctx context.Context, in *SetTotpSecretInput) (*SetTotpSecretOutput, error)

SetTotpSecret runs the SETTOTPSECRET command.

func (*Client) SetTrace added in v0.3.0 

func (c *Client) SetTrace(ctx context.Context, in *SetTraceInput) (*SetTraceOutput, error)

SetTrace runs the SETTRACE command.

func (*Client) SetWhiteHoleIPs added in v0.3.0 

func (c *Client) SetWhiteHoleIPs(ctx context.Context, in *SetWhiteHoleIPsInput) (*SetWhiteHoleIPsOutput, error)

SetWhiteHoleIPs runs the SETWHITEHOLEIPS command.

func (*Client) Shutdown added in v0.3.0 

func (c *Client) Shutdown(ctx context.Context, in *ShutdownInput) (*ShutdownOutput, error)

Shutdown runs the SHUTDOWN command, stopping the Server. A nil Input is allowed - the command takes no parameters. Calling this against a real Server is destructive: it terminates the Server process.

func (*Client) StartPBXTask added in v0.3.0 

func (c *Client) StartPBXTask(ctx context.Context, in *StartPBXTaskInput) (*StartPBXTaskOutput, error)

StartPBXTask runs the STARTPBXTASK command.

func (*Client) StoreClusterPBXFile added in v0.3.0 

func (c *Client) StoreClusterPBXFile(ctx context.Context, in *StoreClusterPBXFileInput) (*StoreClusterPBXFileOutput, error)

StoreClusterPBXFile runs the STORECLUSTERPBXFILE ... DATA command.

func (*Client) StoreClusterSkinFile added in v0.3.0 

func (c *Client) StoreClusterSkinFile(ctx context.Context, in *StoreClusterSkinFileInput) (*StoreClusterSkinFileOutput, error)

StoreClusterSkinFile runs the STORECLUSTERSKINFILE ... DATA command.

func (*Client) StoreDomainPBXFile added in v0.3.0 

func (c *Client) StoreDomainPBXFile(ctx context.Context, in *StoreDomainPBXFileInput) (*StoreDomainPBXFileOutput, error)

StoreDomainPBXFile runs the STOREDOMAINPBXFILE ... DATA command.

func (*Client) StoreDomainSkinFile added in v0.2.0 

func (c *Client) StoreDomainSkinFile(ctx context.Context, in *StoreDomainSkinFileInput) (*StoreDomainSkinFileOutput, error)

StoreDomainSkinFile runs the STOREDOMAINSKINFILE ... DATA command.

func (*Client) StoreServerPBXFile added in v0.3.0 

func (c *Client) StoreServerPBXFile(ctx context.Context, in *StoreServerPBXFileInput) (*StoreServerPBXFileOutput, error)

StoreServerPBXFile runs the STORESERVERPBXFILE ... DATA command.

func (*Client) StoreServerSkinFile added in v0.3.0 

func (c *Client) StoreServerSkinFile(ctx context.Context, in *StoreServerSkinFileInput) (*StoreServerSkinFileOutput, error)

StoreServerSkinFile runs the STORESERVERSKINFILE ... DATA command.

func (*Client) SuspendDomain added in v0.3.0 

func (c *Client) SuspendDomain(ctx context.Context, in *SuspendDomainInput) (*SuspendDomainOutput, error)

SuspendDomain runs the SUSPENDDOMAIN command.

func (*Client) TempBlacklistIP added in v0.3.0 

func (c *Client) TempBlacklistIP(ctx context.Context, in *TempBlacklistIPInput) (*TempBlacklistIPOutput, error)

TempBlacklistIP runs the TEMPBLACKLISTIP command.

func (*Client) TempUnblockIP added in v0.3.0 

func (c *Client) TempUnblockIP(ctx context.Context, in *TempUnblockIPInput) (*TempUnblockIPOutput, error)

TempUnblockIP runs the TEMPUNBLOCKIP command.

func (*Client) TestLoop added in v0.3.0 

func (c *Client) TestLoop(ctx context.Context, in *TestLoopInput) (*TestLoopOutput, error)

TestLoop runs the TESTLOOP command.

func (*Client) UnblockAccount added in v0.3.0 

func (c *Client) UnblockAccount(ctx context.Context, in *UnblockAccountInput) (*UnblockAccountOutput, error)

UnblockAccount runs the UNBLOCKACCOUNT command.

func (*Client) UpdateAccountDefaultPrefs added in v0.3.0 

func (c *Client) UpdateAccountDefaultPrefs(ctx context.Context, in *UpdateAccountDefaultPrefsInput) (*UpdateAccountDefaultPrefsOutput, error)

UpdateAccountDefaultPrefs runs the UPDATEACCOUNTDEFAULTPREFS command. This command can be used by Domain Administrators only if they have the WebUserSettings access right.

func (*Client) UpdateAccountDefaults added in v0.3.0 

func (c *Client) UpdateAccountDefaults(ctx context.Context, in *UpdateAccountDefaultsInput) (*UpdateAccountDefaultsOutput, error)

UpdateAccountDefaults runs the UPDATEACCOUNTDEFAULTS command.

func (*Client) UpdateAccountMailRule added in v0.3.0 

func (c *Client) UpdateAccountMailRule(ctx context.Context, in *UpdateAccountMailRuleInput) (*UpdateAccountMailRuleOutput, error)

UpdateAccountMailRule runs the newRule form of the UPDATEACCOUNTMAILRULE command. This command can be used by Domain Administrators only if they have the RulesAllowed access right, and by any Account user to modify their own Rules.

func (*Client) UpdateAccountPrefs added in v0.3.0 

func (c *Client) UpdateAccountPrefs(ctx context.Context, in *UpdateAccountPrefsInput) (*UpdateAccountPrefsOutput, error)

UpdateAccountPrefs runs the UPDATEACCOUNTPREFS command. This command can be used by Domain Administrators only if they have the WebUserSettings access right.

func (*Client) UpdateAccountSettings 

func (c *Client) UpdateAccountSettings(ctx context.Context, in *UpdateAccountSettingsInput) (*UpdateAccountSettingsOutput, error)

UpdateAccountSettings runs the UPDATEACCOUNTSETTINGS command.

func (*Client) UpdateAccountSignalRule added in v0.3.0 

func (c *Client) UpdateAccountSignalRule(ctx context.Context, in *UpdateAccountSignalRuleInput) (*UpdateAccountSignalRuleOutput, error)

UpdateAccountSignalRule runs the newRule form of the UPDATEACCOUNTSIGNALRULE command. This command can be used by Domain Administrators only if they have the SignalRulesAllowed access right.

func (*Client) UpdateAccountTemplate added in v0.3.0 

func (c *Client) UpdateAccountTemplate(ctx context.Context, in *UpdateAccountTemplateInput) (*UpdateAccountTemplateOutput, error)

UpdateAccountTemplate runs the UPDATEACCOUNTTEMPLATE command.

func (*Client) UpdateClusterAccountDefaults added in v0.3.0 

func (c *Client) UpdateClusterAccountDefaults(ctx context.Context, in *UpdateClusterAccountDefaultsInput) (*UpdateClusterAccountDefaultsOutput, error)

UpdateClusterAccountDefaults runs the UPDATECLUSTERACCOUNTDEFAULTS command.

func (*Client) UpdateClusterAccountPrefs added in v0.3.0 

func (c *Client) UpdateClusterAccountPrefs(ctx context.Context, in *UpdateClusterAccountPrefsInput) (*UpdateClusterAccountPrefsOutput, error)

UpdateClusterAccountPrefs runs the UPDATECLUSTERACCOUNTPREFS command.

func (*Client) UpdateClusterDomainDefaults added in v0.3.0 

func (c *Client) UpdateClusterDomainDefaults(ctx context.Context, in *UpdateClusterDomainDefaultsInput) (*UpdateClusterDomainDefaultsOutput, error)

UpdateClusterDomainDefaults runs the UPDATECLUSTERDOMAINDEFAULTS command.

func (*Client) UpdateDomainDefaults added in v0.3.0 

func (c *Client) UpdateDomainDefaults(ctx context.Context, in *UpdateDomainDefaultsInput) (*UpdateDomainDefaultsOutput, error)

UpdateDomainDefaults runs the UPDATEDOMAINDEFAULTS command.

func (*Client) UpdateDomainSettings added in v0.2.0 

func (c *Client) UpdateDomainSettings(ctx context.Context, in *UpdateDomainSettingsInput) (*UpdateDomainSettingsOutput, error)

UpdateDomainSettings runs the UPDATEDOMAINSETTINGS command.

func (*Client) UpdateList added in v0.3.0 

func (c *Client) UpdateList(ctx context.Context, in *UpdateListInput) (*UpdateListOutput, error)

UpdateList runs the UPDATELIST command.

func (*Client) UpdateLogSettings added in v0.3.0 

func (c *Client) UpdateLogSettings(ctx context.Context, in *UpdateLogSettingsInput) (*UpdateLogSettingsOutput, error)

UpdateLogSettings runs the UPDATELOGSETTINGS command.

func (*Client) UpdateModule added in v0.3.0 

func (c *Client) UpdateModule(ctx context.Context, in *UpdateModuleInput) (*UpdateModuleOutput, error)

UpdateModule runs the UPDATEMODULE command.

func (*Client) UpdateNamedTask added in v0.3.0 

func (c *Client) UpdateNamedTask(ctx context.Context, in *UpdateNamedTaskInput) (*UpdateNamedTaskOutput, error)

UpdateNamedTask runs the UPDATENAMEDTASK command.

func (*Client) UpdateScheduledTask added in v0.3.0 

func (c *Client) UpdateScheduledTask(ctx context.Context, in *UpdateScheduledTaskInput) (*UpdateScheduledTaskOutput, error)

UpdateScheduledTask runs the UPDATESCHEDULEDTASK command. This command can be used by Domain Administrators with the CanModifyRSIP access right for the target Account.

func (*Client) UpdateServerAccountDefaults added in v0.3.0 

func (c *Client) UpdateServerAccountDefaults(ctx context.Context, in *UpdateServerAccountDefaultsInput) (*UpdateServerAccountDefaultsOutput, error)

UpdateServerAccountDefaults runs the UPDATESERVERACCOUNTDEFAULTS command.

func (*Client) UpdateServerAccountPrefs added in v0.3.0 

func (c *Client) UpdateServerAccountPrefs(ctx context.Context, in *UpdateServerAccountPrefsInput) (*UpdateServerAccountPrefsOutput, error)

UpdateServerAccountPrefs runs the UPDATESERVERACCOUNTPREFS command.

func (*Client) UpdateServerSettings added in v0.3.0 

func (c *Client) UpdateServerSettings(ctx context.Context, in *UpdateServerSettingsInput) (*UpdateServerSettingsOutput, error)

UpdateServerSettings runs the UPDATESERVERSETTINGS command.

func (*Client) UpdateSession added in v0.3.0 

func (c *Client) UpdateSession(ctx context.Context, in *UpdateSessionInput) (*UpdateSessionOutput, error)

UpdateSession runs the UPDATESESSION command.

func (*Client) UpdateStorageFileAttr added in v0.3.0 

func (c *Client) UpdateStorageFileAttr(ctx context.Context, in *UpdateStorageFileAttrInput) (*UpdateStorageFileAttrOutput, error)

UpdateStorageFileAttr runs the UPDATESTORAGEFILEATTR command.

func (*Client) UploadPluginFile added in v0.3.0 

func (c *Client) UploadPluginFile(ctx context.Context, in *UploadPluginFileInput) (*UploadPluginFileOutput, error)

UploadPluginFile runs the UPLOADPLUGINFILE command. The plugin is installed unless Input.DryRun is set, in which case only the extension/format check is performed.

func (*Client) VerifyAccountIdentity added in v0.3.0 

func (c *Client) VerifyAccountIdentity(ctx context.Context, in *VerifyAccountIdentityInput) (*VerifyAccountIdentityOutput, error)

VerifyAccountIdentity runs the VERIFYACCOUNTIDENTITY command; a non-nil error (typically a *ResponseError) means identity is not allowed.

func (*Client) VerifyAccountPassword 

func (c *Client) VerifyAccountPassword(ctx context.Context, in *VerifyAccountPasswordInput) (*VerifyAccountPasswordOutput, error)

VerifyAccountPassword runs the VERIFYACCOUNTPASSWORD command; a non-nil error (typically a *ResponseError) means the password did not verify.

func (*Client) WriteLog added in v0.3.0 

func (c *Client) WriteLog(ctx context.Context, in *WriteLogInput) (*WriteLogOutput, error)

WriteLog runs the WRITELOG command.

func (*Client) WriteStorageFile added in v0.2.0 

func (c *Client) WriteStorageFile(ctx context.Context, in *WriteStorageFileInput) (*WriteStorageFileOutput, error)

WriteStorageFile runs the WRITESTORAGEFILE command.

type CreateAccountInput 

type CreateAccountInput struct {
	AccountName string             // required
	AccountType string             // optional bare keyword, e.g. "MultiMailbox"
	External    bool               // optional
	Settings    cgpdata.Dictionary // optional
}

CreateAccountInput creates a new account.

type CreateAccountOutput 

type CreateAccountOutput struct{}

CreateAccountOutput holds the result of CreateAccount.

type CreateAccountStorageInput added in v0.3.0 

type CreateAccountStorageInput struct {
	DomainName string // required
	Storage    string // required; the "storage mount point" name
}

CreateAccountStorageInput creates an Account "storage mount point" for new Accounts in a domain.

type CreateAccountStorageOutput added in v0.3.0 

type CreateAccountStorageOutput struct{}

CreateAccountStorageOutput holds the result of CreateAccountStorage.

type CreateClusterPBXInput added in v0.3.0 

type CreateClusterPBXInput struct {
	Language string // required
}

CreateClusterPBXInput creates a national subset of the cluster-wide Real-Time Application Environment. Available in the Dynamic Cluster only, to System Administrators.

type CreateClusterPBXOutput added in v0.3.0 

type CreateClusterPBXOutput struct{}

CreateClusterPBXOutput holds the result of CreateClusterPBX.

type CreateClusterSkinInput added in v0.3.0 

type CreateClusterSkinInput struct {
	SkinName string // required
}

CreateClusterSkinInput creates a custom cluster-wide Skin, in place of CREATESERVERSKIN. This command is available in the Dynamic Cluster only.

type CreateClusterSkinOutput added in v0.3.0 

type CreateClusterSkinOutput struct{}

CreateClusterSkinOutput holds the result of CreateClusterSkin.

type CreateDirectoryDomainInput added in v0.3.0 

type CreateDirectoryDomainInput struct {
	DomainName string             // required
	Settings   cgpdata.Dictionary // optional
}

CreateDirectoryDomainInput creates a new directory-based Domain. This operation is allowed only when Directory-based Domains are enabled.

type CreateDirectoryDomainOutput added in v0.3.0 

type CreateDirectoryDomainOutput struct{}

CreateDirectoryDomainOutput holds the result of CreateDirectoryDomain.

type CreateDirectoryUnitInput added in v0.3.0 

type CreateDirectoryUnitInput struct {
	UnitName   string // required
	MountPoint string // required; the new Unit's mount point (mount DN)
	Shared     bool   // optional; if true, creates a cluster-wide Unit
	Remote     bool   // optional; if true, creates a Remote (LDAP-based) Unit instead of a Local (File-based) one
}

CreateDirectoryUnitInput creates a new Directory Unit.

type CreateDirectoryUnitOutput added in v0.3.0 

type CreateDirectoryUnitOutput struct{}

CreateDirectoryUnitOutput holds the result of CreateDirectoryUnit.

type CreateDomainInput added in v0.3.0 

type CreateDomainInput struct {
	DomainName  string             // required
	Shared      bool               // optional: create a Cluster-wide Domain in a Dynamic Cluster
	StoragePath string             // optional; "storage mount point" directory name, without the .mnt suffix
	Settings    cgpdata.Dictionary // optional
}

CreateDomainInput creates a new secondary Domain.

type CreateDomainOutput added in v0.3.0 

type CreateDomainOutput struct{}

CreateDomainOutput holds the result of CreateDomain.

type CreateDomainPBXInput added in v0.3.0 

type CreateDomainPBXInput struct {
	DomainName string // required
	Language   string // optional; a national subset name
}

CreateDomainPBXInput creates the Domain Real-Time Application Environment, or (with Language) one of its national subsets.

type CreateDomainPBXOutput added in v0.3.0 

type CreateDomainPBXOutput struct{}

CreateDomainPBXOutput holds the result of CreateDomainPBX.

type CreateDomainSkinInput added in v0.2.0 

type CreateDomainSkinInput struct {
	DomainName string // optional; empty applies to the administrator Domain
	SkinName   string // "" creates the unnamed Skin
}

CreateDomainSkinInput creates a custom Domain Skin. An empty SkinName creates the unnamed Skin; a named Skin can only be created once the unnamed Skin exists.

type CreateDomainSkinOutput added in v0.2.0 

type CreateDomainSkinOutput struct{}

CreateDomainSkinOutput holds the result of CreateDomainSkin.

type CreateDomainStorageInput added in v0.3.0 

type CreateDomainStorageInput struct {
	StoragePath string // required; "storage mount point" name
	Shared      bool   // optional: create a "storage mount point" for Cluster Domains in a Dynamic Cluster
}

CreateDomainStorageInput creates a "storage mount point" for new Domains.

type CreateDomainStorageOutput added in v0.3.0 

type CreateDomainStorageOutput struct{}

CreateDomainStorageOutput holds the result of CreateDomainStorage.

type CreateForwarderInput added in v0.3.0 

type CreateForwarderInput struct {
	ForwarderName string // required
	Address       string // required
}

CreateForwarderInput creates a new Forwarder that reroutes E-mail messages and Signals to Address.

type CreateForwarderOutput added in v0.3.0 

type CreateForwarderOutput struct{}

CreateForwarderOutput holds the result of CreateForwarder.

type CreateGroupInput added in v0.3.0 

type CreateGroupInput struct {
	GroupName string             // required; may include "@domain" to create in a specific Domain
	Settings  cgpdata.Dictionary // optional: initial settings and members list
}

CreateGroupInput creates a new Group.

type CreateGroupOutput added in v0.3.0 

type CreateGroupOutput struct{}

CreateGroupOutput holds the result of CreateGroup.

type CreateListInput added in v0.3.0 

type CreateListInput struct {
	ListName    string // required; may include the Domain name
	AccountName string // required; the owner Account, without the Domain name; "*" names the current authenticated Account
}

CreateListInput creates a mailing list owned by an existing Account.

type CreateListOutput added in v0.3.0 

type CreateListOutput struct{}

CreateListOutput holds the result of CreateList.

type CreateLiteSessionInput added in v0.3.0 

type CreateLiteSessionInput struct {
	IPAddress   string // required
	OrigAddress string // optional
}

CreateLiteSessionInput creates a LITE session.

type CreateLiteSessionOutput added in v0.3.0 

type CreateLiteSessionOutput struct {
	SessionID string
}

CreateLiteSessionOutput holds the result of CreateLiteSession.

type CreateMailboxInput added in v0.3.0 

type CreateMailboxInput struct {
	AccountName     string // required; "*" names the current authenticated Account
	MailboxName     string // required
	Class           string // optional: the Mailbox class for the new Mailbox
	AuthAccountName string // optional: run the command on behalf of this Account
}

CreateMailboxInput creates a Mailbox in an Account.

type CreateMailboxOutput added in v0.3.0 

type CreateMailboxOutput struct{}

CreateMailboxOutput holds the result of CreateMailbox.

type CreateNamedTaskInput added in v0.3.0 

type CreateNamedTaskInput struct {
	TaskName    string // required; may include "@domainName" to create it in a specific Domain
	AccountName string // required; the owner Account, in the same Domain as TaskName; "*" names the current authenticated Account
}

CreateNamedTaskInput creates a new Named Task.

type CreateNamedTaskOutput added in v0.3.0 

type CreateNamedTaskOutput struct{}

CreateNamedTaskOutput holds the result of CreateNamedTask.

type CreateServerPBXInput added in v0.3.0 

type CreateServerPBXInput struct {
	Language string // required
}

CreateServerPBXInput creates a national subset of the Server-wide Real-Time Application Environment. Available to System Administrators only.

type CreateServerPBXOutput added in v0.3.0 

type CreateServerPBXOutput struct{}

CreateServerPBXOutput holds the result of CreateServerPBX.

type CreateServerSkinInput added in v0.3.0 

type CreateServerSkinInput struct {
	SkinName string // required
}

CreateServerSkinInput creates a custom Server Skin.

type CreateServerSkinOutput added in v0.3.0 

type CreateServerSkinOutput struct{}

CreateServerSkinOutput holds the result of CreateServerSkin.

type CreateWebUserSessionInput added in v0.3.0 

type CreateWebUserSessionInput struct {
	AccountName string // required; "*" names the current authenticated Account
	IPAddress   string // required; the client browser's IP address (and port)
	OrigAddress string // optional; the client browser's original address, if connecting via a proxy
	Skin        string // optional; the Skin to use for the new session
}

CreateWebUserSessionInput creates a WebUser session for an Account.

type CreateWebUserSessionOutput added in v0.3.0 

type CreateWebUserSessionOutput struct {
	SessionID string
}

CreateWebUserSessionOutput holds the result of CreateWebUserSession.

type CreateXIMSSSessionInput added in v0.3.0 

type CreateXIMSSSessionInput struct {
	AccountName string // required; "*" names the current authenticated Account
	IPAddress   string // required
	OrigAddress string // optional
}

CreateXIMSSSessionInput creates a XIMSS session for an Account.

type CreateXIMSSSessionOutput added in v0.3.0 

type CreateXIMSSSessionOutput struct {
	SessionID string
}

CreateXIMSSSessionOutput holds the result of CreateXIMSSSession.

type DatasetInput added in v0.3.0 

type DatasetInput struct {
	AccountName string             // required; "*" names the current authenticated Account
	Parameters  cgpdata.Dictionary // required
}

DatasetInput manages an Account "dataset" - a named collection of addressbook-style entries such as RepliedAddresses. Parameters must contain a `subsetName` string element naming the target dataset (or dataset subset; the empty string names the top-level dataset list) and a `what` string element naming the operation to apply: `listSubsets`, `createSet`, `removeSet`, `listEntries`, `setEntry`, `deleteEntry`, `addRandomEntry`, `addAddress`, or `findAddress`. Every other Parameters element is operation-specific; see https://doc.communigatepro.ru/development/CLI.html#DATASET for the full per-operation reference.

type DatasetOutput added in v0.3.0 

type DatasetOutput struct {
	Result cgpdata.Dictionary
}

DatasetOutput holds the result of Dataset: the operation results, shaped differently per Input.Parameters["what"] (see DatasetInput).

type DeleteAccountInput 

type DeleteAccountInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

DeleteAccountInput deletes an account.

type DeleteAccountMailRuleInput added in v0.3.0 

type DeleteAccountMailRuleInput struct {
	AccountName string // required; "*" names the current authenticated Account
	RuleName    string // required
}

DeleteAccountMailRuleInput removes a single named Account Queue Rule.

type DeleteAccountMailRuleOutput added in v0.3.0 

type DeleteAccountMailRuleOutput struct{}

DeleteAccountMailRuleOutput holds the result of DeleteAccountMailRule.

type DeleteAccountOutput 

type DeleteAccountOutput struct{}

DeleteAccountOutput holds the result of DeleteAccount.

type DeleteAccountSignalRuleInput added in v0.3.0 

type DeleteAccountSignalRuleInput struct {
	AccountName string // required; "*" names the current authenticated Account
	RuleName    string // required
}

DeleteAccountSignalRuleInput removes a single named Account Signal Rule.

type DeleteAccountSignalRuleOutput added in v0.3.0 

type DeleteAccountSignalRuleOutput struct{}

DeleteAccountSignalRuleOutput holds the result of DeleteAccountSignalRule.

type DeleteClusterPBXFileInput added in v0.3.0 

type DeleteClusterPBXFileInput struct {
	FileName string // required
}

DeleteClusterPBXFileInput deletes a file from the cluster-wide Real-Time Application Environment. Available in the Dynamic Cluster only, to System Administrators.

type DeleteClusterPBXFileOutput added in v0.3.0 

type DeleteClusterPBXFileOutput struct{}

DeleteClusterPBXFileOutput holds the result of DeleteClusterPBXFile.

type DeleteClusterPBXInput added in v0.3.0 

type DeleteClusterPBXInput struct {
	Language string // required
}

DeleteClusterPBXInput removes a national subset of the cluster-wide Real-Time Application Environment. Available in the Dynamic Cluster only, to System Administrators.

type DeleteClusterPBXOutput added in v0.3.0 

type DeleteClusterPBXOutput struct{}

DeleteClusterPBXOutput holds the result of DeleteClusterPBX.

type DeleteClusterSkinFileInput added in v0.3.0 

type DeleteClusterSkinFileInput struct {
	SkinName string // required
	FileName string // required
}

DeleteClusterSkinFileInput deletes a file from a cluster-wide Skin.

type DeleteClusterSkinFileOutput added in v0.3.0 

type DeleteClusterSkinFileOutput struct{}

DeleteClusterSkinFileOutput holds the result of DeleteClusterSkinFile.

type DeleteClusterSkinInput added in v0.3.0 

type DeleteClusterSkinInput struct {
	SkinName string // required
}

DeleteClusterSkinInput deletes a custom cluster-wide Skin, in place of DELETESERVERSKIN. This command is available in the Dynamic Cluster only.

type DeleteClusterSkinOutput added in v0.3.0 

type DeleteClusterSkinOutput struct{}

DeleteClusterSkinOutput holds the result of DeleteClusterSkin.

type DeleteDirectoryRecordsInput added in v0.3.0 

type DeleteDirectoryRecordsInput struct {
	DomainName string // optional; empty applies to the authenticated user Domain
}

DeleteDirectoryRecordsInput deletes a domain's object records from the Directory.

type DeleteDirectoryRecordsOutput added in v0.3.0 

type DeleteDirectoryRecordsOutput struct{}

DeleteDirectoryRecordsOutput holds the result of DeleteDirectoryRecords.

type DeleteDirectoryUnitInput added in v0.3.0 

type DeleteDirectoryUnitInput struct {
	UnitName string // required
	Shared   bool   // optional; if true, UnitName names a cluster-wide Unit
}

DeleteDirectoryUnitInput removes an existing Directory Unit.

type DeleteDirectoryUnitOutput added in v0.3.0 

type DeleteDirectoryUnitOutput struct{}

DeleteDirectoryUnitOutput holds the result of DeleteDirectoryUnit.

type DeleteDomainInput added in v0.3.0 

type DeleteDomainInput struct {
	DomainName string // required
	Force      bool   // optional: remove the Domain even if it is not empty, deleting every Domain object
}

DeleteDomainInput removes a Domain.

type DeleteDomainOutput added in v0.3.0 

type DeleteDomainOutput struct{}

DeleteDomainOutput holds the result of DeleteDomain.

type DeleteDomainPBXFileInput added in v0.3.0 

type DeleteDomainPBXFileInput struct {
	DomainName string // required
	FileName   string // required
}

DeleteDomainPBXFileInput deletes a file from the Domain Real-Time Application Environment.

type DeleteDomainPBXFileOutput added in v0.3.0 

type DeleteDomainPBXFileOutput struct{}

DeleteDomainPBXFileOutput holds the result of DeleteDomainPBXFile.

type DeleteDomainPBXInput added in v0.3.0 

type DeleteDomainPBXInput struct {
	DomainName string // required
	Language   string // required
}

DeleteDomainPBXInput removes a national subset from the Domain Real-Time Application Environment.

type DeleteDomainPBXOutput added in v0.3.0 

type DeleteDomainPBXOutput struct{}

DeleteDomainPBXOutput holds the result of DeleteDomainPBX.

type DeleteDomainSkinFileInput added in v0.2.0 

type DeleteDomainSkinFileInput struct {
	DomainName string // optional; empty applies to the administrator Domain
	SkinName   string // "" names the unnamed Skin
	FileName   string // required
}

DeleteDomainSkinFileInput deletes a file from a custom Domain Skin.

type DeleteDomainSkinFileOutput added in v0.2.0 

type DeleteDomainSkinFileOutput struct{}

DeleteDomainSkinFileOutput holds the result of DeleteDomainSkinFile.

type DeleteDomainSkinInput added in v0.3.0 

type DeleteDomainSkinInput struct {
	DomainName string // optional; empty applies to the administrator Domain
	SkinName   string // "" deletes the unnamed Skin
}

DeleteDomainSkinInput deletes a custom Domain Skin. An empty SkinName deletes the unnamed Skin; it can only be deleted once no named Domain Skin exists.

type DeleteDomainSkinOutput added in v0.3.0 

type DeleteDomainSkinOutput struct{}

DeleteDomainSkinOutput holds the result of DeleteDomainSkin.

type DeleteForwarderInput added in v0.3.0 

type DeleteForwarderInput struct {
	ForwarderName string // required
}

DeleteForwarderInput deletes an existing Forwarder.

type DeleteForwarderOutput added in v0.3.0 

type DeleteForwarderOutput struct{}

DeleteForwarderOutput holds the result of DeleteForwarder.

type DeleteGroupInput added in v0.3.0 

type DeleteGroupInput struct {
	GroupName string // required; may include "@domain"
}

DeleteGroupInput deletes an existing Group.

type DeleteGroupOutput added in v0.3.0 

type DeleteGroupOutput struct{}

DeleteGroupOutput holds the result of DeleteGroup.

type DeleteListInput added in v0.3.0 

type DeleteListInput struct {
	ListName string // required; may include the Domain name
}

DeleteListInput removes a mailing list.

type DeleteListOutput added in v0.3.0 

type DeleteListOutput struct{}

DeleteListOutput holds the result of DeleteList.

type DeleteMailboxInput added in v0.3.0 

type DeleteMailboxInput struct {
	AccountName     string // required; "*" names the current authenticated Account
	MailboxName     string // required
	Recursive       bool   // if true, use the MAILBOXES form: nested submailboxes are deleted, too
	AuthAccountName string // optional: run the command on behalf of this Account
}

DeleteMailboxInput deletes a Mailbox from an Account.

type DeleteMailboxOutput added in v0.3.0 

type DeleteMailboxOutput struct{}

DeleteMailboxOutput holds the result of DeleteMailbox.

type DeleteNamedTaskInput added in v0.3.0 

type DeleteNamedTaskInput struct {
	TaskName string // required; may include the Domain name
}

DeleteNamedTaskInput deletes a Named Task.

type DeleteNamedTaskOutput added in v0.3.0 

type DeleteNamedTaskOutput struct{}

DeleteNamedTaskOutput holds the result of DeleteNamedTask.

type DeleteServerPBXFileInput added in v0.3.0 

type DeleteServerPBXFileInput struct {
	FileName string // required
}

DeleteServerPBXFileInput deletes a file from the Server-wide Real-Time Application Environment. Available to System Administrators only.

type DeleteServerPBXFileOutput added in v0.3.0 

type DeleteServerPBXFileOutput struct{}

DeleteServerPBXFileOutput holds the result of DeleteServerPBXFile.

type DeleteServerPBXInput added in v0.3.0 

type DeleteServerPBXInput struct {
	Language string // required
}

DeleteServerPBXInput removes a national subset of the Server-wide Real-Time Application Environment. Available to System Administrators only.

type DeleteServerPBXOutput added in v0.3.0 

type DeleteServerPBXOutput struct{}

DeleteServerPBXOutput holds the result of DeleteServerPBX.

type DeleteServerSkinFileInput added in v0.3.0 

type DeleteServerSkinFileInput struct {
	SkinName string // required
	FileName string // required
}

DeleteServerSkinFileInput deletes a file from a custom Server Skin.

type DeleteServerSkinFileOutput added in v0.3.0 

type DeleteServerSkinFileOutput struct{}

DeleteServerSkinFileOutput holds the result of DeleteServerSkinFile.

type DeleteServerSkinInput added in v0.3.0 

type DeleteServerSkinInput struct {
	SkinName string // required
}

DeleteServerSkinInput deletes a custom Server Skin.

type DeleteServerSkinOutput added in v0.3.0 

type DeleteServerSkinOutput struct{}

DeleteServerSkinOutput holds the result of DeleteServerSkin.

type DeleteStorageFileInput added in v0.3.0 

type DeleteStorageFileInput struct {
	AccountName     string // required; "*" names the current authenticated Account
	FileName        string // required
	AuthAccountName string // optional: run the command on behalf of this Account
}

DeleteStorageFileInput removes a file or a file directory from the Account File Storage.

type DeleteStorageFileOutput added in v0.3.0 

type DeleteStorageFileOutput struct{}

DeleteStorageFileOutput holds the result of DeleteStorageFile.

type DumpAllObjectsInput added in v0.3.0 

type DumpAllObjectsInput struct {
	File bool // optional
}

DumpAllObjectsInput writes the list of all application data objects either to the OS syslog, or - with File set - to the objects_dump.txt file in the Server base directory (the command does nothing if that file already exists).

type DumpAllObjectsOutput added in v0.3.0 

type DumpAllObjectsOutput struct{}

DumpAllObjectsOutput holds the result of DumpAllObjects.

type EchoInput added in v0.3.0 

type EchoInput struct {
	Value cgpdata.Value // required
}

EchoInput carries an arbitrary object for the server to copy back verbatim.

type EchoOutput added in v0.3.0 

type EchoOutput struct {
	Value cgpdata.Value
}

EchoOutput holds the result of Echo: an exact copy of Input.Value as decoded from the server's response.

type FindAccountSessionInput added in v0.3.0 

type FindAccountSessionInput struct {
	AccountName     string // required
	IPAddress       string // optional; restricts the search to matching login IP addresses
	ProxiedAddress  string // optional; only meaningful together with IPAddress
	Protocol        string // optional bare keyword, e.g. "WebUser", "XIMSS", "XMPP"
	Transport       string // optional bare keyword, e.g. "HTTP", "XIMSS", "XMPP"
	Client          string // optional; restricts the search to sessions reporting this client name
	IncludeDelegate bool   // optional; also search sessions of Accounts with delegated access to AccountName's mailboxes
}

FindAccountSessionInput searches for an existing session belonging to an Account.

type FindAccountSessionOutput added in v0.3.0 

type FindAccountSessionOutput struct {
	SessionID string
}

FindAccountSessionOutput holds the result of FindAccountSession.

type FindForwardersInput added in v0.3.0 

type FindForwardersInput struct {
	DomainName       string // required
	ForwarderAddress string // required
}

FindForwardersInput finds all Forwarders in a Domain that reroute to a given address.

type FindForwardersOutput added in v0.3.0 

type FindForwardersOutput struct {
	Forwarders cgpdata.Array
}

FindForwardersOutput holds the result of FindForwarders.

type GetAccountACLInput added in v0.3.0 

type GetAccountACLInput struct {
	AccountName     string // required; "*" names the current authenticated Account
	AuthAccountName string // optional: only return the ACL if this Account has the Admin right on AccountName
}

GetAccountACLInput reads the Access Control List governing an account's Access Rights.

type GetAccountACLOutput added in v0.3.0 

type GetAccountACLOutput struct {
	ACL cgpdata.Dictionary
}

GetAccountACLOutput holds the result of GetAccountACL.

type GetAccountACLRightsInput added in v0.3.0 

type GetAccountACLRightsInput struct {
	AccountName     string // required; "*" names the current authenticated Account
	AuthAccountName string // required
}

GetAccountACLRightsInput reads the effective Access Rights one account has been granted over another account's Access Rights ACL.

type GetAccountACLRightsOutput added in v0.3.0 

type GetAccountACLRightsOutput struct {
	Rights string
}

GetAccountACLRightsOutput holds the result of GetAccountACLRights.

type GetAccountAirSyncDevicesInput added in v0.3.0 

type GetAccountAirSyncDevicesInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountAirSyncDevicesInput lists the AirSync devices associated with an account.

type GetAccountAirSyncDevicesOutput added in v0.3.0 

type GetAccountAirSyncDevicesOutput struct {
	Devices cgpdata.Dictionary
}

GetAccountAirSyncDevicesOutput holds the result of GetAccountAirSyncDevices. Devices maps each device's unique ID to a Dictionary with its Date/LastAddress/User-Agent/doAccountWipe/doWipe elements.

type GetAccountAlertsInput added in v0.3.0 

type GetAccountAlertsInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountAlertsInput reads an Account's alerts.

type GetAccountAlertsOutput added in v0.3.0 

type GetAccountAlertsOutput struct {
	Alerts cgpdata.Dictionary
}

GetAccountAlertsOutput holds the result of GetAccountAlerts: a dictionary of alert strings keyed by their time stamps.

type GetAccountAliasesInput added in v0.3.0 

type GetAccountAliasesInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountAliasesInput lists an account's alias names.

type GetAccountAliasesOutput added in v0.3.0 

type GetAccountAliasesOutput struct {
	Aliases cgpdata.Array
}

GetAccountAliasesOutput holds the result of GetAccountAliases.

type GetAccountDefaultPrefsInput added in v0.3.0 

type GetAccountDefaultPrefsInput struct {
	DomainName string // optional; empty applies to the administrator Domain
}

GetAccountDefaultPrefsInput reads the Default Account Preferences applied to new Accounts created in a domain.

type GetAccountDefaultPrefsOutput added in v0.3.0 

type GetAccountDefaultPrefsOutput struct {
	Prefs cgpdata.Dictionary
}

GetAccountDefaultPrefsOutput holds the result of GetAccountDefaultPrefs.

type GetAccountDefaultsInput added in v0.3.0 

type GetAccountDefaultsInput struct {
	DomainName string // optional; empty applies to the administrator Domain
}

GetAccountDefaultsInput reads the default Account settings applied to new Accounts created in a domain.

type GetAccountDefaultsOutput added in v0.3.0 

type GetAccountDefaultsOutput struct {
	Settings cgpdata.Dictionary
}

GetAccountDefaultsOutput holds the result of GetAccountDefaults.

type GetAccountEffectivePrefsInput added in v0.3.0 

type GetAccountEffectivePrefsInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountEffectivePrefsInput reads an account's Preferences merged with every applicable default.

type GetAccountEffectivePrefsOutput added in v0.3.0 

type GetAccountEffectivePrefsOutput struct {
	Prefs cgpdata.Dictionary
}

GetAccountEffectivePrefsOutput holds the result of GetAccountEffectivePrefs.

type GetAccountEffectiveSettingsInput 

type GetAccountEffectiveSettingsInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountEffectiveSettingsInput reads an account's settings merged with every applicable Domain/Cluster/Server default.

type GetAccountEffectiveSettingsOutput 

type GetAccountEffectiveSettingsOutput struct {
	Settings cgpdata.Dictionary
}

GetAccountEffectiveSettingsOutput holds the result of GetAccountEffectiveSettings.

type GetAccountInfoInput added in v0.3.0 

type GetAccountInfoInput struct {
	AccountName string   // required; "*" names the current authenticated Account
	KeyName     string   // optional; the info element name, without its leading "#"
	KeyList     []string // optional; the info element names to retrieve, without their leading "#"
}

GetAccountInfoInput reads one, several, or (if neither KeyName nor KeyList is set) every element of an account's "info" dictionary. KeyName and KeyList are mutually exclusive.

type GetAccountInfoOutput added in v0.3.0 

type GetAccountInfoOutput struct {
	Value cgpdata.Value
}

GetAccountInfoOutput holds the result of GetAccountInfo. Value is a cgpdata.Dictionary when Input.KeyList (or neither field) was given, or the single requested element - a cgpdata.String (an empty String if not found), cgpdata.Array, or cgpdata.Dictionary - when Input.KeyName was given.

type GetAccountListsInput added in v0.3.0 

type GetAccountListsInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountListsInput lists the mailing lists owned by an Account, along with each list's subscriber count.

type GetAccountListsOutput added in v0.3.0 

type GetAccountListsOutput struct {
	Lists cgpdata.Dictionary
}

GetAccountListsOutput holds the result of GetAccountLists. Each Lists key is a mailing list name; the value is a numeric string with the subscriber count ("-1" if not known).

type GetAccountLocationInput added in v0.3.0 

type GetAccountLocationInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountLocationInput reads an account's file directory path (for multi-mailbox Accounts) or INBOX Mailbox path (for single-mailbox Accounts). System Administrators only.

type GetAccountLocationOutput added in v0.3.0 

type GetAccountLocationOutput struct {
	Path string // relative to the Account Domain's file directory
}

GetAccountLocationOutput holds the result of GetAccountLocation.

type GetAccountMailRulesInput added in v0.3.0 

type GetAccountMailRulesInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountMailRulesInput lists an account's Queue Rules.

type GetAccountMailRulesOutput added in v0.3.0 

type GetAccountMailRulesOutput struct {
	Rules cgpdata.Array
}

GetAccountMailRulesOutput holds the result of GetAccountMailRules.

type GetAccountOneSettingInput added in v0.3.0 

type GetAccountOneSettingInput struct {
	AccountName string // required; "*" names the current authenticated Account
	KeyName     string // required
}

GetAccountOneSettingInput reads a single key from an account's effective settings.

type GetAccountOneSettingOutput added in v0.3.0 

type GetAccountOneSettingOutput struct {
	Value cgpdata.Value
}

GetAccountOneSettingOutput holds the result of GetAccountOneSetting. Value holds whatever shape the server returned for KeyName: a cgpdata.String, cgpdata.Array, or cgpdata.Dictionary, or a cgpdata.Null if the setting has no value at all.

type GetAccountPrefsInput added in v0.3.0 

type GetAccountPrefsInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountPrefsInput reads an account's own stored Preferences (WebUser Preferences).

type GetAccountPrefsOutput added in v0.3.0 

type GetAccountPrefsOutput struct {
	Prefs cgpdata.Dictionary
}

GetAccountPrefsOutput holds the result of GetAccountPrefs.

type GetAccountPresenceInput added in v0.3.0 

type GetAccountPresenceInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountPresenceInput reads an account's "presence" status. System Administrators only.

type GetAccountPresenceOutput added in v0.3.0 

type GetAccountPresenceOutput struct {
	Set     bool
	Status  string
	Message string // the custom status message, if any was set
}

GetAccountPresenceOutput holds the result of GetAccountPresence. Set is false when the Account has no presence status at all, in which case Status and Message are both empty.

type GetAccountRIMAPsInput added in v0.3.0 

type GetAccountRIMAPsInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountRIMAPsInput lists an account's RIMAP records.

type GetAccountRIMAPsOutput added in v0.3.0 

type GetAccountRIMAPsOutput struct {
	Records cgpdata.Dictionary
}

GetAccountRIMAPsOutput holds the result of GetAccountRIMAPs.

type GetAccountRPOPsInput added in v0.3.0 

type GetAccountRPOPsInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountRPOPsInput lists an account's RPOP records.

type GetAccountRPOPsOutput added in v0.3.0 

type GetAccountRPOPsOutput struct {
	Records cgpdata.Dictionary
}

GetAccountRPOPsOutput holds the result of GetAccountRPOPs.

type GetAccountRSIPsInput added in v0.3.0 

type GetAccountRSIPsInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountRSIPsInput lists an account's RSIP records.

type GetAccountRSIPsOutput added in v0.3.0 

type GetAccountRSIPsOutput struct {
	Records cgpdata.Dictionary
}

GetAccountRSIPsOutput holds the result of GetAccountRSIPs.

type GetAccountRightsInput added in v0.3.0 

type GetAccountRightsInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountRightsInput reads the Server or Domain Administration access rights granted to an account.

type GetAccountRightsOutput added in v0.3.0 

type GetAccountRightsOutput struct {
	Rights cgpdata.Array
}

GetAccountRightsOutput holds the result of GetAccountRights.

type GetAccountSearchIndexSizeInput added in v0.3.0 

type GetAccountSearchIndexSizeInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountSearchIndexSizeInput reads the size of an account's Search Index.

type GetAccountSearchIndexSizeOutput added in v0.3.0 

type GetAccountSearchIndexSizeOutput struct {
	Size int64
}

GetAccountSearchIndexSizeOutput holds the result of GetAccountSearchIndexSize.

type GetAccountSearchIndexStateInput added in v0.3.0 

type GetAccountSearchIndexStateInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountSearchIndexStateInput reads the Search Index build state of an account.

type GetAccountSearchIndexStateOutput added in v0.3.0 

type GetAccountSearchIndexStateOutput struct {
	State string // "none", "waiting", "indexing", or "ready"
}

GetAccountSearchIndexStateOutput holds the result of GetAccountSearchIndexState.

type GetAccountSettingsInput 

type GetAccountSettingsInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountSettingsInput reads an account's own stored settings.

type GetAccountSettingsOutput 

type GetAccountSettingsOutput struct {
	Settings cgpdata.Dictionary
}

GetAccountSettingsOutput holds the result of GetAccountSettings.

type GetAccountSignalRulesInput added in v0.3.0 

type GetAccountSignalRulesInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountSignalRulesInput lists an account's Signal Rules.

type GetAccountSignalRulesOutput added in v0.3.0 

type GetAccountSignalRulesOutput struct {
	Rules cgpdata.Array
}

GetAccountSignalRulesOutput holds the result of GetAccountSignalRules.

type GetAccountStatInput added in v0.3.0 

type GetAccountStatInput struct {
	AccountName string // required; "*" names the current authenticated Account
	Key         string // optional; the single statistical entry to retrieve (e.g. "MessagesReceived"); empty retrieves all of them
}

GetAccountStatInput reads statistics data for an Account.

type GetAccountStatOutput added in v0.3.0 

type GetAccountStatOutput struct {
	Stats cgpdata.Dictionary
	Value cgpdata.Value
}

GetAccountStatOutput holds the result of GetAccountStat. When Input.Key is empty, Stats holds every available statistical entry as a dictionary and Value is nil. When Input.Key is set, Stats is nil and Value holds that single entry: a cgpdata.Number (message/ byte/call counts, login count), a cgpdata.TimeStamp (the "StatReset" key), or an empty cgpdata.String if the key does not exist for this Account.

type GetAccountTelnumsInput added in v0.3.0 

type GetAccountTelnumsInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetAccountTelnumsInput lists the telephone numbers assigned to an account.

type GetAccountTelnumsOutput added in v0.3.0 

type GetAccountTelnumsOutput struct {
	Telnums cgpdata.Array
}

GetAccountTelnumsOutput holds the result of GetAccountTelnums.

type GetAccountTemplateInput added in v0.3.0 

type GetAccountTemplateInput struct {
	DomainName string // optional; empty applies to the administrator Domain
}

GetAccountTemplateInput reads the Account Template settings new Accounts in a domain are created with.

type GetAccountTemplateOutput added in v0.3.0 

type GetAccountTemplateOutput struct {
	Settings cgpdata.Dictionary
}

GetAccountTemplateOutput holds the result of GetAccountTemplate.

type GetAccountWebAuthSessionInput added in v0.3.0 

type GetAccountWebAuthSessionInput struct {
	AccountName string // required; "*" names the current authenticated Account
	WebAuthID   string // required
}

GetAccountWebAuthSessionInput reads a Web Auth session's data.

type GetAccountWebAuthSessionOutput added in v0.3.0 

type GetAccountWebAuthSessionOutput struct {
	Session cgpdata.Dictionary
}

GetAccountWebAuthSessionOutput holds the result of GetAccountWebAuthSession.

type GetBannedInput added in v0.3.0 

type GetBannedInput struct{}

GetBannedInput reads the Server Banned Message Lines settings.

type GetBannedOutput added in v0.3.0 

type GetBannedOutput struct {
	Settings cgpdata.Dictionary
}

GetBannedOutput holds the result of GetBanned.

type GetBlacklistedIPsInput added in v0.3.0 

type GetBlacklistedIPsInput struct{}

GetBlacklistedIPsInput reads the Server-wide set of Blacklisted IP Addresses.

type GetBlacklistedIPsOutput added in v0.3.0 

type GetBlacklistedIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetBlacklistedIPsOutput holds the result of GetBlacklistedIPs.

type GetClientIPsInput added in v0.3.0 

type GetClientIPsInput struct{}

GetClientIPsInput reads the Server-wide set of Client IP Addresses.

type GetClientIPsOutput added in v0.3.0 

type GetClientIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetClientIPsOutput holds the result of GetClientIPs.

type GetClusterAccountDefaultsInput added in v0.3.0 

type GetClusterAccountDefaultsInput struct{}

GetClusterAccountDefaultsInput reads the cluster-wide default Account settings. Available in the Dynamic Cluster only.

type GetClusterAccountDefaultsOutput added in v0.3.0 

type GetClusterAccountDefaultsOutput struct {
	Settings cgpdata.Dictionary
}

GetClusterAccountDefaultsOutput holds the result of GetClusterAccountDefaults.

type GetClusterAccountPrefsInput added in v0.3.0 

type GetClusterAccountPrefsInput struct{}

GetClusterAccountPrefsInput reads the cluster-wide default Account Preferences. Available in the Dynamic Cluster only.

type GetClusterAccountPrefsOutput added in v0.3.0 

type GetClusterAccountPrefsOutput struct {
	Preferences cgpdata.Dictionary
}

GetClusterAccountPrefsOutput holds the result of GetClusterAccountPrefs.

type GetClusterAlertsInput added in v0.3.0 

type GetClusterAlertsInput struct{}

GetClusterAlertsInput reads the cluster-wide alerts. Available in the Dynamic Cluster only, in place of GetServerAlerts.

type GetClusterAlertsOutput added in v0.3.0 

type GetClusterAlertsOutput struct {
	Alerts cgpdata.Dictionary
}

GetClusterAlertsOutput holds the result of GetClusterAlerts: a dictionary of alert strings keyed by their time stamps.

type GetClusterBannedInput added in v0.3.0 

type GetClusterBannedInput struct{}

GetClusterBannedInput reads the Cluster-wide Banned Message Lines settings.

type GetClusterBannedOutput added in v0.3.0 

type GetClusterBannedOutput struct {
	Settings cgpdata.Dictionary
}

GetClusterBannedOutput holds the result of GetClusterBanned.

type GetClusterBlacklistedIPsInput added in v0.3.0 

type GetClusterBlacklistedIPsInput struct{}

GetClusterBlacklistedIPsInput reads the Cluster-wide set of Blacklisted IP Addresses.

type GetClusterBlacklistedIPsOutput added in v0.3.0 

type GetClusterBlacklistedIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetClusterBlacklistedIPsOutput holds the result of GetClusterBlacklistedIPs.

type GetClusterClientIPsInput added in v0.3.0 

type GetClusterClientIPsInput struct{}

GetClusterClientIPsInput reads the Cluster-wide set of Client IP Addresses.

type GetClusterClientIPsOutput added in v0.3.0 

type GetClusterClientIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetClusterClientIPsOutput holds the result of GetClusterClientIPs.

type GetClusterDebugIPsInput added in v0.3.0 

type GetClusterDebugIPsInput struct{}

GetClusterDebugIPsInput reads the Cluster-wide set of Debug IP Addresses.

type GetClusterDebugIPsOutput added in v0.3.0 

type GetClusterDebugIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetClusterDebugIPsOutput holds the result of GetClusterDebugIPs.

type GetClusterDeniedIPsInput added in v0.3.0 

type GetClusterDeniedIPsInput struct{}

GetClusterDeniedIPsInput reads the Cluster-wide set of Denied IP Addresses.

type GetClusterDeniedIPsOutput added in v0.3.0 

type GetClusterDeniedIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetClusterDeniedIPsOutput holds the result of GetClusterDeniedIPs.

type GetClusterDirectoryIntegrationInput added in v0.3.0 

type GetClusterDirectoryIntegrationInput struct{}

GetClusterDirectoryIntegrationInput reads the cluster-wide Directory Integration settings. Available in the Dynamic Cluster only.

type GetClusterDirectoryIntegrationOutput added in v0.3.0 

type GetClusterDirectoryIntegrationOutput struct {
	Settings cgpdata.Dictionary
}

GetClusterDirectoryIntegrationOutput holds the result of GetClusterDirectoryIntegration.

type GetClusterDomainDefaultsInput added in v0.3.0 

type GetClusterDomainDefaultsInput struct{}

GetClusterDomainDefaultsInput reads the cluster-wide default Domain settings. Available in the Dynamic Cluster only.

type GetClusterDomainDefaultsOutput added in v0.3.0 

type GetClusterDomainDefaultsOutput struct {
	Settings cgpdata.Dictionary
}

GetClusterDomainDefaultsOutput holds the result of GetClusterDomainDefaults.

type GetClusterInterceptInput added in v0.3.0 

type GetClusterInterceptInput struct{}

GetClusterInterceptInput reads the Cluster-Wide Lawful Intercept settings.

type GetClusterInterceptOutput added in v0.3.0 

type GetClusterInterceptOutput struct {
	Settings cgpdata.Dictionary
}

GetClusterInterceptOutput holds the result of GetClusterIntercept.

type GetClusterLANIPsInput added in v0.3.0 

type GetClusterLANIPsInput struct{}

GetClusterLANIPsInput reads the Cluster-wide set of LAN IP Addresses.

type GetClusterLANIPsOutput added in v0.3.0 

type GetClusterLANIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetClusterLANIPsOutput holds the result of GetClusterLANIPs.

type GetClusterMailRulesInput added in v0.3.0 

type GetClusterMailRulesInput struct{}

GetClusterMailRulesInput reads the Cluster-Wide Automated Mail Processing Rules.

type GetClusterMailRulesOutput added in v0.3.0 

type GetClusterMailRulesOutput struct {
	Rules cgpdata.Array
}

GetClusterMailRulesOutput holds the result of GetClusterMailRules.

type GetClusterNATSiteIPsInput added in v0.3.0 

type GetClusterNATSiteIPsInput struct{}

GetClusterNATSiteIPsInput reads the Cluster-wide set of NAT Site IP Addresses.

type GetClusterNATSiteIPsOutput added in v0.3.0 

type GetClusterNATSiteIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetClusterNATSiteIPsOutput holds the result of GetClusterNATSiteIPs.

type GetClusterNATedIPsInput added in v0.3.0 

type GetClusterNATedIPsInput struct{}

GetClusterNATedIPsInput reads the Cluster-wide set of NATed IP Addresses.

type GetClusterNATedIPsOutput added in v0.3.0 

type GetClusterNATedIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetClusterNATedIPsOutput holds the result of GetClusterNATedIPs.

type GetClusterNetworkInput added in v0.3.0 

type GetClusterNetworkInput struct{}

GetClusterNetworkInput reads the Cluster-wide Network settings.

type GetClusterNetworkOutput added in v0.3.0 

type GetClusterNetworkOutput struct {
	Settings cgpdata.Dictionary
}

GetClusterNetworkOutput holds the result of GetClusterNetwork.

type GetClusterProxyIPsInput added in v0.3.0 

type GetClusterProxyIPsInput struct{}

GetClusterProxyIPsInput reads the Cluster-wide set of Trusted Proxy Server IP Addresses.

type GetClusterProxyIPsOutput added in v0.3.0 

type GetClusterProxyIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetClusterProxyIPsOutput holds the result of GetClusterProxyIPs.

type GetClusterRouterSettingsInput added in v0.3.0 

type GetClusterRouterSettingsInput struct{}

GetClusterRouterSettingsInput reads the Cluster-Wide Router settings.

type GetClusterRouterSettingsOutput added in v0.3.0 

type GetClusterRouterSettingsOutput struct {
	Settings cgpdata.Dictionary
}

GetClusterRouterSettingsOutput holds the result of GetClusterRouterSettings.

type GetClusterRouterTableInput added in v0.3.0 

type GetClusterRouterTableInput struct{}

GetClusterRouterTableInput reads the Cluster-Wide Router Table.

type GetClusterRouterTableOutput added in v0.3.0 

type GetClusterRouterTableOutput struct {
	Table string // a (multi-line) string with the Router Table text
}

GetClusterRouterTableOutput holds the result of GetClusterRouterTable.

type GetClusterSettingsInput added in v0.3.0 

type GetClusterSettingsInput struct{}

GetClusterSettingsInput reads the Cluster settings.

type GetClusterSettingsOutput added in v0.3.0 

type GetClusterSettingsOutput struct {
	Settings cgpdata.Dictionary
}

GetClusterSettingsOutput holds the result of GetClusterSettings.

type GetClusterSignalRulesInput added in v0.3.0 

type GetClusterSignalRulesInput struct{}

GetClusterSignalRulesInput reads the Cluster-Wide Automated Signal Processing Rules.

type GetClusterSignalRulesOutput added in v0.3.0 

type GetClusterSignalRulesOutput struct {
	Rules cgpdata.Array
}

GetClusterSignalRulesOutput holds the result of GetClusterSignalRules.

type GetClusterTrustedCertsInput added in v0.3.0 

type GetClusterTrustedCertsInput struct{}

GetClusterTrustedCertsInput reads the cluster-wide set of Trusted Certificates. Available in the Dynamic Cluster only.

type GetClusterTrustedCertsOutput added in v0.3.0 

type GetClusterTrustedCertsOutput struct {
	Certificates [][]byte
}

GetClusterTrustedCertsOutput holds the result of GetClusterTrustedCerts. Each element of Certificates is one X.509 certificate's raw data.

type GetClusterWhiteHoleIPsInput added in v0.3.0 

type GetClusterWhiteHoleIPsInput struct{}

GetClusterWhiteHoleIPsInput reads the Cluster-wide set of WhiteHole IP Addresses.

type GetClusterWhiteHoleIPsOutput added in v0.3.0 

type GetClusterWhiteHoleIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetClusterWhiteHoleIPsOutput holds the result of GetClusterWhiteHoleIPs.

type GetCurrentControllerInput added in v0.3.0 

type GetCurrentControllerInput struct{}

GetCurrentControllerInput reads the IP address of the current Dynamic Cluster Controller.

type GetCurrentControllerOutput added in v0.3.0 

type GetCurrentControllerOutput struct {
	Address string
}

GetCurrentControllerOutput holds the result of GetCurrentController.

type GetCurrentTimeInput added in v0.3.0 

type GetCurrentTimeInput struct{}

GetCurrentTimeInput reads the Server's internal timer value.

type GetCurrentTimeOutput added in v0.3.0 

type GetCurrentTimeOutput struct {
	Time cgpdata.TimeStamp
}

GetCurrentTimeOutput holds the result of GetCurrentTime.

type GetDNRSettingsInput added in v0.3.0 

type GetDNRSettingsInput struct{}

GetDNRSettingsInput reads the DNR (Domain Name Resolver) settings.

type GetDNRSettingsOutput added in v0.3.0 

type GetDNRSettingsOutput struct {
	Settings cgpdata.Dictionary
}

GetDNRSettingsOutput holds the result of GetDNRSettings.

type GetDebugIPsInput added in v0.3.0 

type GetDebugIPsInput struct{}

GetDebugIPsInput reads the Server-wide set of Debug IP Addresses.

type GetDebugIPsOutput added in v0.3.0 

type GetDebugIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetDebugIPsOutput holds the result of GetDebugIPs.

type GetDeniedIPsInput added in v0.3.0 

type GetDeniedIPsInput struct{}

GetDeniedIPsInput reads the Server-wide set of Denied IP Addresses.

type GetDeniedIPsOutput added in v0.3.0 

type GetDeniedIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetDeniedIPsOutput holds the result of GetDeniedIPs.

type GetDialogInfoInput added in v0.3.0 

type GetDialogInfoInput struct {
	DialogID int // required
}

GetDialogInfoInput reads information about a Signal Dialog object.

type GetDialogInfoOutput added in v0.3.0 

type GetDialogInfoOutput struct {
	Info cgpdata.Dictionary
}

GetDialogInfoOutput holds the result of GetDialogInfo.

type GetDirectoryAccessRightsInput added in v0.3.0 

type GetDirectoryAccessRightsInput struct {
	Shared bool // optional; if true, reads the cluster-wide Access Rights
}

GetDirectoryAccessRightsInput reads the Directory Access Rights.

type GetDirectoryAccessRightsOutput added in v0.3.0 

type GetDirectoryAccessRightsOutput struct {
	AccessRights cgpdata.Array
}

GetDirectoryAccessRightsOutput holds the result of GetDirectoryAccessRights.

type GetDirectoryIntegrationInput added in v0.3.0 

type GetDirectoryIntegrationInput struct{}

GetDirectoryIntegrationInput reads the server-wide Directory Integration settings.

type GetDirectoryIntegrationOutput added in v0.3.0 

type GetDirectoryIntegrationOutput struct {
	Settings cgpdata.Dictionary
}

GetDirectoryIntegrationOutput holds the result of GetDirectoryIntegration.

type GetDirectoryUnitInput added in v0.3.0 

type GetDirectoryUnitInput struct {
	UnitName string // required
	Shared   bool   // optional; if true, UnitName names a cluster-wide Unit
}

GetDirectoryUnitInput reads a Directory Unit's settings.

type GetDirectoryUnitOutput added in v0.3.0 

type GetDirectoryUnitOutput struct {
	Settings cgpdata.Dictionary
}

GetDirectoryUnitOutput holds the result of GetDirectoryUnit.

type GetDomainAlertsInput added in v0.3.0 

type GetDomainAlertsInput struct {
	DomainName string // optional; empty applies to the administrator Domain
}

GetDomainAlertsInput reads a Domain's alerts.

type GetDomainAlertsOutput added in v0.3.0 

type GetDomainAlertsOutput struct {
	Alerts cgpdata.Dictionary
}

GetDomainAlertsOutput holds the result of GetDomainAlerts: a dictionary of alert strings keyed by their time stamps.

type GetDomainAliasesInput added in v0.2.0 

type GetDomainAliasesInput struct {
	DomainName string // required
}

GetDomainAliasesInput lists the alias names of a domain.

type GetDomainAliasesOutput added in v0.2.0 

type GetDomainAliasesOutput struct {
	Aliases cgpdata.Array
}

GetDomainAliasesOutput holds the result of GetDomainAliases.

type GetDomainDefaultsInput added in v0.3.0 

type GetDomainDefaultsInput struct{}

GetDomainDefaultsInput reads the server-wide default Domain settings.

type GetDomainDefaultsOutput added in v0.3.0 

type GetDomainDefaultsOutput struct {
	Settings cgpdata.Dictionary
}

GetDomainDefaultsOutput holds the result of GetDomainDefaults.

type GetDomainEffectiveSettingsInput added in v0.2.0 

type GetDomainEffectiveSettingsInput struct {
	DomainName string // optional; empty applies to the administrator Domain
}

GetDomainEffectiveSettingsInput reads a domain's settings merged with the applicable defaults.

type GetDomainEffectiveSettingsOutput added in v0.2.0 

type GetDomainEffectiveSettingsOutput struct {
	Settings cgpdata.Dictionary
}

GetDomainEffectiveSettingsOutput holds the result of GetDomainEffectiveSettings.

type GetDomainFreeBusyInput added in v0.3.0 

type GetDomainFreeBusyInput struct {
	DomainName string // optional; empty applies to the administrator Domain
}

GetDomainFreeBusyInput reads a Domain's Free/Busy settings.

type GetDomainFreeBusyOutput added in v0.3.0 

type GetDomainFreeBusyOutput struct {
	FreeBusy cgpdata.Dictionary
}

GetDomainFreeBusyOutput holds the result of GetDomainFreeBusy.

type GetDomainListsInput added in v0.3.0 

type GetDomainListsInput struct {
	DomainName string // optional; empty applies to the administrator Domain
}

GetDomainListsInput lists the mailing lists defined in a Domain, along with each list's subscriber count.

type GetDomainListsOutput added in v0.3.0 

type GetDomainListsOutput struct {
	Lists cgpdata.Dictionary
}

GetDomainListsOutput holds the result of GetDomainLists. Each Lists key is a mailing list name; the value is a numeric string with the subscriber count ("-1" if not known).

type GetDomainLocationInput added in v0.3.0 

type GetDomainLocationInput struct {
	DomainName string // optional; empty applies to the administrator Domain
}

GetDomainLocationInput reads a domain's file directory path.

type GetDomainLocationOutput added in v0.3.0 

type GetDomainLocationOutput struct {
	Path string // relative to the Server base directory
}

GetDomainLocationOutput holds the result of GetDomainLocation.

type GetDomainMailRulesInput added in v0.3.0 

type GetDomainMailRulesInput struct {
	DomainName string // required
}

GetDomainMailRulesInput lists a domain's Queue Rules.

type GetDomainMailRulesOutput added in v0.3.0 

type GetDomainMailRulesOutput struct {
	Rules cgpdata.Array
}

GetDomainMailRulesOutput holds the result of GetDomainMailRules.

type GetDomainPluginsSettingsInput added in v0.3.0 

type GetDomainPluginsSettingsInput struct {
	DomainName string // optional; empty applies to the administrator Domain
}

GetDomainPluginsSettingsInput reads a domain's Plugins Settings.

type GetDomainPluginsSettingsOutput added in v0.3.0 

type GetDomainPluginsSettingsOutput struct {
	Settings cgpdata.Dictionary
}

GetDomainPluginsSettingsOutput holds the result of GetDomainPluginsSettings.

type GetDomainSearchIndexStateInput added in v0.3.0 

type GetDomainSearchIndexStateInput struct {
	DomainName string // required
}

GetDomainSearchIndexStateInput reads the Search Index build state of a domain.

type GetDomainSearchIndexStateOutput added in v0.3.0 

type GetDomainSearchIndexStateOutput struct {
	State string // "none", "waiting", "indexing", or "ready"
}

GetDomainSearchIndexStateOutput holds the result of GetDomainSearchIndexState.

type GetDomainSettingsInput added in v0.2.0 

type GetDomainSettingsInput struct {
	DomainName string // optional; empty applies to the administrator Domain
}

GetDomainSettingsInput reads a domain's explicitly stored settings (defaults excluded).

type GetDomainSettingsOutput added in v0.2.0 

type GetDomainSettingsOutput struct {
	Settings cgpdata.Dictionary
}

GetDomainSettingsOutput holds the result of GetDomainSettings.

type GetDomainSignalRulesInput added in v0.3.0 

type GetDomainSignalRulesInput struct {
	DomainName string // required
}

GetDomainSignalRulesInput lists a domain's Signal Rules.

type GetDomainSignalRulesOutput added in v0.3.0 

type GetDomainSignalRulesOutput struct {
	Rules cgpdata.Array
}

GetDomainSignalRulesOutput holds the result of GetDomainSignalRules.

type GetDomainStatInput added in v0.3.0 

type GetDomainStatInput struct {
	DomainName string // required; "*" names the Domain of the current authenticated Account
	Key        string // optional; the single statistical entry to retrieve (e.g. "MessagesReceived"); empty retrieves all of them
}

GetDomainStatInput reads statistics data for a Domain.

type GetDomainStatOutput added in v0.3.0 

type GetDomainStatOutput struct {
	Stats cgpdata.Dictionary
	Value cgpdata.Value
}

GetDomainStatOutput holds the result of GetDomainStat. When Input.Key is empty, Stats holds every available statistical entry as a dictionary and Value is nil. When Input.Key is set, Stats is nil and Value holds that single entry - CLI.md documents it as a string, but (as with GetAccountStat, and consistent with the same "StatReset"/counter keys the two commands share) the server may return a cgpdata.Number or cgpdata.TimeStamp instead; Value is left as the generic cgpdata.Value the response actually decoded to.

type GetFileSubscriptionInput added in v0.3.0 

type GetFileSubscriptionInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetFileSubscriptionInput reads an Account's "subscribed files" list.

type GetFileSubscriptionOutput added in v0.3.0 

type GetFileSubscriptionOutput struct {
	SubscribedFiles cgpdata.Array
}

GetFileSubscriptionOutput holds the result of GetFileSubscription.

type GetForwarderInput added in v0.3.0 

type GetForwarderInput struct {
	ForwarderName string // required
}

GetForwarderInput reads the E-mail address a Forwarder reroutes to.

type GetForwarderOutput added in v0.3.0 

type GetForwarderOutput struct {
	Address string
}

GetForwarderOutput holds the result of GetForwarder.

type GetGroupInput added in v0.3.0 

type GetGroupInput struct {
	GroupName string // required; may include "@domain"
}

GetGroupInput reads a Group's settings and members.

type GetGroupOutput added in v0.3.0 

type GetGroupOutput struct {
	Settings cgpdata.Dictionary
}

GetGroupOutput holds the result of GetGroup.

type GetIPStateInput added in v0.3.0 

type GetIPStateInput struct {
	Address string // required
	Temp    bool   // optional; check the temporary Client IP Addresses set instead
}

GetIPStateInput gets the type assigned to an IP address.

type GetIPStateOutput added in v0.3.0 

type GetIPStateOutput struct {
	Type string // the IP address type
}

GetIPStateOutput holds the result of GetIPState.

type GetLANIPsInput added in v0.3.0 

type GetLANIPsInput struct{}

GetLANIPsInput reads the Server-wide set of LAN IP Addresses.

type GetLANIPsOutput added in v0.3.0 

type GetLANIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetLANIPsOutput holds the result of GetLANIPs.

type GetListInput added in v0.3.0 

type GetListInput struct {
	ListName string // required; may include the Domain name
}

GetListInput reads a mailing list's settings.

type GetListOutput added in v0.3.0 

type GetListOutput struct {
	Settings cgpdata.Dictionary
}

GetListOutput holds the result of GetList.

type GetLogSettingsInput added in v0.3.0 

type GetLogSettingsInput struct{}

GetLogSettingsInput reads the Main Log settings.

type GetLogSettingsOutput added in v0.3.0 

type GetLogSettingsOutput struct {
	Settings cgpdata.Dictionary
}

GetLogSettingsOutput holds the result of GetLogSettings.

type GetMailboxACLInput added in v0.3.0 

type GetMailboxACLInput struct {
	AccountName     string // required; "*" names the current authenticated Account
	MailboxName     string // required
	AuthAccountName string // optional: the ACL is returned only if this Account has the Admin right
}

GetMailboxACLInput reads a Mailbox's access control list.

type GetMailboxACLOutput added in v0.3.0 

type GetMailboxACLOutput struct {
	ACL cgpdata.Dictionary
}

GetMailboxACLOutput holds the result of GetMailboxACL.

type GetMailboxAliasesInput added in v0.3.0 

type GetMailboxAliasesInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetMailboxAliasesInput reads an Account's Mailbox aliases.

type GetMailboxAliasesOutput added in v0.3.0 

type GetMailboxAliasesOutput struct {
	Aliases cgpdata.Dictionary
}

GetMailboxAliasesOutput holds the result of GetMailboxAliases. Aliases maps each alias name to the String name of the Mailbox it points to.

type GetMailboxAliasesUTF8Input added in v0.3.0 

type GetMailboxAliasesUTF8Input struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetMailboxAliasesUTF8Input reads an Account's Mailbox aliases, with alias and target Mailbox names in UTF-8 encoding.

type GetMailboxAliasesUTF8Output added in v0.3.0 

type GetMailboxAliasesUTF8Output struct {
	Aliases cgpdata.Dictionary
}

GetMailboxAliasesUTF8Output holds the result of GetMailboxAliasesUTF8.

type GetMailboxInfoInput added in v0.3.0 

type GetMailboxInfoInput struct {
	AccountName     string // required; "*" names the current authenticated Account
	MailboxName     string // required
	AuthAccountName string // optional: the Mailbox info is returned only if this Account has the Select right
}

GetMailboxInfoInput reads a Mailbox's internal information.

type GetMailboxInfoOutput added in v0.3.0 

type GetMailboxInfoOutput struct {
	Info cgpdata.Dictionary
}

GetMailboxInfoOutput holds the result of GetMailboxInfo.

type GetMailboxRightsInput added in v0.3.0 

type GetMailboxRightsInput struct {
	AccountName     string // required; "*" names the current authenticated Account
	MailboxName     string // required
	AuthAccountName string // required: whose effective access rights to retrieve
}

GetMailboxRightsInput reads the effective Mailbox access rights of a given Account.

type GetMailboxRightsOutput added in v0.3.0 

type GetMailboxRightsOutput struct {
	Rights string
}

GetMailboxRightsOutput holds the result of GetMailboxRights.

type GetMailboxSubscriptionInput added in v0.3.0 

type GetMailboxSubscriptionInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetMailboxSubscriptionInput reads an Account's "subscribed Mailboxes" list.

type GetMailboxSubscriptionOutput added in v0.3.0 

type GetMailboxSubscriptionOutput struct {
	Mailboxes cgpdata.Array
}

GetMailboxSubscriptionOutput holds the result of GetMailboxSubscription.

type GetMailboxSubscriptionUTF8Input added in v0.3.0 

type GetMailboxSubscriptionUTF8Input struct {
	AccountName string // required; "*" names the current authenticated Account
}

GetMailboxSubscriptionUTF8Input reads an Account's "subscribed Mailboxes" list, with Mailbox names in UTF-8 encoding.

type GetMailboxSubscriptionUTF8Output added in v0.3.0 

type GetMailboxSubscriptionUTF8Output struct {
	Mailboxes cgpdata.Array
}

GetMailboxSubscriptionUTF8Output holds the result of GetMailboxSubscriptionUTF8.

type GetMediaServerSettingsInput added in v0.3.0 

type GetMediaServerSettingsInput struct{}

GetMediaServerSettingsInput reads the Media Server component settings.

type GetMediaServerSettingsOutput added in v0.3.0 

type GetMediaServerSettingsOutput struct {
	Settings cgpdata.Dictionary
}

GetMediaServerSettingsOutput holds the result of GetMediaServerSettings.

type GetMessageQueueInfoInput added in v0.3.0 

type GetMessageQueueInfoInput struct {
	ModuleName string // required
	QueueName  string // required
}

GetMessageQueueInfoInput reads information about a module message queue.

type GetMessageQueueInfoOutput added in v0.3.0 

type GetMessageQueueInfoOutput struct {
	Info cgpdata.Dictionary
}

GetMessageQueueInfoOutput holds the result of GetMessageQueueInfo: a Dictionary with nTotal/size/delayedTill/lastError elements, empty if the module has no such queue.

type GetModuleInput added in v0.3.0 

type GetModuleInput struct {
	ModuleName string // required
}

GetModuleInput reads a Server module's settings.

type GetModuleOutput added in v0.3.0 

type GetModuleOutput struct {
	Settings cgpdata.Dictionary
}

GetModuleOutput holds the result of GetModule.

type GetNATSiteIPsInput added in v0.3.0 

type GetNATSiteIPsInput struct{}

GetNATSiteIPsInput reads the Server-wide set of NAT Site IP Addresses.

type GetNATSiteIPsOutput added in v0.3.0 

type GetNATSiteIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetNATSiteIPsOutput holds the result of GetNATSiteIPs.

type GetNATedIPsInput added in v0.3.0 

type GetNATedIPsInput struct{}

GetNATedIPsInput reads the Server-wide set of NATed IP Addresses.

type GetNATedIPsOutput added in v0.3.0 

type GetNATedIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetNATedIPsOutput holds the result of GetNATedIPs.

type GetNamedTaskInput added in v0.3.0 

type GetNamedTaskInput struct {
	TaskName string // required; may include the Domain name
}

GetNamedTaskInput reads a Named Task's settings.

type GetNamedTaskOutput added in v0.3.0 

type GetNamedTaskOutput struct {
	Settings cgpdata.Dictionary
}

GetNamedTaskOutput holds the result of GetNamedTask.

type GetNetworkInput added in v0.3.0 

type GetNetworkInput struct{}

GetNetworkInput reads the Server Network settings.

type GetNetworkOutput added in v0.3.0 

type GetNetworkOutput struct {
	Settings cgpdata.Dictionary
}

GetNetworkOutput holds the result of GetNetwork.

type GetNextStatNameInput added in v0.3.0 

type GetNextStatNameInput struct {
	ObjectID string // the already-found element to advance from; "" starts enumeration at the first available element
}

GetNextStatNameInput enumerates available Server statistics (SNMP) elements, one at a time.

type GetNextStatNameOutput added in v0.3.0 

type GetNextStatNameOutput struct {
	NextObjectID string
}

GetNextStatNameOutput holds the result of GetNextStatName.

type GetProxyIPsInput added in v0.3.0 

type GetProxyIPsInput struct{}

GetProxyIPsInput reads the Server-wide set of Trusted Proxy Server IP Addresses.

type GetProxyIPsOutput added in v0.3.0 

type GetProxyIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetProxyIPsOutput holds the result of GetProxyIPs.

type GetQueueSettingsInput added in v0.3.0 

type GetQueueSettingsInput struct{}

GetQueueSettingsInput reads the Queue settings.

type GetQueueSettingsOutput added in v0.3.0 

type GetQueueSettingsOutput struct {
	Settings cgpdata.Dictionary
}

GetQueueSettingsOutput holds the result of GetQueueSettings.

type GetRouterSettingsInput added in v0.3.0 

type GetRouterSettingsInput struct{}

GetRouterSettingsInput reads the Router settings.

type GetRouterSettingsOutput added in v0.3.0 

type GetRouterSettingsOutput struct {
	Settings cgpdata.Dictionary
}

GetRouterSettingsOutput holds the result of GetRouterSettings.

type GetRouterTableInput added in v0.3.0 

type GetRouterTableInput struct{}

GetRouterTableInput reads the Router Table.

type GetRouterTableOutput added in v0.3.0 

type GetRouterTableOutput struct {
	Table string // a (multi-line) string with the Router Table text
}

GetRouterTableOutput holds the result of GetRouterTable.

type GetServerAccountDefaultsInput added in v0.3.0 

type GetServerAccountDefaultsInput struct{}

GetServerAccountDefaultsInput reads the server-wide default Account settings.

type GetServerAccountDefaultsOutput added in v0.3.0 

type GetServerAccountDefaultsOutput struct {
	Settings cgpdata.Dictionary
}

GetServerAccountDefaultsOutput holds the result of GetServerAccountDefaults.

type GetServerAccountPrefsInput added in v0.3.0 

type GetServerAccountPrefsInput struct{}

GetServerAccountPrefsInput reads the server-wide default Account Preferences.

type GetServerAccountPrefsOutput added in v0.3.0 

type GetServerAccountPrefsOutput struct {
	Preferences cgpdata.Dictionary
}

GetServerAccountPrefsOutput holds the result of GetServerAccountPrefs.

type GetServerAlertsInput added in v0.3.0 

type GetServerAlertsInput struct{}

GetServerAlertsInput reads the server-wide alerts. Available to System Administrators only.

type GetServerAlertsOutput added in v0.3.0 

type GetServerAlertsOutput struct {
	Alerts cgpdata.Dictionary
}

GetServerAlertsOutput holds the result of GetServerAlerts: a dictionary of alert strings keyed by their time stamps.

type GetServerInterceptInput added in v0.3.0 

type GetServerInterceptInput struct{}

GetServerInterceptInput reads the Lawful Intercept settings.

type GetServerInterceptOutput added in v0.3.0 

type GetServerInterceptOutput struct {
	Settings cgpdata.Dictionary
}

GetServerInterceptOutput holds the result of GetServerIntercept.

type GetServerMailRulesInput added in v0.3.0 

type GetServerMailRulesInput struct{}

GetServerMailRulesInput reads the Server-Wide Automated Mail Processing Rules.

type GetServerMailRulesOutput added in v0.3.0 

type GetServerMailRulesOutput struct {
	Rules cgpdata.Array
}

GetServerMailRulesOutput holds the result of GetServerMailRules.

type GetServerSettingsInput added in v0.3.0 

type GetServerSettingsInput struct{}

GetServerSettingsInput reads the Server "other" settings.

type GetServerSettingsOutput added in v0.3.0 

type GetServerSettingsOutput struct {
	Settings cgpdata.Dictionary
}

GetServerSettingsOutput holds the result of GetServerSettings.

type GetServerSignalRulesInput added in v0.3.0 

type GetServerSignalRulesInput struct{}

GetServerSignalRulesInput reads the Server-Wide Automated Signal Processing Rules.

type GetServerSignalRulesOutput added in v0.3.0 

type GetServerSignalRulesOutput struct {
	Rules cgpdata.Array
}

GetServerSignalRulesOutput holds the result of GetServerSignalRules.

type GetServerTrustedCertsInput added in v0.3.0 

type GetServerTrustedCertsInput struct{}

GetServerTrustedCertsInput reads the server-wide set of Trusted Certificates.

type GetServerTrustedCertsOutput added in v0.3.0 

type GetServerTrustedCertsOutput struct {
	Certificates [][]byte
}

GetServerTrustedCertsOutput holds the result of GetServerTrustedCerts. Each element of Certificates is one X.509 certificate's raw data.

type GetSessionInput added in v0.3.0 

type GetSessionInput struct {
	SessionID  string // required
	DomainName string // optional; the Domain the session's Account belongs to
}

GetSessionInput reads a Session's data.

type GetSessionOutput added in v0.3.0 

type GetSessionOutput struct {
	Session cgpdata.Dictionary
}

GetSessionOutput holds the result of GetSession.

type GetSessionSettingsInput added in v0.3.0 

type GetSessionSettingsInput struct{}

GetSessionSettingsInput reads the user Sessions settings.

type GetSessionSettingsOutput added in v0.3.0 

type GetSessionSettingsOutput struct {
	Settings cgpdata.Dictionary
}

GetSessionSettingsOutput holds the result of GetSessionSettings.

type GetSignalSettingsInput added in v0.3.0 

type GetSignalSettingsInput struct{}

GetSignalSettingsInput reads the Signal component settings.

type GetSignalSettingsOutput added in v0.3.0 

type GetSignalSettingsOutput struct {
	Settings cgpdata.Dictionary
}

GetSignalSettingsOutput holds the result of GetSignalSettings.

type GetStatElementInput added in v0.3.0 

type GetStatElementInput struct {
	ObjectID string // required
}

GetStatElementInput reads the current value of a Server statistics (SNMP) element.

type GetStatElementOutput added in v0.3.0 

type GetStatElementOutput struct {
	Value cgpdata.Value
}

GetStatElementOutput holds the result of GetStatElement. CLI.md documents the value as "a number, string, or other object", so Value is left as the generic cgpdata.Value the response actually decoded to.

type GetStorageFileInfoInput added in v0.3.0 

type GetStorageFileInfoInput struct {
	AccountName     string // required; "*" names the current authenticated Account
	FilePath        string // optional; empty applies to the top File Storage directory
	AuthAccountName string // optional: run the command on behalf of this Account
}

GetStorageFileInfoInput reads statistical information about all files in the Account File Storage.

type GetStorageFileInfoOutput added in v0.3.0 

type GetStorageFileInfoOutput struct {
	TotalSize int64 // the total size, in bytes, of all File Storage files
	FileCount int64 // the number of files in the File Storage
}

GetStorageFileInfoOutput holds the result of GetStorageFileInfo.

type GetSubscriberInfoInput added in v0.3.0 

type GetSubscriberInfoInput struct {
	ListName          string // required; may include the Domain name
	SubscriberAddress string // required
}

GetSubscriberInfoInput retrieves information about one mailing list subscriber.

type GetSubscriberInfoOutput added in v0.3.0 

type GetSubscriberInfoOutput struct {
	Info cgpdata.Dictionary
}

GetSubscriberInfoOutput holds the result of GetSubscriberInfo. Info is empty if SubscriberAddress is not a subscriber; otherwise it holds mode, confirmationID, timeSubscribed, posts, and the optional bounces, lastBounced, RealName keys, per CLI.html.

type GetSystemInfoInput added in v0.3.0 

type GetSystemInfoInput struct {
	What string // required
}

GetSystemInfoInput requests one CG/PL SystemInfo() value, e.g. "serverVersion", "serverOS", "startTime" (see CGPL.md's SystemInfo function for the full, case-insensitive set of supported values).

type GetSystemInfoOutput added in v0.3.0 

type GetSystemInfoOutput struct {
	Info cgpdata.Value
}

GetSystemInfoOutput holds the result of GetSystemInfo: whatever object CG/PL's SystemInfo(What) returned - a String, a TimeStamp, ... depending on What.

type GetTempBlacklistedIPsInput added in v0.3.0 

type GetTempBlacklistedIPsInput struct{}

GetTempBlacklistedIPsInput reads the set of Temporarily Blocked Addresses.

type GetTempBlacklistedIPsOutput added in v0.3.0 

type GetTempBlacklistedIPsOutput struct {
	Addresses string // comma-separated
}

GetTempBlacklistedIPsOutput holds the result of GetTempBlacklistedIPs. Each address may carry a "-nnnn" suffix: the number of seconds of blocking remaining, or "*" for a permanent block.

type GetTempClientIPsInput added in v0.3.0 

type GetTempClientIPsInput struct{}

GetTempClientIPsInput reads the set of temporary Client IP Addresses.

type GetTempClientIPsOutput added in v0.3.0 

type GetTempClientIPsOutput struct {
	Addresses string // comma-separated
}

GetTempClientIPsOutput holds the result of GetTempClientIPs.

type GetTempUnblockableIPsInput added in v0.3.0 

type GetTempUnblockableIPsInput struct{}

GetTempUnblockableIPsInput reads the set of Temporary UnBlockable IP Addresses.

type GetTempUnblockableIPsOutput added in v0.3.0 

type GetTempUnblockableIPsOutput struct {
	Addresses string // comma-separated
}

GetTempUnblockableIPsOutput holds the result of GetTempUnblockableIPs. Each address may carry a "-nnnn" suffix: the number of seconds it remains in the set, or "*" for permanent presence.

type GetVersionInput added in v0.2.0 

type GetVersionInput struct{}

GetVersionInput reads the server version.

type GetVersionOutput added in v0.2.0 

type GetVersionOutput struct {
	Version string // e.g. "6.5.6"
}

GetVersionOutput holds the result of GetVersion.

type GetWhiteHoleIPsInput added in v0.3.0 

type GetWhiteHoleIPsInput struct{}

GetWhiteHoleIPsInput reads the Server-wide set of WhiteHole IP Addresses.

type GetWhiteHoleIPsOutput added in v0.3.0 

type GetWhiteHoleIPsOutput struct {
	Addresses string // a (multi-line) string of IP addresses and address ranges
}

GetWhiteHoleIPsOutput holds the result of GetWhiteHoleIPs.

type InsertDirectoryRecordsInput added in v0.3.0 

type InsertDirectoryRecordsInput struct {
	DomainName string // optional; empty applies to the authenticated user Domain
}

InsertDirectoryRecordsInput inserts Directory records for a domain's objects (Accounts, Groups, Mailing Lists, Forwarders).

type InsertDirectoryRecordsOutput added in v0.3.0 

type InsertDirectoryRecordsOutput struct{}

InsertDirectoryRecordsOutput holds the result of InsertDirectoryRecords.

type KillAccountSessionsInput added in v0.3.0 

type KillAccountSessionsInput struct {
	AccountName                   string // required
	CheckAccountUsage             bool   // optional: verify the Account is no longer in use once its sessions are terminated
	IncludeAccountWebAuthSessions bool   // optional: also terminate active and inactive WebAuth sessions
}

KillAccountSessionsInput interrupts all of an account's sessions (POP, IMAP, FTP, WebUser, ...).

type KillAccountSessionsOutput added in v0.3.0 

type KillAccountSessionsOutput struct{}

KillAccountSessionsOutput holds the result of KillAccountSessions.

type KillAccountWebAuthSessionInput added in v0.3.0 

type KillAccountWebAuthSessionInput struct {
	AccountName string // required; "*" names the current authenticated Account
	WebAuthID   string // required
}

KillAccountWebAuthSessionInput terminates a Web Auth Session. It also terminates any related XIMSS sessions.

type KillAccountWebAuthSessionOutput added in v0.3.0 

type KillAccountWebAuthSessionOutput struct{}

KillAccountWebAuthSessionOutput holds the result of KillAccountWebAuthSession.

type KillNodeInput added in v0.3.0 

type KillNodeInput struct {
	TaskID string // required
}

KillNodeInput kills an existing PBX Task.

type KillNodeOutput added in v0.3.0 

type KillNodeOutput struct{}

KillNodeOutput holds the result of KillNode.

type KillSessionInput added in v0.3.0 

type KillSessionInput struct {
	SessionID  string // required
	DomainName string // optional; the Domain the session's Account belongs to
}

KillSessionInput terminates a Session.

type KillSessionOutput added in v0.3.0 

type KillSessionOutput struct{}

KillSessionOutput holds the result of KillSession.

type ListAccountNamedTasksInput added in v0.3.0 

type ListAccountNamedTasksInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

ListAccountNamedTasksInput lists the Named Tasks owned by an account.

type ListAccountNamedTasksOutput added in v0.3.0 

type ListAccountNamedTasksOutput struct {
	Tasks cgpdata.Dictionary
}

ListAccountNamedTasksOutput holds the result of ListAccountNamedTasks: a dictionary with the same shape as ListDomainNamedTasksOutput.Tasks.

type ListAccountSessionsInput added in v0.3.0 

type ListAccountSessionsInput struct {
	AccountName     string // required
	IPAddress       string // optional
	ProxiedAddress  string // optional; only meaningful together with IPAddress
	Protocol        string // optional bare keyword
	Transport       string // optional bare keyword
	Client          string // optional
	IncludeDelegate bool   // optional
}

ListAccountSessionsInput lists all existing sessions belonging to an Account. Its fields have the same meaning as FindAccountSessionInput.

type ListAccountSessionsOutput added in v0.3.0 

type ListAccountSessionsOutput struct {
	Sessions cgpdata.Array
}

ListAccountSessionsOutput holds the result of ListAccountSessions.

type ListAccountStorageInput added in v0.3.0 

type ListAccountStorageInput struct {
	DomainName string // required
}

ListAccountStorageInput lists a domain's Account "storage mount points".

type ListAccountStorageOutput added in v0.3.0 

type ListAccountStorageOutput struct {
	Storage cgpdata.Array
}

ListAccountStorageOutput holds the result of ListAccountStorage.

type ListAccountWebAuthSessionsInput added in v0.3.0 

type ListAccountWebAuthSessionsInput struct {
	AccountName string // required; "*" names the current authenticated Account
	ActiveOnly  bool   // optional; only return WebAuth session IDs that have active sessions
}

ListAccountWebAuthSessionsInput lists the Web Auth sessions of an Account.

type ListAccountWebAuthSessionsOutput added in v0.3.0 

type ListAccountWebAuthSessionsOutput struct {
	Sessions cgpdata.Array
}

ListAccountWebAuthSessionsOutput holds the result of ListAccountWebAuthSessions.

type ListAccountsInput 

type ListAccountsInput struct {
	DomainName string // optional; empty lists across every accessible domain
}

ListAccountsInput lists accounts, optionally restricted to one domain.

type ListAccountsOutput 

type ListAccountsOutput struct {
	Accounts cgpdata.Array
}

ListAccountsOutput holds the result of ListAccounts.

type ListAdminDomainsInput added in v0.3.0 

type ListAdminDomainsInput struct {
	DomainName string // optional; empty applies to the authenticated user Domain
}

ListAdminDomainsInput lists the Domains that can be administered by Domain Administrator Accounts in a Domain.

type ListAdminDomainsOutput added in v0.3.0 

type ListAdminDomainsOutput struct {
	Domains cgpdata.Array
}

ListAdminDomainsOutput holds the result of ListAdminDomains.

type ListCLICommandsInput added in v0.3.0 

type ListCLICommandsInput struct{}

ListCLICommandsInput reads the list of CLI commands this server version supports.

type ListCLICommandsOutput added in v0.3.0 

type ListCLICommandsOutput struct {
	Commands cgpdata.Array // an Array of String command names
}

ListCLICommandsOutput holds the result of ListCLICommands.

type ListClusterPBXFilesInput added in v0.3.0 

type ListClusterPBXFilesInput struct {
	Language string // optional; a national subset name
}

ListClusterPBXFilesInput lists the files in the cluster-wide Real-Time Application Environment, or (with Language) one of its national subsets. Available in the Dynamic Cluster only, to System Administrators.

type ListClusterPBXFilesOutput added in v0.3.0 

type ListClusterPBXFilesOutput struct {
	Files cgpdata.Dictionary
}

ListClusterPBXFilesOutput holds the result of ListClusterPBXFiles: a dictionary with file names as keys, whose values are dictionaries of file attributes.

type ListClusterSkinFilesInput added in v0.3.0 

type ListClusterSkinFilesInput struct {
	SkinName string // required
}

ListClusterSkinFilesInput lists the files in a cluster-wide Skin, in place of LISTSERVERSKINFILES. This command is available in the Dynamic Cluster only.

type ListClusterSkinFilesOutput added in v0.3.0 

type ListClusterSkinFilesOutput struct {
	Files cgpdata.Dictionary // Skin file names to dictionaries of file attributes
}

ListClusterSkinFilesOutput holds the result of ListClusterSkinFiles.

type ListClusterSkinsInput added in v0.3.0 

type ListClusterSkinsInput struct{}

ListClusterSkinsInput lists custom cluster-wide Skins. This command is available in the Dynamic Cluster only, in place of LISTSERVERSKINS.

type ListClusterSkinsOutput added in v0.3.0 

type ListClusterSkinsOutput struct {
	Skins cgpdata.Array
}

ListClusterSkinsOutput holds the result of ListClusterSkins.

type ListClusterTelnumsInput added in v0.3.0 

type ListClusterTelnumsInput struct {
	Limit  int    // required; the maximum number of Telnum numbers to return
	Filter string // optional
}

ListClusterTelnumsInput lists Telnum numbers created in shared Cluster Domains, optionally filtered, in pages bounded by Limit.

type ListClusterTelnumsOutput added in v0.3.0 

type ListClusterTelnumsOutput struct {
	Telnums cgpdata.Dictionary
}

ListClusterTelnumsOutput holds the result of ListClusterTelnums. Each key in Telnums is a Telnum number, with the Account name it is assigned to as its value; an additional numeric element under the empty ("") key holds the total number of Telnum numbers created.

type ListDeletionsInput added in v0.3.0 

type ListDeletionsInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

ListDeletionsInput lists the Messages in an account's Deletions Mailbox.

type ListDeletionsOutput added in v0.3.0 

type ListDeletionsOutput struct {
	Messages cgpdata.Dictionary
}

ListDeletionsOutput holds the result of ListDeletions. Messages is a Dictionary with each deleted Message's Return-Path, Date, Subject, and UID headers.

type ListDirectoryUnitsInput added in v0.3.0 

type ListDirectoryUnitsInput struct {
	Shared bool // optional; if true, lists cluster-wide Units instead of local ones
}

ListDirectoryUnitsInput lists Directory Units.

type ListDirectoryUnitsOutput added in v0.3.0 

type ListDirectoryUnitsOutput struct {
	Units cgpdata.Dictionary
}

ListDirectoryUnitsOutput holds the result of ListDirectoryUnits: a dictionary whose keys are Directory Unit mount points and whose values are Directory Unit names.

type ListDomainNamedTasksInput added in v0.3.0 

type ListDomainNamedTasksInput struct {
	DomainName string // optional; empty applies to the administrator Domain
}

ListDomainNamedTasksInput lists the Named Tasks in a domain.

type ListDomainNamedTasksOutput added in v0.3.0 

type ListDomainNamedTasksOutput struct {
	Tasks cgpdata.Dictionary
}

ListDomainNamedTasksOutput holds the result of ListDomainNamedTasks: a dictionary keyed by Named Task name, whose values are dictionaries containing the task owner name, the task Real Name, and the name of the Real-Time Application program the Named Task runs.

type ListDomainObjectsInput 

type ListDomainObjectsInput struct {
	DomainName string // required
	Limit      int    // required; the server returns at most this many objects per call
	Filter     string // optional
	What       string // optional bare keyword restricting which object kinds are returned
	Cookie     string // optional; continues a previous paged listing
}

ListDomainObjectsInput lists Directory objects (accounts, forwarders, group objects, ...) within a domain, optionally filtered, in pages bounded by Limit.

type ListDomainObjectsOutput 

type ListDomainObjectsOutput struct {
	Objects cgpdata.Array
}

ListDomainObjectsOutput holds the result of ListDomainObjects.

type ListDomainPBXFilesInput added in v0.3.0 

type ListDomainPBXFilesInput struct {
	DomainName string // optional; empty applies to the administrator Domain
	Language   string // optional; a national subset name
}

ListDomainPBXFilesInput lists the files in the Domain Real-Time Application Environment, or (with Language) one of its national subsets.

type ListDomainPBXFilesOutput added in v0.3.0 

type ListDomainPBXFilesOutput struct {
	Files cgpdata.Dictionary
}

ListDomainPBXFilesOutput holds the result of ListDomainPBXFiles: a dictionary with file names as keys, whose values are dictionaries of file attributes.

type ListDomainSkinFilesInput added in v0.3.0 

type ListDomainSkinFilesInput struct {
	DomainName string // optional; empty applies to the administrator Domain
	SkinName   string // "" names the unnamed Skin
}

ListDomainSkinFilesInput lists the files in a custom Domain Skin.

type ListDomainSkinFilesOutput added in v0.3.0 

type ListDomainSkinFilesOutput struct {
	Files cgpdata.Dictionary // Skin file names to dictionaries of file attributes
}

ListDomainSkinFilesOutput holds the result of ListDomainSkinFiles.

type ListDomainSkinsInput added in v0.2.0 

type ListDomainSkinsInput struct {
	DomainName string // optional; empty applies to the administrator Domain
}

ListDomainSkinsInput lists a domain's custom Skins.

type ListDomainSkinsOutput added in v0.2.0 

type ListDomainSkinsOutput struct {
	Skins cgpdata.Array
}

ListDomainSkinsOutput holds the result of ListDomainSkins.

type ListDomainStorageInput added in v0.3.0 

type ListDomainStorageInput struct {
	Shared bool // optional: list "storage mount points" for Cluster Domains in a Dynamic Cluster
}

ListDomainStorageInput lists "storage mount points" for Domains.

type ListDomainStorageOutput added in v0.3.0 

type ListDomainStorageOutput struct {
	StoragePaths cgpdata.Array
}

ListDomainStorageOutput holds the result of ListDomainStorage.

type ListDomainTelnumsInput 

type ListDomainTelnumsInput struct {
	DomainName string // required
	Limit      int    // required
	Filter     string // optional
}

ListDomainTelnumsInput lists telephone numbers registered within a domain, optionally filtered, in pages bounded by Limit.

type ListDomainTelnumsOutput 

type ListDomainTelnumsOutput struct {
	Telnums cgpdata.Array
}

ListDomainTelnumsOutput holds the result of ListDomainTelnums.

type ListDomainsInput added in v0.2.0 

type ListDomainsInput struct{}

ListDomainsInput lists all server domains.

type ListDomainsOutput added in v0.2.0 

type ListDomainsOutput struct {
	Domains cgpdata.Array
}

ListDomainsOutput holds the result of ListDomains.

type ListForwardersInput added in v0.3.0 

type ListForwardersInput struct {
	DomainName string // optional; empty applies to the administrator Domain
}

ListForwardersInput lists Forwarders, optionally restricted to one domain.

type ListForwardersOutput added in v0.3.0 

type ListForwardersOutput struct {
	Forwarders cgpdata.Array
}

ListForwardersOutput holds the result of ListForwarders.

type ListGroupsInput added in v0.3.0 

type ListGroupsInput struct {
	DomainName string // optional; empty applies to the administrator Domain
}

ListGroupsInput lists the Groups within a domain.

type ListGroupsOutput added in v0.3.0 

type ListGroupsOutput struct {
	Groups cgpdata.Array
}

ListGroupsOutput holds the result of ListGroups.

type ListListsInput added in v0.3.0 

type ListListsInput struct {
	DomainName string // optional; empty applies to the administrator Domain
}

ListListsInput lists the mailing lists defined in a Domain.

type ListListsOutput added in v0.3.0 

type ListListsOutput struct {
	Lists cgpdata.Array // each element is a mailing list name string
}

ListListsOutput holds the result of ListLists.

type ListLiteSessionsInput added in v0.3.0 

type ListLiteSessionsInput struct {
	IPAddress      string // optional
	ProxiedAddress string // optional; only meaningful together with IPAddress
}

ListLiteSessionsInput lists all existing LITE sessions.

type ListLiteSessionsOutput added in v0.3.0 

type ListLiteSessionsOutput struct {
	Sessions cgpdata.Array
}

ListLiteSessionsOutput holds the result of ListLiteSessions.

type ListMailboxesInput added in v0.3.0 

type ListMailboxesInput struct {
	AccountName     string // required; "*" names the current authenticated Account
	Filter          string // optional; IMAP LIST-style wildcards ("*" and "%"); empty means "*"
	AuthAccountName string // optional: only list Mailboxes with the Lookup right for this Account
}

ListMailboxesInput lists an Account's Mailboxes, optionally filtered and restricted to those visible to another Account.

type ListMailboxesOutput added in v0.3.0 

type ListMailboxesOutput struct {
	Mailboxes cgpdata.Dictionary
}

ListMailboxesOutput holds the result of ListMailboxes. Mailboxes maps each Mailbox name to a Dictionary of Mailbox information, or to an empty Array when the caller (per AuthAccountName) lacks the Select right, or when the name is a 'mailbox folder' rather than a 'regular' Mailbox.

type ListModulesInput added in v0.3.0 

type ListModulesInput struct{}

ListModulesInput lists all Server modules.

type ListModulesOutput added in v0.3.0 

type ListModulesOutput struct {
	Modules cgpdata.Array
}

ListModulesOutput holds the result of ListModules.

type ListServerPBXFilesInput added in v0.3.0 

type ListServerPBXFilesInput struct {
	Language string // optional; a national subset name
}

ListServerPBXFilesInput lists the files in the Server-wide Real-Time Application Environment, or (with Language) one of its national subsets. Available to System Administrators only.

type ListServerPBXFilesOutput added in v0.3.0 

type ListServerPBXFilesOutput struct {
	Files cgpdata.Dictionary
}

ListServerPBXFilesOutput holds the result of ListServerPBXFiles: a dictionary with file names as keys, whose values are dictionaries of file attributes.

type ListServerSkinFilesInput added in v0.3.0 

type ListServerSkinFilesInput struct {
	SkinName string // required
}

ListServerSkinFilesInput lists the files in a custom Server Skin.

type ListServerSkinFilesOutput added in v0.3.0 

type ListServerSkinFilesOutput struct {
	Files cgpdata.Dictionary // Skin file names to dictionaries of file attributes
}

ListServerSkinFilesOutput holds the result of ListServerSkinFiles.

type ListServerSkinsInput added in v0.3.0 

type ListServerSkinsInput struct{}

ListServerSkinsInput lists custom Server Skins.

type ListServerSkinsOutput added in v0.3.0 

type ListServerSkinsOutput struct {
	Skins cgpdata.Array
}

ListServerSkinsOutput holds the result of ListServerSkins.

type ListServerTelnumsInput added in v0.3.0 

type ListServerTelnumsInput struct {
	Limit  int    // required; the maximum number of Telnum numbers to return
	Filter string // optional
}

ListServerTelnumsInput lists Telnum numbers created in all (non-clustered) Domains, optionally filtered, in pages bounded by Limit.

type ListServerTelnumsOutput added in v0.3.0 

type ListServerTelnumsOutput struct {
	Telnums cgpdata.Dictionary
}

ListServerTelnumsOutput holds the result of ListServerTelnums. Each key in Telnums is a Telnum number, with the Account name it is assigned to as its value; an additional numeric element under the empty ("") key holds the total number of Telnum numbers created.

type ListStockPBXFilesInput added in v0.3.0 

type ListStockPBXFilesInput struct {
	Language string // optional; a national subset name
}

ListStockPBXFilesInput lists the files in the stock (built-in) Real-Time Application Environment, or (with Language) one of its national subsets.

type ListStockPBXFilesOutput added in v0.3.0 

type ListStockPBXFilesOutput struct {
	Files cgpdata.Dictionary
}

ListStockPBXFilesOutput holds the result of ListStockPBXFiles: a dictionary with file names as keys, whose values are dictionaries of file attributes.

type ListStockSkinFilesInput added in v0.3.0 

type ListStockSkinFilesInput struct {
	SkinName string // required
}

ListStockSkinFilesInput lists the files in a built-in (stock) Skin, in place of LISTSERVERSKINFILES.

type ListStockSkinFilesOutput added in v0.3.0 

type ListStockSkinFilesOutput struct {
	Files cgpdata.Dictionary // Skin file names to dictionaries of file attributes
}

ListStockSkinFilesOutput holds the result of ListStockSkinFiles.

type ListStorageFilesInput added in v0.3.0 

type ListStorageFilesInput struct {
	AccountName     string // required; "*" names the current authenticated Account
	FilePath        string // optional; empty lists the top File Storage directory
	AuthAccountName string // optional: run the command on behalf of this Account
}

ListStorageFilesInput lists the files in the Account File Storage top directory, or in one of its subdirectories.

type ListStorageFilesOutput added in v0.3.0 

type ListStorageFilesOutput struct {
	Files cgpdata.Dictionary
}

ListStorageFilesOutput holds the result of ListStorageFiles. Files maps each File Storage file name to a Dictionary of its attributes; a subdirectory's value is an empty Array instead.

type ListSubscribersInput added in v0.3.0 

type ListSubscribersInput struct {
	ListName string // required; may include the Domain name
	Filter   string // optional: only addresses containing this string are returned
	Limit    int    // optional; 0 omits the limit, returning every matching address
}

ListSubscribersInput retrieves the E-mail addresses of a mailing list's subscribers.

type ListSubscribersOutput added in v0.3.0 

type ListSubscribersOutput struct {
	Subscribers cgpdata.Array // each element is a subscriber E-mail address string
}

ListSubscribersOutput holds the result of ListSubscribers.

type MainDomainNameInput added in v0.2.0 

type MainDomainNameInput struct{}

MainDomainNameInput reads the name of the Main Domain.

type MainDomainNameOutput added in v0.2.0 

type MainDomainNameOutput struct {
	Name string
}

MainDomainNameOutput holds the result of MainDomainName.

type ModifyAccountTelnumsInput added in v0.3.0 

type ModifyAccountTelnumsInput struct {
	AccountName string // required; "*" names the current authenticated Account
	Op          string // required bare op string: "add", "del", or "pop"
	Telnum      string // required for "add"/"del"; ignored for "pop"
}

ModifyAccountTelnumsInput atomically adds, removes, or pops a single telephone number from an account's assigned Telnum set.

type ModifyAccountTelnumsOutput added in v0.3.0 

type ModifyAccountTelnumsOutput struct {
	Telnum string
}

ModifyAccountTelnumsOutput holds the result of ModifyAccountTelnums. Telnum is set only when Input.Op is "pop" and the account's Telnum set was not empty.

type NoopInput added in v0.3.0 

type NoopInput struct{}

NoopInput runs the NOOP command, which always completes successfully.

type NoopOutput added in v0.3.0 

type NoopOutput struct{}

NoopOutput holds the result of Noop.

type Options 

type Options struct {
	// Addr is the "host:port" of the PWD/CLI server. Required.
	Addr string
	// Login and Password authenticate the session. Both required.
	// Password is kept for the Client's whole lifetime (not just
	// during the initial handshake) to support transparent
	// auto-reconnect.
	Login    string
	Password string

	// TLS selects the transport security mode.
	//
	// It defaults to NoTLS, which is not a secure default and is only
	// the zero value for backwards compatibility. With NoTLS every
	// command and every response of this administrative session crosses
	// the network in clear text, and the server is not authenticated at
	// all, so an attacker positioned on the path can read the traffic,
	// alter commands, or impersonate the server.
	//
	// The login exchange is the one part not necessarily sent as clear
	// text, and it is no protection by itself. Under the default
	// AutoSecureLogin the password is not put on the wire: APOP is used
	// instead, so what crosses is the server's challenge and an MD5
	// digest over it - captured just as easily as the rest, and
	// attackable offline to recover the password. CRAMMD5Login is
	// challenge-response in the same way. PlainLogin, however, sends
	// the password itself in clear text, so combining it with NoTLS
	// exposes the credential directly.
	//
	// Set ImplicitTLS (conventionally port 1106) or StartTLS on any
	// connection that is not a loopback socket, and leave certificate
	// verification enabled.
	TLS TLSMode
	// TLSConfig is used for both ImplicitTLS and StartTLS connections.
	// A nil value uses a zero-value tls.Config, which verifies the
	// server's certificate chain and host name - do not set
	// InsecureSkipVerify to work around a verification failure; supply
	// the issuing CA in RootCAs, or a ServerName that the certificate
	// actually covers, instead.
	//
	// ServerName, when unset, is derived from Addr's host for both
	// modes, including when that host is an IP literal (which is
	// matched against the certificate's IP SANs and, per RFC 6066,
	// never sent as SNI).
	TLSConfig *tls.Config

	// SecureLogin selects the authentication method. Defaults to
	// AutoSecureLogin.
	SecureLogin SecureLogin

	// DialTimeout bounds the initial TCP connect (and, for
	// ImplicitTLS, the TLS handshake). Zero means no timeout beyond
	// what ctx itself imposes.
	DialTimeout time.Duration

	// MaxResponseLine caps how many bytes one response line may occupy
	// before the Client gives up with [ErrResponseTooLarge], bounding
	// what a hostile or malfunctioning server can make it allocate.
	// Zero selects [DefaultMaxResponseLine]. Raise it only if a command
	// legitimately returns more - a very large file body through
	// READSTORAGEFILE, say, which arrives Base64-encoded inside the
	// response line.
	MaxResponseLine int
}

Options configures Dial.

type PostAccountAlertInput added in v0.3.0 

type PostAccountAlertInput struct {
	AccountName string // required; "*" names the current authenticated Account
	Alert       string // required
}

PostAccountAlertInput posts an Account alert message.

type PostAccountAlertOutput added in v0.3.0 

type PostAccountAlertOutput struct{}

PostAccountAlertOutput holds the result of PostAccountAlert.

type PostClusterAlertInput added in v0.3.0 

type PostClusterAlertInput struct {
	Alert string // required
}

PostClusterAlertInput posts a cluster-wide alert message. Available in the Dynamic Cluster only, in place of PostServerAlert.

type PostClusterAlertOutput added in v0.3.0 

type PostClusterAlertOutput struct{}

PostClusterAlertOutput holds the result of PostClusterAlert.

type PostDomainAlertInput added in v0.3.0 

type PostDomainAlertInput struct {
	DomainName string // required
	Alert      string // required
}

PostDomainAlertInput posts a Domain-wide alert message.

type PostDomainAlertOutput added in v0.3.0 

type PostDomainAlertOutput struct{}

PostDomainAlertOutput holds the result of PostDomainAlert.

type PostServerAlertInput added in v0.3.0 

type PostServerAlertInput struct {
	Alert string // required
}

PostServerAlertInput posts a server-wide alert message. Available to System Administrators only.

type PostServerAlertOutput added in v0.3.0 

type PostServerAlertOutput struct{}

PostServerAlertOutput holds the result of PostServerAlert.

type ProcessBounceInput added in v0.3.0 

type ProcessBounceInput struct {
	ListName          string // required; may include the Domain name
	SubscriberAddress string // required
	Fatal             bool   // optional: emulate a fatal bounce rather than a non-fatal one
}

ProcessBounceInput emulates the List Manager's handling of a bounce message for a subscriber address.

type ProcessBounceOutput added in v0.3.0 

type ProcessBounceOutput struct{}

ProcessBounceOutput holds the result of ProcessBounce.

type ReadClusterPBXFileInput added in v0.3.0 

type ReadClusterPBXFileInput struct {
	FileName string // required; "language/fileName" reads from a national subset
}

ReadClusterPBXFileInput reads a file from the cluster-wide Real-Time Application Environment. Available in the Dynamic Cluster only, to System Administrators.

type ReadClusterPBXFileOutput added in v0.3.0 

type ReadClusterPBXFileOutput struct {
	Content []byte
}

ReadClusterPBXFileOutput holds the result of ReadClusterPBXFile.

type ReadClusterSkinFileInput added in v0.3.0 

type ReadClusterSkinFileInput struct {
	SkinName string // required
	FileName string // required
}

ReadClusterSkinFileInput reads a file from a cluster-wide Skin, in place of READSERVERSKINFILE. This command is available in the Dynamic Cluster only.

type ReadClusterSkinFileOutput added in v0.3.0 

type ReadClusterSkinFileOutput struct {
	Content  []byte
	Modified cgpdata.TimeStamp
}

ReadClusterSkinFileOutput holds the result of ReadClusterSkinFile.

type ReadDomainPBXFileInput added in v0.3.0 

type ReadDomainPBXFileInput struct {
	DomainName string // required
	FileName   string // required; "language/fileName" reads from a national subset
}

ReadDomainPBXFileInput reads a file from the Domain Real-Time Application Environment.

type ReadDomainPBXFileOutput added in v0.3.0 

type ReadDomainPBXFileOutput struct {
	Content []byte
}

ReadDomainPBXFileOutput holds the result of ReadDomainPBXFile.

type ReadDomainSkinFileInput added in v0.2.0 

type ReadDomainSkinFileInput struct {
	DomainName string // optional; empty applies to the administrator Domain
	SkinName   string // "" names the unnamed Skin
	FileName   string // required
}

ReadDomainSkinFileInput reads a file from a custom Domain Skin.

type ReadDomainSkinFileOutput added in v0.2.0 

type ReadDomainSkinFileOutput struct {
	Content  []byte
	Modified cgpdata.TimeStamp
}

ReadDomainSkinFileOutput holds the result of ReadDomainSkinFile.

type ReadNodeStatusInput added in v0.3.0 

type ReadNodeStatusInput struct {
	TaskID string // required
}

ReadNodeStatusInput reads the current application status of an existing PBX Task.

type ReadNodeStatusOutput added in v0.3.0 

type ReadNodeStatusOutput struct {
	Status cgpdata.Dictionary
}

ReadNodeStatusOutput holds the result of ReadNodeStatus.

type ReadServerPBXFileInput added in v0.3.0 

type ReadServerPBXFileInput struct {
	FileName string // required; "language/fileName" reads from a national subset
}

ReadServerPBXFileInput reads a file from the Server-wide Real-Time Application Environment. Available to System Administrators only.

type ReadServerPBXFileOutput added in v0.3.0 

type ReadServerPBXFileOutput struct {
	Content []byte
}

ReadServerPBXFileOutput holds the result of ReadServerPBXFile.

type ReadServerSkinFileInput added in v0.3.0 

type ReadServerSkinFileInput struct {
	SkinName string // required
	FileName string // required
}

ReadServerSkinFileInput reads a file from a custom Server Skin.

type ReadServerSkinFileOutput added in v0.3.0 

type ReadServerSkinFileOutput struct {
	Content  []byte
	Modified cgpdata.TimeStamp
}

ReadServerSkinFileOutput holds the result of ReadServerSkinFile.

type ReadStockPBXFileInput added in v0.3.0 

type ReadStockPBXFileInput struct {
	FileName string // required; "language/fileName" reads from a national subset
}

ReadStockPBXFileInput reads a file from the stock (built-in) Real-Time Application Environment.

type ReadStockPBXFileOutput added in v0.3.0 

type ReadStockPBXFileOutput struct {
	Content []byte
}

ReadStockPBXFileOutput holds the result of ReadStockPBXFile.

type ReadStockSkinFileInput added in v0.3.0 

type ReadStockSkinFileInput struct {
	SkinName string // required
	FileName string // required
}

ReadStockSkinFileInput reads a file from a built-in (stock) Skin, in place of READSERVERSKINFILE.

type ReadStockSkinFileOutput added in v0.3.0 

type ReadStockSkinFileOutput struct {
	Content  []byte
	Modified cgpdata.TimeStamp
}

ReadStockSkinFileOutput holds the result of ReadStockSkinFile.

type ReadStorageFileAttrInput added in v0.3.0 

type ReadStorageFileAttrInput struct {
	AccountName     string        // required; "*" names the current authenticated Account
	FileName        string        // required
	Attributes      cgpdata.Array // optional: a list of String attribute names to retrieve; nil retrieves all
	AuthAccountName string        // optional: run the command on behalf of this Account
}

ReadStorageFileAttrInput reads attributes of an Account File Storage file or file directory.

type ReadStorageFileAttrOutput added in v0.3.0 

type ReadStorageFileAttrOutput struct {
	Attributes cgpdata.Array
}

ReadStorageFileAttrOutput holds the result of ReadStorageFileAttr. Attributes is an Array of XML elements, one per retrieved file or file directory attribute.

type ReadStorageFileInput added in v0.2.0 

type ReadStorageFileInput struct {
	AccountName string // required; "*" names the current authenticated Account
	FileName    string // required
}

ReadStorageFileInput retrieves a file from the Account File Storage.

type ReadStorageFileOutput added in v0.2.0 

type ReadStorageFileOutput struct {
	Content  []byte
	Modified cgpdata.TimeStamp
	Size     int64 // the file's current total size (Content may be a slice of it)
}

ReadStorageFileOutput holds the result of ReadStorageFile.

type ReadSubscribersInput added in v0.3.0 

type ReadSubscribersInput struct {
	ListName string // required; may include the Domain name
	Filter   string // optional: only subscribers whose address contains this string are returned
	Limit    int    // optional; 0 omits the limit, returning every matching descriptor
}

ReadSubscribersInput retrieves a mailing list's subscriber descriptors (richer than ListSubscribers' bare address list).

type ReadSubscribersOutput added in v0.3.0 

type ReadSubscribersOutput struct {
	Total       int64
	Subscribers cgpdata.Array
}

ReadSubscribersOutput holds the result of ReadSubscribers. Total is the list's total subscriber count (which may exceed len(Subscribers) when Limit truncated the result); each Subscribers element is a cgpdata.Dictionary with Sub, RealName, mode, subscribeTime, posts, lastBounceTime, and bounces keys, per CLI.html.

type ReconnectClusterAdminInput added in v0.3.0 

type ReconnectClusterAdminInput struct{}

ReconnectClusterAdminInput forces a Dynamic Cluster member to re-open all its inter-cluster Administrative connections (and, for a non-controller member, its Administrative connection to the Controller).

type ReconnectClusterAdminOutput added in v0.3.0 

type ReconnectClusterAdminOutput struct{}

ReconnectClusterAdminOutput holds the result of ReconnectClusterAdmin.

type RefreshOSDataInput added in v0.3.0 

type RefreshOSDataInput struct{}

RefreshOSDataInput makes the Server re-read the IP data from the server OS: the set of local IP addresses, and the set of DNS addresses.

type RefreshOSDataOutput added in v0.3.0 

type RefreshOSDataOutput struct{}

RefreshOSDataOutput holds the result of RefreshOSData.

type RejectQueueMessageInput added in v0.3.0 

type RejectQueueMessageInput struct {
	MessageID int64  // required
	ErrorText string // optional; "NONDN" suppresses the bounce report entirely
}

RejectQueueMessageInput rejects one message from the Server Queue.

type RejectQueueMessageOutput added in v0.3.0 

type RejectQueueMessageOutput struct{}

RejectQueueMessageOutput holds the result of RejectQueueMessage.

type RejectQueueMessagesInput added in v0.3.0 

type RejectQueueMessagesInput struct {
	AuthedSender string // required
	ErrorText    string // optional; "NONDN" suppresses the bounce report entirely
}

RejectQueueMessagesInput rejects every message sent by AuthedSender from the Server Queue; in a Dynamic Cluster environment this rejects messages from every server's queue.

type RejectQueueMessagesOutput added in v0.3.0 

type RejectQueueMessagesOutput struct{}

RejectQueueMessagesOutput holds the result of RejectQueueMessages.

type ReleaseSMTPQueueInput added in v0.3.0 

type ReleaseSMTPQueueInput struct {
	QueueName string // required
}

ReleaseSMTPQueueInput releases an SMTP queue; in a Dynamic Cluster environment this releases the named queue on every server.

type ReleaseSMTPQueueOutput added in v0.3.0 

type ReleaseSMTPQueueOutput struct{}

ReleaseSMTPQueueOutput holds the result of ReleaseSMTPQueue.

type ReloadDirectoryDomainsInput added in v0.3.0 

type ReloadDirectoryDomainsInput struct{}

ReloadDirectoryDomainsInput tells the server to scan the Domains Directory subtree for additional Directory-based Domains created directly in the Directory. This operation is allowed only when Directory-based Domains are enabled.

type ReloadDirectoryDomainsOutput added in v0.3.0 

type ReloadDirectoryDomainsOutput struct{}

ReloadDirectoryDomainsOutput holds the result of ReloadDirectoryDomains.

type ReloadPluginSkinsInput added in v0.3.0 

type ReloadPluginSkinsInput struct {
	DomainName string // optional; empty reloads Skins for all domains
}

ReloadPluginSkinsInput reloads Skin files of all domains, or of a single specified domain, from the installed plugins according to the current settings.

type ReloadPluginSkinsOutput added in v0.3.0 

type ReloadPluginSkinsOutput struct{}

ReloadPluginSkinsOutput holds the result of ReloadPluginSkins.

type RelocateDirectoryUnitInput added in v0.3.0 

type RelocateDirectoryUnitInput struct {
	UnitName      string // required
	NewMountPoint string // required
	Shared        bool   // optional; if true, UnitName names a cluster-wide Unit
}

RelocateDirectoryUnitInput re-mounts an existing Directory Unit on a different mount point.

type RelocateDirectoryUnitOutput added in v0.3.0 

type RelocateDirectoryUnitOutput struct{}

RelocateDirectoryUnitOutput holds the result of RelocateDirectoryUnit.

type RemoveAccountAlertInput added in v0.3.0 

type RemoveAccountAlertInput struct {
	AccountName string // required; "*" names the current authenticated Account
	TimeStamp   string // required; the time stamp of the alert to remove, as returned by GetAccountAlerts
}

RemoveAccountAlertInput removes an Account alert message.

type RemoveAccountAlertOutput added in v0.3.0 

type RemoveAccountAlertOutput struct{}

RemoveAccountAlertOutput holds the result of RemoveAccountAlert.

type RemoveAccountSearchIndexInput added in v0.3.0 

type RemoveAccountSearchIndexInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

RemoveAccountSearchIndexInput clears an account's Search Index. Search Index must be disabled for the account (or its domain) for the removal to take effect.

type RemoveAccountSearchIndexOutput added in v0.3.0 

type RemoveAccountSearchIndexOutput struct{}

RemoveAccountSearchIndexOutput holds the result of RemoveAccountSearchIndex.

type RemoveAccountSubsetInput added in v0.3.0 

type RemoveAccountSubsetInput struct {
	AccountName string // required; "*" names the current authenticated Account
	SubsetName  string // required; the name of an existing data subset in the Account
}

RemoveAccountSubsetInput removes an Account "dataset" (or a subset of one), such as the RepliedAddresses dataset.

type RemoveAccountSubsetOutput added in v0.3.0 

type RemoveAccountSubsetOutput struct{}

RemoveAccountSubsetOutput holds the result of RemoveAccountSubset.

type RemoveClusterAlertInput added in v0.3.0 

type RemoveClusterAlertInput struct {
	TimeStamp string // required; the time stamp of the alert to remove, as returned by GetClusterAlerts
}

RemoveClusterAlertInput removes a cluster-wide alert message. Available in the Dynamic Cluster only, in place of RemoveServerAlert.

type RemoveClusterAlertOutput added in v0.3.0 

type RemoveClusterAlertOutput struct{}

RemoveClusterAlertOutput holds the result of RemoveClusterAlert.

type RemoveDomainAlertInput added in v0.3.0 

type RemoveDomainAlertInput struct {
	DomainName string // required
	TimeStamp  string // required; the time stamp of the alert to remove, as returned by GetDomainAlerts
}

RemoveDomainAlertInput removes a Domain-wide alert message.

type RemoveDomainAlertOutput added in v0.3.0 

type RemoveDomainAlertOutput struct{}

RemoveDomainAlertOutput holds the result of RemoveDomainAlert.

type RemoveDomainSearchIndexInput added in v0.3.0 

type RemoveDomainSearchIndexInput struct {
	DomainName string // required
}

RemoveDomainSearchIndexInput clears the Search Index of every user in a domain. Search Index must be disabled in the Domain User Defaults for the removal to take effect for a given user.

type RemoveDomainSearchIndexOutput added in v0.3.0 

type RemoveDomainSearchIndexOutput struct{}

RemoveDomainSearchIndexOutput holds the result of RemoveDomainSearchIndex.

type RemovePluginInput added in v0.3.0 

type RemovePluginInput struct {
	PluginID string // required
}

RemovePluginInput removes an installed plugin.

type RemovePluginOutput added in v0.3.0 

type RemovePluginOutput struct{}

RemovePluginOutput holds the result of RemovePlugin.

type RemoveServerAlertInput added in v0.3.0 

type RemoveServerAlertInput struct {
	TimeStamp string // required; the time stamp of the alert to remove, as returned by GetServerAlerts
}

RemoveServerAlertInput removes a server-wide alert message. Available to System Administrators only.

type RemoveServerAlertOutput added in v0.3.0 

type RemoveServerAlertOutput struct{}

RemoveServerAlertOutput holds the result of RemoveServerAlert.

type RenameAccountInput 

type RenameAccountInput struct {
	OldAccountName string // required; "*" names the current authenticated Account
	NewAccountName string // required
	StoragePath    string // optional
}

RenameAccountInput renames an account, optionally relocating its storage.

type RenameAccountOutput 

type RenameAccountOutput struct{}

RenameAccountOutput holds the result of RenameAccount.

type RenameClusterSkinInput added in v0.3.0 

type RenameClusterSkinInput struct {
	OldSkinName string // required
	NewSkinName string // required
}

RenameClusterSkinInput renames an existing cluster-wide Skin, in place of RENAMESERVERSKIN. This command is available in the Dynamic Cluster only.

type RenameClusterSkinOutput added in v0.3.0 

type RenameClusterSkinOutput struct{}

RenameClusterSkinOutput holds the result of RenameClusterSkin.

type RenameDomainInput added in v0.3.0 

type RenameDomainInput struct {
	OldDomainName string // required
	NewDomainName string // required
	StoragePath   string // optional; new "storage mount point" directory name, without the .mnt suffix
}

RenameDomainInput renames a Domain, optionally relocating its storage.

type RenameDomainOutput added in v0.3.0 

type RenameDomainOutput struct{}

RenameDomainOutput holds the result of RenameDomain.

type RenameDomainSkinInput added in v0.3.0 

type RenameDomainSkinInput struct {
	DomainName  string // optional; empty applies to the administrator Domain
	OldSkinName string // required; must name an existing named Skin
	NewSkinName string // required
}

RenameDomainSkinInput renames an existing named Domain Skin. The unnamed Domain Skin cannot be renamed.

type RenameDomainSkinOutput added in v0.3.0 

type RenameDomainSkinOutput struct{}

RenameDomainSkinOutput holds the result of RenameDomainSkin.

type RenameForwarderInput added in v0.3.0 

type RenameForwarderInput struct {
	OldForwarderName string // required
	NewForwarderName string // required
}

RenameForwarderInput renames an existing Forwarder.

type RenameForwarderOutput added in v0.3.0 

type RenameForwarderOutput struct{}

RenameForwarderOutput holds the result of RenameForwarder.

type RenameGroupInput added in v0.3.0 

type RenameGroupInput struct {
	OldGroupName string // required; may include "@domain"
	NewGroupName string // required; may include "@domain"
}

RenameGroupInput renames an existing Group.

type RenameGroupOutput added in v0.3.0 

type RenameGroupOutput struct{}

RenameGroupOutput holds the result of RenameGroup.

type RenameListInput added in v0.3.0 

type RenameListInput struct {
	ListName string // required; may include the Domain name
	NewName  string // required; without the Domain part
}

RenameListInput renames a mailing list.

type RenameListOutput added in v0.3.0 

type RenameListOutput struct{}

RenameListOutput holds the result of RenameList.

type RenameMailboxInput added in v0.3.0 

type RenameMailboxInput struct {
	AccountName     string // required; "*" names the current authenticated Account
	OldMailboxName  string // required
	NewMailboxName  string // required
	Recursive       bool   // if true, use the MAILBOXES form: nested submailboxes are renamed, too
	AuthAccountName string // optional: run the command on behalf of this Account
}

RenameMailboxInput renames a Mailbox within an Account.

type RenameMailboxOutput added in v0.3.0 

type RenameMailboxOutput struct{}

RenameMailboxOutput holds the result of RenameMailbox.

type RenameNamedTaskInput added in v0.3.0 

type RenameNamedTaskInput struct {
	OldTaskName string // required; may include the Domain name
	NewTaskName string // required
}

RenameNamedTaskInput renames a Named Task.

type RenameNamedTaskOutput added in v0.3.0 

type RenameNamedTaskOutput struct{}

RenameNamedTaskOutput holds the result of RenameNamedTask.

type RenameServerSkinInput added in v0.3.0 

type RenameServerSkinInput struct {
	OldSkinName string // required
	NewSkinName string // required
}

RenameServerSkinInput renames an existing Server Skin.

type RenameServerSkinOutput added in v0.3.0 

type RenameServerSkinOutput struct{}

RenameServerSkinOutput holds the result of RenameServerSkin.

type RenameStorageFileInput added in v0.2.0 

type RenameStorageFileInput struct {
	AccountName string // required; "*" names the current authenticated Account
	OldFileName string // required
	NewFileName string // required
}

RenameStorageFileInput renames a file or directory in the Account File Storage.

type RenameStorageFileOutput added in v0.2.0 

type RenameStorageFileOutput struct{}

RenameStorageFileOutput holds the result of RenameStorageFile.

type ReportFailedLoginAddressInput added in v0.3.0 

type ReportFailedLoginAddressInput struct {
	Address string // required
}

ReportFailedLoginAddressInput increments the failed-Login-attempt counter for the given address, used by the Temporarily Blocked Addresses functionality.

type ReportFailedLoginAddressOutput added in v0.3.0 

type ReportFailedLoginAddressOutput struct{}

ReportFailedLoginAddressOutput holds the result of ReportFailedLoginAddress.

type ResetAccountStatInput added in v0.3.0 

type ResetAccountStatInput struct {
	AccountName string // required; "*" names the current authenticated Account
	Key         string // optional; the single statistical entry to reset; empty resets every entry
}

ResetAccountStatInput resets statistics data for an Account.

type ResetAccountStatOutput added in v0.3.0 

type ResetAccountStatOutput struct{}

ResetAccountStatOutput holds the result of ResetAccountStat.

type ResetDomainStatInput added in v0.3.0 

type ResetDomainStatInput struct {
	DomainName string // required; "*" names the Domain of the current authenticated Account
	Key        string // optional; the single statistical entry to reset; empty resets every entry
}

ResetDomainStatInput resets statistics data for a Domain.

type ResetDomainStatOutput added in v0.3.0 

type ResetDomainStatOutput struct{}

ResetDomainStatOutput holds the result of ResetDomainStat.

type ResetTotpSecretInput added in v0.3.0 

type ResetTotpSecretInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

ResetTotpSecretInput resets an account's TOTP secret.

type ResetTotpSecretOutput added in v0.3.0 

type ResetTotpSecretOutput struct{}

ResetTotpSecretOutput holds the result of ResetTotpSecret.

type Response 

type Response struct {
	Code    string
	Message string
}

Response is a parsed PWD/CLI protocol status line: a three-digit status code (or "+" for a SASL continuation) plus its message text.

type ResponseError 

type ResponseError struct {
	Code    string // e.g. "515"; empty if the server sent an unparseable status line
	Message string
	Command string
}

ResponseError reports a CommuniGate Pro PWD/CLI server response indicating failure: a status code outside the 2xx/3xx success range.

Command is only the command's first word (e.g. "SetAccountPassword", "PASS"), never the full line - several commands legitimately carry credentials as arguments (PASS, SetAccountPassword, ...), and the full line is deliberately never captured in an error to avoid leaking one into logs.

func (*ResponseError) Error 

func (e *ResponseError) Error() string

type RestoreDeletionInput added in v0.3.0 

type RestoreDeletionInput struct {
	AccountName string // required; "*" names the current authenticated Account
	UID         int    // required: the UID of the Message in the Deletions Mailbox
}

RestoreDeletionInput restores a single Message from an account's Deletions Mailbox into its Restored Mailbox.

type RestoreDeletionOutput added in v0.3.0 

type RestoreDeletionOutput struct{}

RestoreDeletionOutput holds the result of RestoreDeletion.

type ResumeDomainInput added in v0.3.0 

type ResumeDomainInput struct {
	DomainName string // required
}

ResumeDomainInput resumes a suspended domain, so Accounts can be opened in it again.

type ResumeDomainOutput added in v0.3.0 

type ResumeDomainOutput struct{}

ResumeDomainOutput holds the result of ResumeDomain.

type RosterInput added in v0.3.0 

type RosterInput struct {
	AccountName string             // required; "*" names the current authenticated Account
	Parameters  cgpdata.Dictionary // required
}

RosterInput manages an Account's Roster (its Instant Messaging contact/presence list). Parameters must contain a `what` string element naming the operation to apply: `List`, `Update`, `remove`, `Presence`, or `probe`. Every other Parameters element is operation-specific; see https://doc.communigatepro.ru/development/CLI.html#ROSTER for the full per-operation reference.

type RosterOutput added in v0.3.0 

type RosterOutput struct {
	Result cgpdata.Dictionary
}

RosterOutput holds the result of Roster: the operation results, shaped differently per Input.Parameters["what"] (see RosterInput).

type RouteInput added in v0.3.0 

type RouteInput struct {
	Address string // required
	Type    string // optional bare keyword: "mail", "access", or "signal"; the server defaults to "access"
}

RouteInput gets the CommuniGate Pro Router's routing for an address.

type RouteOutput added in v0.3.0 

type RouteOutput struct {
	Module  string // the module the address is routed to, or "SYSTEM" for a built-in destination
	Host    string // the object/queue handled by that module
	Address string // the address inside that queue
}

RouteOutput holds the result of Route.

type RunScriptInput added in v0.3.0 

type RunScriptInput struct {
	AccountName string        // required; may include "@domain" - the current user Domain is used if omitted; "*" names the current authenticated Account
	ProgramName string        // required; the name of the .scgp file to run
	EntryName   string        // optional; the script entry point ("main" is used if omitted)
	Parameter   cgpdata.Value // optional; the script reads it via Vars().startParameter
}

RunScriptInput runs a Synchronous Script (.scgp file) on behalf of an account.

type RunScriptOutput added in v0.3.0 

type RunScriptOutput struct {
	Result cgpdata.Value
}

RunScriptOutput holds the result of RunScript: the synchronous script's resulting object, whose shape is determined by the script itself.

type SearchInIndexInput added in v0.3.0 

type SearchInIndexInput struct {
	AccountName  string             // required
	SearchString string             // required; supports the server's Query Syntax
	UTF8         bool               // optional: convert results stored in UTF7-IMAP format to UTF-8
	Options      cgpdata.Dictionary // optional
}

SearchInIndexInput searches an account's Search Index for a query string.

type SearchInIndexOutput added in v0.3.0 

type SearchInIndexOutput struct {
	Results cgpdata.Dictionary
}

SearchInIndexOutput holds the result of SearchInIndex: the search results dictionary described in the XIMSS searchResult section.

type SecureLogin 

type SecureLogin int

SecureLogin selects the authentication method Dial uses. 

const (
	// AutoSecureLogin picks APOP when the transport is not (yet)
	// encrypted, or PLAIN once TLS is already established (ImplicitTLS
	// or StartTLS): APOP works under any server-side password-storage
	// policy, and sending PLAIN in the clear is only avoided when the
	// transport isn't already encrypting it anyway. This is the zero
	// value/default; an explicit SecureLogin value is always honored
	// exactly as given, on any transport.
	AutoSecureLogin SecureLogin = iota
	// PlainLogin sends the password itself as a command argument. It is
	// safe only once the transport encrypts it: set explicitly together
	// with NoTLS, it puts the password on the network in clear text,
	// which neither APOPLogin nor CRAMMD5Login does.
	PlainLogin
	// APOPLogin answers the challenge in the server's greeting with an
	// MD5 digest, so the password is not sent. Over NoTLS the challenge
	// and the digest are still readable on the path and can be attacked
	// offline to recover the password.
	APOPLogin
	// CRAMMD5Login is challenge-response as well (HMAC-MD5), so it does
	// not send the password either, with the same caveat as APOPLogin
	// over an unencrypted transport.
	CRAMMD5Login
)

func (SecureLogin) String 

func (s SecureLogin) String() string

type SendTaskEventInput added in v0.3.0 

type SendTaskEventInput struct {
	TaskID    string        // required
	EventName string        // required
	Param     cgpdata.Value // optional
}

SendTaskEventInput sends an Event to an existing PBX Task.

type SendTaskEventOutput added in v0.3.0 

type SendTaskEventOutput struct{}

SendTaskEventOutput holds the result of SendTaskEvent.

type SetAccountACLInput added in v0.3.0 

type SetAccountACLInput struct {
	AccountName     string             // required; "*" names the current authenticated Account
	AuthAccountName string             // optional: only apply the update if this Account has the Admin right on AccountName
	ACL             cgpdata.Dictionary // required
}

SetAccountACLInput modifies the Access Control List governing an account's Access Rights.

type SetAccountACLOutput added in v0.3.0 

type SetAccountACLOutput struct{}

SetAccountACLOutput holds the result of SetAccountACL.

type SetAccountAlertsInput added in v0.3.0 

type SetAccountAlertsInput struct {
	AccountName string             // required; "*" names the current authenticated Account
	Alerts      cgpdata.Dictionary // required
}

SetAccountAlertsInput replaces an Account's entire alert dictionary.

type SetAccountAlertsOutput added in v0.3.0 

type SetAccountAlertsOutput struct{}

SetAccountAlertsOutput holds the result of SetAccountAlerts.

type SetAccountAliasesInput added in v0.3.0 

type SetAccountAliasesInput struct {
	AccountName string        // required; "*" names the current authenticated Account
	Aliases     cgpdata.Array // required
}

SetAccountAliasesInput replaces an account's entire set of alias names with Aliases.

type SetAccountAliasesOutput added in v0.3.0 

type SetAccountAliasesOutput struct{}

SetAccountAliasesOutput holds the result of SetAccountAliases.

type SetAccountDefaultPrefsInput added in v0.3.0 

type SetAccountDefaultPrefsInput struct {
	DomainName string             // optional; empty applies to the authenticated user Domain
	Settings   cgpdata.Dictionary // required
}

SetAccountDefaultPrefsInput replaces a domain's entire Default Account Preferences with Settings.

type SetAccountDefaultPrefsOutput added in v0.3.0 

type SetAccountDefaultPrefsOutput struct{}

SetAccountDefaultPrefsOutput holds the result of SetAccountDefaultPrefs.

type SetAccountDefaultsInput added in v0.3.0 

type SetAccountDefaultsInput struct {
	DomainName string             // optional; empty applies to the administrator Domain
	Settings   cgpdata.Dictionary // required
}

SetAccountDefaultsInput replaces a domain's entire Default Account settings with Settings.

type SetAccountDefaultsOutput added in v0.3.0 

type SetAccountDefaultsOutput struct{}

SetAccountDefaultsOutput holds the result of SetAccountDefaults.

type SetAccountMailRulesInput added in v0.3.0 

type SetAccountMailRulesInput struct {
	AccountName string        // required; "*" names the current authenticated Account
	Rules       cgpdata.Array // required
}

SetAccountMailRulesInput replaces an account's entire set of Queue Rules with Rules.

type SetAccountMailRulesOutput added in v0.3.0 

type SetAccountMailRulesOutput struct{}

SetAccountMailRulesOutput holds the result of SetAccountMailRules.

type SetAccountPasswordInput 

type SetAccountPasswordInput struct {
	AccountName string // required; "*" names the current authenticated Account
	NewPassword string // required
	Method      string // optional bare keyword, e.g. "CLEAR"
	Check       bool   // optional: verify NewPassword meets the domain's password-strength policy before setting it
}

SetAccountPasswordInput sets an account's password.

type SetAccountPasswordOutput 

type SetAccountPasswordOutput struct{}

SetAccountPasswordOutput holds the result of SetAccountPassword.

type SetAccountPrefsInput added in v0.3.0 

type SetAccountPrefsInput struct {
	AccountName string             // required; "*" names the current authenticated Account
	Settings    cgpdata.Dictionary // required
}

SetAccountPrefsInput replaces an account's entire stored Preferences with Settings.

type SetAccountPrefsOutput added in v0.3.0 

type SetAccountPrefsOutput struct{}

SetAccountPrefsOutput holds the result of SetAccountPrefs.

type SetAccountRIMAPsInput added in v0.3.0 

type SetAccountRIMAPsInput struct {
	AccountName string             // required; "*" names the current authenticated Account
	Records     cgpdata.Dictionary // required
}

SetAccountRIMAPsInput replaces an account's entire set of RIMAP records with Records.

type SetAccountRIMAPsOutput added in v0.3.0 

type SetAccountRIMAPsOutput struct{}

SetAccountRIMAPsOutput holds the result of SetAccountRIMAPs.

type SetAccountRPOPsInput added in v0.3.0 

type SetAccountRPOPsInput struct {
	AccountName string             // required; "*" names the current authenticated Account
	Records     cgpdata.Dictionary // required
}

SetAccountRPOPsInput replaces an account's entire set of RPOP records with Records.

type SetAccountRPOPsOutput added in v0.3.0 

type SetAccountRPOPsOutput struct{}

SetAccountRPOPsOutput holds the result of SetAccountRPOPs.

type SetAccountRSIPsInput added in v0.3.0 

type SetAccountRSIPsInput struct {
	AccountName string             // required; "*" names the current authenticated Account
	Records     cgpdata.Dictionary // required
}

SetAccountRSIPsInput replaces an account's entire set of RSIP records with Records.

type SetAccountRSIPsOutput added in v0.3.0 

type SetAccountRSIPsOutput struct{}

SetAccountRSIPsOutput holds the result of SetAccountRSIPs.

type SetAccountRightsInput added in v0.3.0 

type SetAccountRightsInput struct {
	AccountName string        // required; "*" names the current authenticated Account
	Rights      cgpdata.Array // required; replaces all of the account's old Access Rights
}

SetAccountRightsInput sets an account's Server (or Domain Administration) Access Rights, from the "Access Rights Administration" CLI.html category.

type SetAccountRightsOutput added in v0.3.0 

type SetAccountRightsOutput struct{}

SetAccountRightsOutput holds the result of SetAccountRights.

type SetAccountSettingsInput 

type SetAccountSettingsInput struct {
	AccountName string             // required; "*" names the current authenticated Account
	Settings    cgpdata.Dictionary // required
}

SetAccountSettingsInput replaces an account's entire stored settings with Settings.

type SetAccountSettingsOutput 

type SetAccountSettingsOutput struct{}

SetAccountSettingsOutput holds the result of SetAccountSettings.

type SetAccountSignalRulesInput added in v0.3.0 

type SetAccountSignalRulesInput struct {
	AccountName string        // required; "*" names the current authenticated Account
	Rules       cgpdata.Array // required
}

SetAccountSignalRulesInput replaces an account's entire set of Signal Rules with Rules.

type SetAccountSignalRulesOutput added in v0.3.0 

type SetAccountSignalRulesOutput struct{}

SetAccountSignalRulesOutput holds the result of SetAccountSignalRules.

type SetAccountTelnumsInput added in v0.3.0 

type SetAccountTelnumsInput struct {
	AccountName string        // required; "*" names the current authenticated Account
	Telnums     cgpdata.Array // required
}

SetAccountTelnumsInput replaces the entire set of telephone numbers assigned to an account with Telnums.

type SetAccountTelnumsOutput added in v0.3.0 

type SetAccountTelnumsOutput struct{}

SetAccountTelnumsOutput holds the result of SetAccountTelnums.

type SetAccountTemplateInput added in v0.3.0 

type SetAccountTemplateInput struct {
	DomainName string             // optional; empty applies to the administrator Domain
	Settings   cgpdata.Dictionary // required
}

SetAccountTemplateInput replaces a domain's entire Account Template with Settings. New Accounts in the Domain are created with the Template settings.

type SetAccountTemplateOutput added in v0.3.0 

type SetAccountTemplateOutput struct{}

SetAccountTemplateOutput holds the result of SetAccountTemplate.

type SetAccountTypeInput added in v0.3.0 

type SetAccountTypeInput struct {
	AccountName string // required; "*" names the current authenticated Account
	AccountType string // required bare keyword, e.g. "AGrade"
}

SetAccountTypeInput changes an existing Account's type. The current and new types must both belong to the MultiMailbox/AGrade/BGrade/CGrade/ResourceMailbox set.

type SetAccountTypeOutput added in v0.3.0 

type SetAccountTypeOutput struct{}

SetAccountTypeOutput holds the result of SetAccountType.

type SetBannedInput added in v0.3.0 

type SetBannedInput struct {
	Settings cgpdata.Dictionary // required
}

SetBannedInput replaces the Server Banned Message Lines settings.

type SetBannedOutput added in v0.3.0 

type SetBannedOutput struct{}

SetBannedOutput holds the result of SetBanned.

type SetBlacklistedIPsInput added in v0.3.0 

type SetBlacklistedIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetBlacklistedIPsInput replaces the Server-wide set of Blacklisted IP Addresses.

type SetBlacklistedIPsOutput added in v0.3.0 

type SetBlacklistedIPsOutput struct{}

SetBlacklistedIPsOutput holds the result of SetBlacklistedIPs.

type SetClientIPsInput added in v0.3.0 

type SetClientIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetClientIPsInput replaces the Server-wide set of Client IP Addresses.

type SetClientIPsOutput added in v0.3.0 

type SetClientIPsOutput struct{}

SetClientIPsOutput holds the result of SetClientIPs.

type SetClusterAccountDefaultsInput added in v0.3.0 

type SetClusterAccountDefaultsInput struct {
	Settings cgpdata.Dictionary // required
}

SetClusterAccountDefaultsInput replaces the cluster-wide default Account settings dictionary with Settings. Available in the Dynamic Cluster only.

type SetClusterAccountDefaultsOutput added in v0.3.0 

type SetClusterAccountDefaultsOutput struct{}

SetClusterAccountDefaultsOutput holds the result of SetClusterAccountDefaults.

type SetClusterAccountPrefsInput added in v0.3.0 

type SetClusterAccountPrefsInput struct {
	Preferences cgpdata.Dictionary // required
}

SetClusterAccountPrefsInput replaces the cluster-wide default Account Preferences dictionary with Preferences. Available in the Dynamic Cluster only.

type SetClusterAccountPrefsOutput added in v0.3.0 

type SetClusterAccountPrefsOutput struct{}

SetClusterAccountPrefsOutput holds the result of SetClusterAccountPrefs.

type SetClusterAlertsInput added in v0.3.0 

type SetClusterAlertsInput struct {
	Alerts cgpdata.Dictionary // required
}

SetClusterAlertsInput replaces the entire cluster-wide alert dictionary. Available in the Dynamic Cluster only, in place of SetServerAlerts.

type SetClusterAlertsOutput added in v0.3.0 

type SetClusterAlertsOutput struct{}

SetClusterAlertsOutput holds the result of SetClusterAlerts.

type SetClusterBannedInput added in v0.3.0 

type SetClusterBannedInput struct {
	Settings cgpdata.Dictionary // required
}

SetClusterBannedInput replaces the Cluster-wide Banned Message Lines settings.

type SetClusterBannedOutput added in v0.3.0 

type SetClusterBannedOutput struct{}

SetClusterBannedOutput holds the result of SetClusterBanned.

type SetClusterBlacklistedIPsInput added in v0.3.0 

type SetClusterBlacklistedIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetClusterBlacklistedIPsInput replaces the Cluster-wide set of Blacklisted IP Addresses.

type SetClusterBlacklistedIPsOutput added in v0.3.0 

type SetClusterBlacklistedIPsOutput struct{}

SetClusterBlacklistedIPsOutput holds the result of SetClusterBlacklistedIPs.

type SetClusterClientIPsInput added in v0.3.0 

type SetClusterClientIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetClusterClientIPsInput replaces the Cluster-wide set of Client IP Addresses.

type SetClusterClientIPsOutput added in v0.3.0 

type SetClusterClientIPsOutput struct{}

SetClusterClientIPsOutput holds the result of SetClusterClientIPs.

type SetClusterDebugIPsInput added in v0.3.0 

type SetClusterDebugIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetClusterDebugIPsInput replaces the Cluster-wide set of Debug IP Addresses.

type SetClusterDebugIPsOutput added in v0.3.0 

type SetClusterDebugIPsOutput struct{}

SetClusterDebugIPsOutput holds the result of SetClusterDebugIPs.

type SetClusterDeniedIPsInput added in v0.3.0 

type SetClusterDeniedIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetClusterDeniedIPsInput replaces the Cluster-wide set of Denied IP Addresses.

type SetClusterDeniedIPsOutput added in v0.3.0 

type SetClusterDeniedIPsOutput struct{}

SetClusterDeniedIPsOutput holds the result of SetClusterDeniedIPs.

type SetClusterDirectoryIntegrationInput added in v0.3.0 

type SetClusterDirectoryIntegrationInput struct {
	Settings cgpdata.Dictionary // required
}

SetClusterDirectoryIntegrationInput replaces the cluster-wide Directory Integration settings dictionary with Settings. Available in the Dynamic Cluster only.

type SetClusterDirectoryIntegrationOutput added in v0.3.0 

type SetClusterDirectoryIntegrationOutput struct{}

SetClusterDirectoryIntegrationOutput holds the result of SetClusterDirectoryIntegration.

type SetClusterDomainDefaultsInput added in v0.3.0 

type SetClusterDomainDefaultsInput struct {
	Settings cgpdata.Dictionary // required
}

SetClusterDomainDefaultsInput replaces the cluster-wide default Domain settings dictionary with Settings. Available in the Dynamic Cluster only.

type SetClusterDomainDefaultsOutput added in v0.3.0 

type SetClusterDomainDefaultsOutput struct{}

SetClusterDomainDefaultsOutput holds the result of SetClusterDomainDefaults.

type SetClusterInterceptInput added in v0.3.0 

type SetClusterInterceptInput struct {
	Settings cgpdata.Dictionary // required
}

SetClusterInterceptInput replaces the Cluster-Wide Lawful Intercept settings.

type SetClusterInterceptOutput added in v0.3.0 

type SetClusterInterceptOutput struct{}

SetClusterInterceptOutput holds the result of SetClusterIntercept.

type SetClusterLANIPsInput added in v0.3.0 

type SetClusterLANIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetClusterLANIPsInput replaces the Cluster-wide set of LAN IP Addresses.

type SetClusterLANIPsOutput added in v0.3.0 

type SetClusterLANIPsOutput struct{}

SetClusterLANIPsOutput holds the result of SetClusterLANIPs.

type SetClusterMailRulesInput added in v0.3.0 

type SetClusterMailRulesInput struct {
	Rules cgpdata.Array // required
}

SetClusterMailRulesInput replaces the Cluster-Wide Automated Mail Processing Rules.

type SetClusterMailRulesOutput added in v0.3.0 

type SetClusterMailRulesOutput struct{}

SetClusterMailRulesOutput holds the result of SetClusterMailRules.

type SetClusterNATSiteIPsInput added in v0.3.0 

type SetClusterNATSiteIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetClusterNATSiteIPsInput replaces the Cluster-wide set of NAT Site IP Addresses.

type SetClusterNATSiteIPsOutput added in v0.3.0 

type SetClusterNATSiteIPsOutput struct{}

SetClusterNATSiteIPsOutput holds the result of SetClusterNATSiteIPs.

type SetClusterNATedIPsInput added in v0.3.0 

type SetClusterNATedIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetClusterNATedIPsInput replaces the Cluster-wide set of NATed IP Addresses.

type SetClusterNATedIPsOutput added in v0.3.0 

type SetClusterNATedIPsOutput struct{}

SetClusterNATedIPsOutput holds the result of SetClusterNATedIPs.

type SetClusterNetworkInput added in v0.3.0 

type SetClusterNetworkInput struct {
	Settings cgpdata.Dictionary // required
}

SetClusterNetworkInput replaces the Cluster-wide Network settings.

type SetClusterNetworkOutput added in v0.3.0 

type SetClusterNetworkOutput struct{}

SetClusterNetworkOutput holds the result of SetClusterNetwork.

type SetClusterProxyIPsInput added in v0.3.0 

type SetClusterProxyIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetClusterProxyIPsInput replaces the Cluster-wide set of Trusted Proxy Server IP Addresses.

type SetClusterProxyIPsOutput added in v0.3.0 

type SetClusterProxyIPsOutput struct{}

SetClusterProxyIPsOutput holds the result of SetClusterProxyIPs.

type SetClusterRouterSettingsInput added in v0.3.0 

type SetClusterRouterSettingsInput struct {
	Settings cgpdata.Dictionary // required
}

SetClusterRouterSettingsInput replaces the Cluster-Wide Router settings.

type SetClusterRouterSettingsOutput added in v0.3.0 

type SetClusterRouterSettingsOutput struct{}

SetClusterRouterSettingsOutput holds the result of SetClusterRouterSettings.

type SetClusterRouterTableInput added in v0.3.0 

type SetClusterRouterTableInput struct {
	Table string // required; a (multi-line) string, empty to clear it
}

SetClusterRouterTableInput replaces the Cluster-Wide Router Table.

type SetClusterRouterTableOutput added in v0.3.0 

type SetClusterRouterTableOutput struct{}

SetClusterRouterTableOutput holds the result of SetClusterRouterTable.

type SetClusterSettingsInput added in v0.3.0 

type SetClusterSettingsInput struct {
	Settings cgpdata.Dictionary // required
}

SetClusterSettingsInput replaces the Cluster settings.

type SetClusterSettingsOutput added in v0.3.0 

type SetClusterSettingsOutput struct{}

SetClusterSettingsOutput holds the result of SetClusterSettings.

type SetClusterSignalRulesInput added in v0.3.0 

type SetClusterSignalRulesInput struct {
	Rules cgpdata.Array // required
}

SetClusterSignalRulesInput replaces the Cluster-Wide Automated Signal Processing Rules.

type SetClusterSignalRulesOutput added in v0.3.0 

type SetClusterSignalRulesOutput struct{}

SetClusterSignalRulesOutput holds the result of SetClusterSignalRules.

type SetClusterTrustedCertsInput added in v0.3.0 

type SetClusterTrustedCertsInput struct {
	Certificates [][]byte // required; each element is one X.509 certificate's raw data
}

SetClusterTrustedCertsInput replaces the cluster-wide set of Trusted Certificates. Available in the Dynamic Cluster only.

type SetClusterTrustedCertsOutput added in v0.3.0 

type SetClusterTrustedCertsOutput struct{}

SetClusterTrustedCertsOutput holds the result of SetClusterTrustedCerts.

type SetClusterWhiteHoleIPsInput added in v0.3.0 

type SetClusterWhiteHoleIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetClusterWhiteHoleIPsInput replaces the Cluster-wide set of WhiteHole IP Addresses.

type SetClusterWhiteHoleIPsOutput added in v0.3.0 

type SetClusterWhiteHoleIPsOutput struct{}

SetClusterWhiteHoleIPsOutput holds the result of SetClusterWhiteHoleIPs.

type SetDNRSettingsInput added in v0.3.0 

type SetDNRSettingsInput struct {
	Settings cgpdata.Dictionary // required
}

SetDNRSettingsInput replaces the DNR (Domain Name Resolver) settings.

type SetDNRSettingsOutput added in v0.3.0 

type SetDNRSettingsOutput struct{}

SetDNRSettingsOutput holds the result of SetDNRSettings.

type SetDebugIPsInput added in v0.3.0 

type SetDebugIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetDebugIPsInput replaces the Server-wide set of Debug IP Addresses.

type SetDebugIPsOutput added in v0.3.0 

type SetDebugIPsOutput struct{}

SetDebugIPsOutput holds the result of SetDebugIPs.

type SetDeniedIPsInput added in v0.3.0 

type SetDeniedIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetDeniedIPsInput replaces the Server-wide set of Denied IP Addresses.

type SetDeniedIPsOutput added in v0.3.0 

type SetDeniedIPsOutput struct{}

SetDeniedIPsOutput holds the result of SetDeniedIPs.

type SetDirectoryAccessRightsInput added in v0.3.0 

type SetDirectoryAccessRightsInput struct {
	NewAccessRights cgpdata.Array // required
	Shared          bool          // optional; if true, sets the cluster-wide Access Rights
}

SetDirectoryAccessRightsInput sets the Directory Access Rights.

type SetDirectoryAccessRightsOutput added in v0.3.0 

type SetDirectoryAccessRightsOutput struct{}

SetDirectoryAccessRightsOutput holds the result of SetDirectoryAccessRights.

type SetDirectoryIntegrationInput added in v0.3.0 

type SetDirectoryIntegrationInput struct {
	Settings cgpdata.Dictionary // required
}

SetDirectoryIntegrationInput replaces the server-wide Directory Integration settings dictionary with Settings.

type SetDirectoryIntegrationOutput added in v0.3.0 

type SetDirectoryIntegrationOutput struct{}

SetDirectoryIntegrationOutput holds the result of SetDirectoryIntegration.

type SetDirectoryUnitInput added in v0.3.0 

type SetDirectoryUnitInput struct {
	UnitName    string             // required
	NewSettings cgpdata.Dictionary // required
	Shared      bool               // optional; if true, UnitName names a cluster-wide Unit
}

SetDirectoryUnitInput replaces a Directory Unit's settings.

type SetDirectoryUnitOutput added in v0.3.0 

type SetDirectoryUnitOutput struct{}

SetDirectoryUnitOutput holds the result of SetDirectoryUnit.

type SetDomainAlertsInput added in v0.3.0 

type SetDomainAlertsInput struct {
	DomainName string             // optional; empty applies to the administrator Domain
	Alerts     cgpdata.Dictionary // required
}

SetDomainAlertsInput replaces a Domain's entire alert dictionary.

type SetDomainAlertsOutput added in v0.3.0 

type SetDomainAlertsOutput struct{}

SetDomainAlertsOutput holds the result of SetDomainAlerts.

type SetDomainAliasesInput added in v0.3.0 

type SetDomainAliasesInput struct {
	DomainName string        // required
	Aliases    cgpdata.Array // required
}

SetDomainAliasesInput replaces a domain's entire set of Domain aliases with Aliases. This command is available to System Administrators only.

type SetDomainAliasesOutput added in v0.3.0 

type SetDomainAliasesOutput struct{}

SetDomainAliasesOutput holds the result of SetDomainAliases.

type SetDomainDefaultsInput added in v0.3.0 

type SetDomainDefaultsInput struct {
	Settings cgpdata.Dictionary // required
}

SetDomainDefaultsInput replaces the server-wide default Domain settings dictionary with Settings.

type SetDomainDefaultsOutput added in v0.3.0 

type SetDomainDefaultsOutput struct{}

SetDomainDefaultsOutput holds the result of SetDomainDefaults.

type SetDomainFreeBusyInput added in v0.3.0 

type SetDomainFreeBusyInput struct {
	DomainName string             // optional; empty applies to the administrator Domain
	FreeBusy   cgpdata.Dictionary // required
}

SetDomainFreeBusyInput replaces a Domain's entire Free/Busy dictionary.

type SetDomainFreeBusyOutput added in v0.3.0 

type SetDomainFreeBusyOutput struct{}

SetDomainFreeBusyOutput holds the result of SetDomainFreeBusy.

type SetDomainMailRulesInput added in v0.3.0 

type SetDomainMailRulesInput struct {
	DomainName string        // required
	Rules      cgpdata.Array // required
}

SetDomainMailRulesInput replaces a domain's entire set of Queue Rules with Rules.

type SetDomainMailRulesOutput added in v0.3.0 

type SetDomainMailRulesOutput struct{}

SetDomainMailRulesOutput holds the result of SetDomainMailRules.

type SetDomainPluginsSettingsInput added in v0.3.0 

type SetDomainPluginsSettingsInput struct {
	DomainName  string             // optional; empty applies to the administrator Domain
	NewSettings cgpdata.Dictionary // required
}

SetDomainPluginsSettingsInput replaces a domain's Plugins Settings dictionary. All old Domain Plugins Settings are removed.

type SetDomainPluginsSettingsOutput added in v0.3.0 

type SetDomainPluginsSettingsOutput struct{}

SetDomainPluginsSettingsOutput holds the result of SetDomainPluginsSettings.

type SetDomainSettingsInput added in v0.3.0 

type SetDomainSettingsInput struct {
	DomainName string             // required
	Settings   cgpdata.Dictionary // required
}

SetDomainSettingsInput replaces a domain's entire settings dictionary with Settings. This command is available to System Administrators only.

type SetDomainSettingsOutput added in v0.3.0 

type SetDomainSettingsOutput struct{}

SetDomainSettingsOutput holds the result of SetDomainSettings.

type SetDomainSignalRulesInput added in v0.3.0 

type SetDomainSignalRulesInput struct {
	DomainName string        // required
	Rules      cgpdata.Array // required
}

SetDomainSignalRulesInput replaces a domain's entire set of Signal Rules with Rules.

type SetDomainSignalRulesOutput added in v0.3.0 

type SetDomainSignalRulesOutput struct{}

SetDomainSignalRulesOutput holds the result of SetDomainSignalRules.

type SetFileSubscriptionInput added in v0.3.0 

type SetFileSubscriptionInput struct {
	AccountName     string        // required; "*" names the current authenticated Account
	NewSubscription cgpdata.Array // required: an Array of String file names
}

SetFileSubscriptionInput replaces an Account's "subscribed files" list.

type SetFileSubscriptionOutput added in v0.3.0 

type SetFileSubscriptionOutput struct{}

SetFileSubscriptionOutput holds the result of SetFileSubscription.

type SetGroupInput added in v0.3.0 

type SetGroupInput struct {
	GroupName   string             // required; may include "@domain"
	NewSettings cgpdata.Dictionary // required
}

SetGroupInput replaces a Group's entire settings dictionary.

type SetGroupOutput added in v0.3.0 

type SetGroupOutput struct{}

SetGroupOutput holds the result of SetGroup.

type SetLANIPsInput added in v0.3.0 

type SetLANIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetLANIPsInput replaces the Server-wide set of LAN IP Addresses.

type SetLANIPsOutput added in v0.3.0 

type SetLANIPsOutput struct{}

SetLANIPsOutput holds the result of SetLANIPs.

type SetListSubscriptionInput added in v0.3.0 

type SetListSubscriptionInput struct {
	ListName string // required; may include the Domain name

	// Operation is the bare CLI keyword naming the action: one of
	// "subscribe", "feed", "digest", "index", "null", "banned", or
	// "unsubscribe" (see the LIST module documentation for the
	// meaning of each).
	Operation string // required

	Silently bool // optional: suppress the Welcome/Bye message
	Confirm  bool // optional: send a confirmation request to Address

	Address  string // required; the subscriber's E-mail address
	RealName string // optional; a comment/real-name to pair with Address
}

SetListSubscriptionInput subscribes, unsubscribes, or changes the delivery mode of a single mailing list subscriber.

type SetListSubscriptionOutput added in v0.3.0 

type SetListSubscriptionOutput struct{}

SetListSubscriptionOutput holds the result of SetListSubscription.

type SetLogAllInput added in v0.3.0 

type SetLogAllInput struct {
	Mode string // optional bare keyword, "ON" or "OFF"; empty toggles the current mode
}

SetLogAllInput switches the Server's "Log Everything" mode on or off.

type SetLogAllOutput added in v0.3.0 

type SetLogAllOutput struct{}

SetLogAllOutput holds the result of SetLogAll.

type SetMailboxACLInput added in v0.3.0 

type SetMailboxACLInput struct {
	AccountName     string             // required; "*" names the current authenticated Account
	MailboxName     string             // required
	AuthAccountName string             // optional: the ACL is updated only if this Account has the Admin right
	NewACL          cgpdata.Dictionary // required
}

SetMailboxACLInput modifies a Mailbox's access control list. Each NewACL key is an identifier; a value starting with "-" removes the listed rights, a value starting with "+" adds them, any other value replaces the element's rights outright, and the #NULL# special value removes the element - the same syntax as SETACCOUNTACL.

type SetMailboxACLOutput added in v0.3.0 

type SetMailboxACLOutput struct{}

SetMailboxACLOutput holds the result of SetMailboxACL.

type SetMailboxAliasesInput added in v0.3.0 

type SetMailboxAliasesInput struct {
	AccountName string             // required; "*" names the current authenticated Account
	NewAliases  cgpdata.Dictionary // required
}

SetMailboxAliasesInput sets an Account's Mailbox aliases.

type SetMailboxAliasesOutput added in v0.3.0 

type SetMailboxAliasesOutput struct{}

SetMailboxAliasesOutput holds the result of SetMailboxAliases.

type SetMailboxAliasesUTF8Input added in v0.3.0 

type SetMailboxAliasesUTF8Input struct {
	AccountName string             // required; "*" names the current authenticated Account
	NewAliases  cgpdata.Dictionary // required
}

SetMailboxAliasesUTF8Input sets an Account's Mailbox aliases, with alias and target Mailbox names in UTF-8 encoding.

type SetMailboxAliasesUTF8Output added in v0.3.0 

type SetMailboxAliasesUTF8Output struct{}

SetMailboxAliasesUTF8Output holds the result of SetMailboxAliasesUTF8.

type SetMailboxClassInput added in v0.3.0 

type SetMailboxClassInput struct {
	AccountName     string // required; "*" names the current authenticated Account
	MailboxName     string // required
	AuthAccountName string // optional: whose Mailbox access rights to use
	NewClass        string // required
}

SetMailboxClassInput sets a Mailbox's class.

type SetMailboxClassOutput added in v0.3.0 

type SetMailboxClassOutput struct{}

SetMailboxClassOutput holds the result of SetMailboxClass.

type SetMailboxSubscriptionInput added in v0.3.0 

type SetMailboxSubscriptionInput struct {
	AccountName     string        // required; "*" names the current authenticated Account
	NewSubscription cgpdata.Array // required: an Array of String Mailbox names
}

SetMailboxSubscriptionInput sets an Account's "subscribed Mailboxes" list.

type SetMailboxSubscriptionOutput added in v0.3.0 

type SetMailboxSubscriptionOutput struct{}

SetMailboxSubscriptionOutput holds the result of SetMailboxSubscription.

type SetMailboxSubscriptionUTF8Input added in v0.3.0 

type SetMailboxSubscriptionUTF8Input struct {
	AccountName     string        // required; "*" names the current authenticated Account
	NewSubscription cgpdata.Array // required: an Array of UTF-8-encoded String Mailbox names
}

SetMailboxSubscriptionUTF8Input sets an Account's "subscribed Mailboxes" list, with Mailbox names in UTF-8 encoding.

type SetMailboxSubscriptionUTF8Output added in v0.3.0 

type SetMailboxSubscriptionUTF8Output struct{}

SetMailboxSubscriptionUTF8Output holds the result of SetMailboxSubscriptionUTF8.

type SetMediaServerSettingsInput added in v0.3.0 

type SetMediaServerSettingsInput struct {
	Settings cgpdata.Dictionary // required
}

SetMediaServerSettingsInput replaces the Media Server component settings.

type SetMediaServerSettingsOutput added in v0.3.0 

type SetMediaServerSettingsOutput struct{}

SetMediaServerSettingsOutput holds the result of SetMediaServerSettings.

type SetModuleInput added in v0.3.0 

type SetModuleInput struct {
	ModuleName string             // required
	Settings   cgpdata.Dictionary // required
}

SetModuleInput replaces a Server module's entire settings dictionary.

type SetModuleOutput added in v0.3.0 

type SetModuleOutput struct{}

SetModuleOutput holds the result of SetModule.

type SetNATSiteIPsInput added in v0.3.0 

type SetNATSiteIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetNATSiteIPsInput replaces the Server-wide set of NAT Site IP Addresses.

type SetNATSiteIPsOutput added in v0.3.0 

type SetNATSiteIPsOutput struct{}

SetNATSiteIPsOutput holds the result of SetNATSiteIPs.

type SetNATedIPsInput added in v0.3.0 

type SetNATedIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetNATedIPsInput replaces the Server-wide set of NATed IP Addresses.

type SetNATedIPsOutput added in v0.3.0 

type SetNATedIPsOutput struct{}

SetNATedIPsOutput holds the result of SetNATedIPs.

type SetNetworkInput added in v0.3.0 

type SetNetworkInput struct {
	Settings cgpdata.Dictionary // required
}

SetNetworkInput replaces the Server Network settings.

type SetNetworkOutput added in v0.3.0 

type SetNetworkOutput struct{}

SetNetworkOutput holds the result of SetNetwork.

type SetPostingModeInput added in v0.3.0 

type SetPostingModeInput struct {
	ListName          string // required; may include the Domain name
	SubscriberAddress string // required
	Mode              string // optional bare keyword; see above
	ModerateCount     int    // optional; see above
}

SetPostingModeInput sets the posting moderation mode for a mailing list subscriber. Mode and ModerateCount are mutually exclusive alternatives: set Mode to one of the bare keywords "UNMODERATED", "MODERATEALL", "PROHIBITED", or "SPECIAL", or set ModerateCount (a positive count) to require moderation of that many upcoming messages from the subscriber. Leaving both unset sends no posting mode option.

type SetPostingModeOutput added in v0.3.0 

type SetPostingModeOutput struct{}

SetPostingModeOutput holds the result of SetPostingMode.

type SetProxyIPsInput added in v0.3.0 

type SetProxyIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetProxyIPsInput replaces the Server-wide set of Trusted Proxy Server IP Addresses.

type SetProxyIPsOutput added in v0.3.0 

type SetProxyIPsOutput struct{}

SetProxyIPsOutput holds the result of SetProxyIPs.

type SetQueueSettingsInput added in v0.3.0 

type SetQueueSettingsInput struct {
	Settings cgpdata.Dictionary // required
}

SetQueueSettingsInput replaces the Queue settings.

type SetQueueSettingsOutput added in v0.3.0 

type SetQueueSettingsOutput struct{}

SetQueueSettingsOutput holds the result of SetQueueSettings.

type SetRouterSettingsInput added in v0.3.0 

type SetRouterSettingsInput struct {
	Settings cgpdata.Dictionary // required
}

SetRouterSettingsInput replaces the Router settings.

type SetRouterSettingsOutput added in v0.3.0 

type SetRouterSettingsOutput struct{}

SetRouterSettingsOutput holds the result of SetRouterSettings.

type SetRouterTableInput added in v0.3.0 

type SetRouterTableInput struct {
	Table string // required; a (multi-line) string, empty to clear it
}

SetRouterTableInput replaces the Router Table.

type SetRouterTableOutput added in v0.3.0 

type SetRouterTableOutput struct{}

SetRouterTableOutput holds the result of SetRouterTable.

type SetServerAccountDefaultsInput added in v0.3.0 

type SetServerAccountDefaultsInput struct {
	Settings cgpdata.Dictionary // required
}

SetServerAccountDefaultsInput replaces the server-wide default Account settings dictionary with Settings.

type SetServerAccountDefaultsOutput added in v0.3.0 

type SetServerAccountDefaultsOutput struct{}

SetServerAccountDefaultsOutput holds the result of SetServerAccountDefaults.

type SetServerAccountPrefsInput added in v0.3.0 

type SetServerAccountPrefsInput struct {
	Preferences cgpdata.Dictionary // required
}

SetServerAccountPrefsInput replaces the server-wide default Account Preferences dictionary with Preferences; all old server-wide default Preferences are removed.

type SetServerAccountPrefsOutput added in v0.3.0 

type SetServerAccountPrefsOutput struct{}

SetServerAccountPrefsOutput holds the result of SetServerAccountPrefs.

type SetServerAlertsInput added in v0.3.0 

type SetServerAlertsInput struct {
	Alerts cgpdata.Dictionary // required
}

SetServerAlertsInput replaces the entire server-wide alert dictionary. Available to System Administrators only.

type SetServerAlertsOutput added in v0.3.0 

type SetServerAlertsOutput struct{}

SetServerAlertsOutput holds the result of SetServerAlerts.

type SetServerInterceptInput added in v0.3.0 

type SetServerInterceptInput struct {
	Settings cgpdata.Dictionary // required
}

SetServerInterceptInput replaces the Lawful Intercept settings.

type SetServerInterceptOutput added in v0.3.0 

type SetServerInterceptOutput struct{}

SetServerInterceptOutput holds the result of SetServerIntercept.

type SetServerMailRulesInput added in v0.3.0 

type SetServerMailRulesInput struct {
	Rules cgpdata.Array // required
}

SetServerMailRulesInput replaces the Server-Wide Automated Mail Processing Rules.

type SetServerMailRulesOutput added in v0.3.0 

type SetServerMailRulesOutput struct{}

SetServerMailRulesOutput holds the result of SetServerMailRules.

type SetServerSignalRulesInput added in v0.3.0 

type SetServerSignalRulesInput struct {
	Rules cgpdata.Array // required
}

SetServerSignalRulesInput replaces the Server-Wide Automated Signal Processing Rules.

type SetServerSignalRulesOutput added in v0.3.0 

type SetServerSignalRulesOutput struct{}

SetServerSignalRulesOutput holds the result of SetServerSignalRules.

type SetServerTrustedCertsInput added in v0.3.0 

type SetServerTrustedCertsInput struct {
	Certificates [][]byte // required; each element is one X.509 certificate's raw data
}

SetServerTrustedCertsInput replaces the server-wide set of Trusted Certificates.

type SetServerTrustedCertsOutput added in v0.3.0 

type SetServerTrustedCertsOutput struct{}

SetServerTrustedCertsOutput holds the result of SetServerTrustedCerts.

type SetSessionSettingsInput added in v0.3.0 

type SetSessionSettingsInput struct {
	Settings cgpdata.Dictionary // required
}

SetSessionSettingsInput replaces the user Sessions settings.

type SetSessionSettingsOutput added in v0.3.0 

type SetSessionSettingsOutput struct{}

SetSessionSettingsOutput holds the result of SetSessionSettings.

type SetSignalSettingsInput added in v0.3.0 

type SetSignalSettingsInput struct {
	Settings cgpdata.Dictionary // required
}

SetSignalSettingsInput replaces the Signal component settings.

type SetSignalSettingsOutput added in v0.3.0 

type SetSignalSettingsOutput struct{}

SetSignalSettingsOutput holds the result of SetSignalSettings.

type SetStatElementInput added in v0.3.0 

type SetStatElementInput struct {
	ObjectID string // required
	Mode     string // required bare keyword: "INC" (add Value) or "SET" (assign Value)
	Value    int64  // required; a numeric string on the wire
}

SetStatElementInput updates the current value of a Server statistics (SNMP) "Custom" element. CLI.md's grammar brackets only the Mode keyword as optional ("SETSTATELEMENT ObjectID [ INC | SET ] setValue"), but its body text only describes behavior once one of the two keywords is given, and CGP::API's SetStatElement requires both the element and the command to be defined; this wrapper follows CGP::API and treats Mode as required too, to avoid sending a server-undocumented bare-value form.

type SetStatElementOutput added in v0.3.0 

type SetStatElementOutput struct{}

SetStatElementOutput holds the result of SetStatElement.

type SetTempBlacklistedIPsInput added in v0.3.0 

type SetTempBlacklistedIPsInput struct {
	Addresses string // required; using GetTempBlacklistedIPs's output format; empty clears the list
}

SetTempBlacklistedIPsInput replaces the Temporary Blocked IP Addresses list.

type SetTempBlacklistedIPsOutput added in v0.3.0 

type SetTempBlacklistedIPsOutput struct{}

SetTempBlacklistedIPsOutput holds the result of SetTempBlacklistedIPs.

type SetTempUnblockableIPsInput added in v0.3.0 

type SetTempUnblockableIPsInput struct {
	Addresses string // required; using GetTempUnblockableIPs's output format; empty clears the list
}

SetTempUnblockableIPsInput replaces the Temporary UnBlockable IP Addresses list.

type SetTempUnblockableIPsOutput added in v0.3.0 

type SetTempUnblockableIPsOutput struct{}

SetTempUnblockableIPsOutput holds the result of SetTempUnblockableIPs.

type SetTotpSecretInput added in v0.3.0 

type SetTotpSecretInput struct {
	AccountName string // required; "*" names the current authenticated Account
	Secret      string // optional TOTP secret in Base32 encoding; empty resets it
}

SetTotpSecretInput sets (or, if Secret is empty, resets) an account's TOTP secret.

type SetTotpSecretOutput added in v0.3.0 

type SetTotpSecretOutput struct{}

SetTotpSecretOutput holds the result of SetTotpSecret.

type SetTraceInput added in v0.3.0 

type SetTraceInput struct {
	Facility string // required, e.g. "FileIO" or "FileOp"
	Mode     string // optional bare keyword, "ON" or "OFF"; empty toggles the current mode
}

SetTraceInput switches an internal logging facility that writes to the OS syslog on or off.

type SetTraceOutput added in v0.3.0 

type SetTraceOutput struct{}

SetTraceOutput holds the result of SetTrace.

type SetWhiteHoleIPsInput added in v0.3.0 

type SetWhiteHoleIPsInput struct {
	Addresses string // required; a (multi-line) string, empty to clear the set
}

SetWhiteHoleIPsInput replaces the Server-wide set of WhiteHole IP Addresses.

type SetWhiteHoleIPsOutput added in v0.3.0 

type SetWhiteHoleIPsOutput struct{}

SetWhiteHoleIPsOutput holds the result of SetWhiteHoleIPs.

type ShutdownInput added in v0.3.0 

type ShutdownInput struct{}

ShutdownInput stops the CommuniGate Pro Server. CLI.md documents no parameters for this command - CGP::API's Shutdown sends the bare "SHUTDOWN" verb - so this Input carries none either; there is no confirmation clause to model.

type ShutdownOutput added in v0.3.0 

type ShutdownOutput struct{}

ShutdownOutput holds the result of Shutdown.

type StartPBXTaskInput added in v0.3.0 

type StartPBXTaskInput struct {
	AccountName string        // required; may include the Domain name; "*" names the current authenticated Account
	ProgramName string        // required; the .sppr file to run
	EntryName   string        // optional; defaults to the "main" entry point
	Param       cgpdata.Value // optional; retrievable in the program as Vars().startParameter
}

StartPBXTaskInput starts a new PBX Task, running ProgramName on AccountName's behalf.

type StartPBXTaskOutput added in v0.3.0 

type StartPBXTaskOutput struct {
	TaskID string
}

StartPBXTaskOutput holds the result of StartPBXTask.

type StoreClusterPBXFileInput added in v0.3.0 

type StoreClusterPBXFileInput struct {
	FileName   string // required; "language/fileName" stores into a national subset
	Content    []byte // stored as a datablock; empty content is allowed
	TryCompile bool   // optional: ask the server to compile the CG/PL before storing
}

StoreClusterPBXFileInput stores a file into the cluster-wide Real-Time Application Environment, replacing an existing file with the same name and removing it from every cluster member's Environment cache. Available in the Dynamic Cluster only, to System Administrators.

type StoreClusterPBXFileOutput added in v0.3.0 

type StoreClusterPBXFileOutput struct{}

StoreClusterPBXFileOutput holds the result of StoreClusterPBXFile.

type StoreClusterSkinFileInput added in v0.3.0 

type StoreClusterSkinFileInput struct {
	SkinName   string // required
	FileName   string // required
	Content    []byte // stored as a datablock; empty content is allowed
	TryCompile bool   // optional: ask the server to compile the stored file
}

StoreClusterSkinFileInput stores a file into a cluster-wide Skin, replacing an existing file with the same name, in place of STORESERVERSKINFILE. This command is available in the Dynamic Cluster only.

type StoreClusterSkinFileOutput added in v0.3.0 

type StoreClusterSkinFileOutput struct{}

StoreClusterSkinFileOutput holds the result of StoreClusterSkinFile.

type StoreDomainPBXFileInput added in v0.3.0 

type StoreDomainPBXFileInput struct {
	DomainName string // required
	FileName   string // required; "language/fileName" stores into a national subset
	Content    []byte // stored as a datablock; empty content is allowed
	TryCompile bool   // optional: ask the server to compile the CG/PL before storing
}

StoreDomainPBXFileInput stores a file into the Domain Real-Time Application Environment, replacing an existing file with the same name and removing it from the Environment cache.

type StoreDomainPBXFileOutput added in v0.3.0 

type StoreDomainPBXFileOutput struct{}

StoreDomainPBXFileOutput holds the result of StoreDomainPBXFile.

type StoreDomainSkinFileInput added in v0.2.0 

type StoreDomainSkinFileInput struct {
	DomainName string // optional; empty applies to the administrator Domain
	SkinName   string // "" names the unnamed Skin
	FileName   string // required
	Content    []byte // stored as a datablock; empty content is allowed
	TryCompile bool   // optional: ask the server to compile the stored file
}

StoreDomainSkinFileInput stores a file into a custom Domain Skin, replacing an existing file with the same name.

type StoreDomainSkinFileOutput added in v0.2.0 

type StoreDomainSkinFileOutput struct{}

StoreDomainSkinFileOutput holds the result of StoreDomainSkinFile.

type StoreServerPBXFileInput added in v0.3.0 

type StoreServerPBXFileInput struct {
	FileName   string // required; "language/fileName" stores into a national subset
	Content    []byte // stored as a datablock; empty content is allowed
	TryCompile bool   // optional: ask the server to compile the CG/PL before storing
}

StoreServerPBXFileInput stores a file into the Server-wide Real-Time Application Environment, replacing an existing file with the same name and removing it from the Environment cache. Available to System Administrators only.

type StoreServerPBXFileOutput added in v0.3.0 

type StoreServerPBXFileOutput struct{}

StoreServerPBXFileOutput holds the result of StoreServerPBXFile.

type StoreServerSkinFileInput added in v0.3.0 

type StoreServerSkinFileInput struct {
	SkinName   string // required
	FileName   string // required
	Content    []byte // stored as a datablock; empty content is allowed
	TryCompile bool   // optional: ask the server to compile the stored file
}

StoreServerSkinFileInput stores a file into a custom Server Skin, replacing an existing file with the same name.

type StoreServerSkinFileOutput added in v0.3.0 

type StoreServerSkinFileOutput struct{}

StoreServerSkinFileOutput holds the result of StoreServerSkinFile.

type SuspendDomainInput added in v0.3.0 

type SuspendDomainInput struct {
	DomainName string // required
}

SuspendDomainInput suspends a domain, closing all its currently active Accounts; no Account can be opened in the Domain until it is resumed.

type SuspendDomainOutput added in v0.3.0 

type SuspendDomainOutput struct{}

SuspendDomainOutput holds the result of SuspendDomain.

type TLSMode 

type TLSMode int

TLSMode selects how (or whether) a Client establishes transport security with the server. 

const (
	// NoTLS connects in the clear. This is the zero value/default.
	NoTLS TLSMode = iota
	// ImplicitTLS establishes a TLS session before the PWD greeting is
	// read, for servers that expect TLS from the first byte
	// (conventionally offered on port 1106).
	ImplicitTLS
	// StartTLS connects in the clear, reads the greeting, sends the
	// STLS command, and upgrades the existing connection to TLS before
	// authenticating.
	StartTLS
)

func (TLSMode) String 

func (m TLSMode) String() string

type TempBlacklistIPInput added in v0.3.0 

type TempBlacklistIPInput struct {
	Address string // required
	Seconds int    // optional: block for this many seconds, sent as TIMEOUT seconds; ignored if Delete is set
	Delete  bool   // optional: remove Address from the set instead (equivalent to TIMEOUT 0)
}

TempBlacklistIPInput adds an address to the Temporarily Blocked Addresses set.

type TempBlacklistIPOutput added in v0.3.0 

type TempBlacklistIPOutput struct{}

TempBlacklistIPOutput holds the result of TempBlacklistIP.

type TempUnblockIPInput added in v0.3.0 

type TempUnblockIPInput struct {
	Address string // required
	Seconds int    // optional: keep in the set for this many seconds, sent as TIMEOUT seconds; ignored if Delete is set
	Delete  bool   // optional: remove Address from the set instead (equivalent to TIMEOUT 0)
}

TempUnblockIPInput adds an address to the Temporary UnBlockable IP Addresses set.

type TempUnblockIPOutput added in v0.3.0 

type TempUnblockIPOutput struct{}

TempUnblockIPOutput holds the result of TempUnblockIP.

type TestLoopInput added in v0.3.0 

type TestLoopInput struct {
	Seconds int // required
}

TestLoopInput runs a calculation loop for Seconds, to test the Server CPU load.

type TestLoopOutput added in v0.3.0 

type TestLoopOutput struct {
	Performance int64 // average CLI thread CPU performance: loop iterations per test second
}

TestLoopOutput holds the result of TestLoop.

type UnblockAccountInput added in v0.3.0 

type UnblockAccountInput struct {
	AccountName string // required; "*" names the current authenticated Account
}

UnblockAccountInput removes any Account blocking.

type UnblockAccountOutput added in v0.3.0 

type UnblockAccountOutput struct{}

UnblockAccountOutput holds the result of UnblockAccount.

type UpdateAccountDefaultPrefsInput added in v0.3.0 

type UpdateAccountDefaultPrefsInput struct {
	DomainName string             // optional; empty applies to the authenticated user Domain
	Settings   cgpdata.Dictionary // required
}

UpdateAccountDefaultPrefsInput merges Settings into a domain's Default Account Preferences, leaving elements not present in Settings unchanged. An element whose new value is the string "default" is removed, so the default Server-wide (or Cluster-wide) Account Preferences value applies again.

type UpdateAccountDefaultPrefsOutput added in v0.3.0 

type UpdateAccountDefaultPrefsOutput struct{}

UpdateAccountDefaultPrefsOutput holds the result of UpdateAccountDefaultPrefs.

type UpdateAccountDefaultsInput added in v0.3.0 

type UpdateAccountDefaultsInput struct {
	DomainName string             // optional; empty applies to the administrator Domain
	Settings   cgpdata.Dictionary // required
}

UpdateAccountDefaultsInput merges Settings into a domain's Default Account settings, leaving keys not present in Settings unchanged. A setting whose new value is the string "default" is removed, so the global Server Default Account Settings value applies again.

type UpdateAccountDefaultsOutput added in v0.3.0 

type UpdateAccountDefaultsOutput struct{}

UpdateAccountDefaultsOutput holds the result of UpdateAccountDefaults.

type UpdateAccountMailRuleInput added in v0.3.0 

type UpdateAccountMailRuleInput struct {
	AccountName string // required; "*" names the current authenticated Account
	// Rule is required: [priority, name] reprioritizes an existing
	// Rule (error if it does not exist); [priority, name, conditions,
	// actions, comment] (4 or more elements) stores it as a new Rule,
	// replacing any existing Rule with the same name.
	Rule cgpdata.Array
}

UpdateAccountMailRuleInput creates or reprioritizes a single Account Queue Rule, leaving the account's other Rules untouched (unlike SetAccountMailRules, which replaces the whole Rule list).

type UpdateAccountMailRuleOutput added in v0.3.0 

type UpdateAccountMailRuleOutput struct{}

UpdateAccountMailRuleOutput holds the result of UpdateAccountMailRule.

type UpdateAccountPrefsInput added in v0.3.0 

type UpdateAccountPrefsInput struct {
	AccountName string             // required; "*" names the current authenticated Account
	Settings    cgpdata.Dictionary // required
}

UpdateAccountPrefsInput merges Settings into an account's existing stored Preferences, leaving keys not present in Settings unchanged.

type UpdateAccountPrefsOutput added in v0.3.0 

type UpdateAccountPrefsOutput struct{}

UpdateAccountPrefsOutput holds the result of UpdateAccountPrefs.

type UpdateAccountSettingsInput 

type UpdateAccountSettingsInput struct {
	AccountName string             // required; "*" names the current authenticated Account
	Settings    cgpdata.Dictionary // required
}

UpdateAccountSettingsInput merges Settings into an account's existing stored settings, leaving keys not present in Settings unchanged.

type UpdateAccountSettingsOutput 

type UpdateAccountSettingsOutput struct{}

UpdateAccountSettingsOutput holds the result of UpdateAccountSettings.

type UpdateAccountSignalRuleInput added in v0.3.0 

type UpdateAccountSignalRuleInput struct {
	AccountName string        // required; "*" names the current authenticated Account
	Rule        cgpdata.Array // required; see UpdateAccountMailRuleInput.Rule for the element-count rules
}

UpdateAccountSignalRuleInput creates or reprioritizes a single Account Signal Rule, leaving the account's other Rules untouched (unlike SetAccountSignalRules, which replaces the whole Rule list).

type UpdateAccountSignalRuleOutput added in v0.3.0 

type UpdateAccountSignalRuleOutput struct{}

UpdateAccountSignalRuleOutput holds the result of UpdateAccountSignalRule.

type UpdateAccountTemplateInput added in v0.3.0 

type UpdateAccountTemplateInput struct {
	DomainName string             // optional; empty applies to the administrator Domain
	Settings   cgpdata.Dictionary // required
}

UpdateAccountTemplateInput merges Settings into a domain's Account Template, leaving keys not present in Settings unchanged. A setting whose new value is the string "default" is removed. New Accounts in the Domain are created with the Template settings.

type UpdateAccountTemplateOutput added in v0.3.0 

type UpdateAccountTemplateOutput struct{}

UpdateAccountTemplateOutput holds the result of UpdateAccountTemplate.

type UpdateClusterAccountDefaultsInput added in v0.3.0 

type UpdateClusterAccountDefaultsInput struct {
	Settings cgpdata.Dictionary // required
}

UpdateClusterAccountDefaultsInput merges Settings into the cluster-wide default Account settings, leaving keys not present in Settings unchanged. Available in the Dynamic Cluster only.

type UpdateClusterAccountDefaultsOutput added in v0.3.0 

type UpdateClusterAccountDefaultsOutput struct{}

UpdateClusterAccountDefaultsOutput holds the result of UpdateClusterAccountDefaults.

type UpdateClusterAccountPrefsInput added in v0.3.0 

type UpdateClusterAccountPrefsInput struct {
	Preferences cgpdata.Dictionary // required
}

UpdateClusterAccountPrefsInput merges Preferences into the cluster-wide default Account Preferences, leaving keys not present in Preferences unchanged. Available in the Dynamic Cluster only.

type UpdateClusterAccountPrefsOutput added in v0.3.0 

type UpdateClusterAccountPrefsOutput struct{}

UpdateClusterAccountPrefsOutput holds the result of UpdateClusterAccountPrefs.

type UpdateClusterDomainDefaultsInput added in v0.3.0 

type UpdateClusterDomainDefaultsInput struct {
	Settings cgpdata.Dictionary // required
}

UpdateClusterDomainDefaultsInput merges Settings into the cluster-wide default Domain settings, leaving keys not present in Settings unchanged. Available in the Dynamic Cluster only.

type UpdateClusterDomainDefaultsOutput added in v0.3.0 

type UpdateClusterDomainDefaultsOutput struct{}

UpdateClusterDomainDefaultsOutput holds the result of UpdateClusterDomainDefaults.

type UpdateDomainDefaultsInput added in v0.3.0 

type UpdateDomainDefaultsInput struct {
	Settings cgpdata.Dictionary // required
}

UpdateDomainDefaultsInput merges Settings into the server-wide default Domain settings, leaving keys not present in Settings unchanged.

type UpdateDomainDefaultsOutput added in v0.3.0 

type UpdateDomainDefaultsOutput struct{}

UpdateDomainDefaultsOutput holds the result of UpdateDomainDefaults.

type UpdateDomainSettingsInput added in v0.2.0 

type UpdateDomainSettingsInput struct {
	DomainName string             // optional; empty applies to the administrator Domain
	Settings   cgpdata.Dictionary // required
}

UpdateDomainSettingsInput merges Settings into a domain's stored settings, leaving keys not present in Settings unchanged. A setting whose new value is the string "default" is removed, so the default value applies again.

type UpdateDomainSettingsOutput added in v0.2.0 

type UpdateDomainSettingsOutput struct{}

UpdateDomainSettingsOutput holds the result of UpdateDomainSettings.

type UpdateListInput added in v0.3.0 

type UpdateListInput struct {
	ListName string             // required; may include the Domain name
	Settings cgpdata.Dictionary // required
}

UpdateListInput merges Settings into a mailing list's stored settings, leaving keys not present in Settings unchanged.

type UpdateListOutput added in v0.3.0 

type UpdateListOutput struct{}

UpdateListOutput holds the result of UpdateList.

type UpdateLogSettingsInput added in v0.3.0 

type UpdateLogSettingsInput struct {
	Settings cgpdata.Dictionary // required
}

UpdateLogSettingsInput merges Settings into the Main Log settings, leaving keys not present in Settings unchanged.

type UpdateLogSettingsOutput added in v0.3.0 

type UpdateLogSettingsOutput struct{}

UpdateLogSettingsOutput holds the result of UpdateLogSettings.

type UpdateModuleInput added in v0.3.0 

type UpdateModuleInput struct {
	ModuleName string             // required
	Settings   cgpdata.Dictionary // required
}

UpdateModuleInput merges Settings into a Server module's existing settings dictionary, leaving keys not present in Settings unchanged.

type UpdateModuleOutput added in v0.3.0 

type UpdateModuleOutput struct{}

UpdateModuleOutput holds the result of UpdateModule.

type UpdateNamedTaskInput added in v0.3.0 

type UpdateNamedTaskInput struct {
	TaskName string             // required; may include the Domain name
	Settings cgpdata.Dictionary // required
}

UpdateNamedTaskInput merges Settings into a Named Task's stored settings, leaving keys not present in Settings unchanged.

type UpdateNamedTaskOutput added in v0.3.0 

type UpdateNamedTaskOutput struct{}

UpdateNamedTaskOutput holds the result of UpdateNamedTask.

type UpdateScheduledTaskInput added in v0.3.0 

type UpdateScheduledTaskInput struct {
	AccountName string             // required; "*" names the current authenticated Account
	TaskData    cgpdata.Dictionary // required; see CLI.html#UPDATESCHEDULEDTASK for its id/program/script/parameter/when/period elements
}

UpdateScheduledTaskInput creates, updates, or (if TaskData has no `program` and no `script` element) deletes an Account Scheduled Task record.

type UpdateScheduledTaskOutput added in v0.3.0 

type UpdateScheduledTaskOutput struct{}

UpdateScheduledTaskOutput holds the result of UpdateScheduledTask.

type UpdateServerAccountDefaultsInput added in v0.3.0 

type UpdateServerAccountDefaultsInput struct {
	Settings cgpdata.Dictionary // required
}

UpdateServerAccountDefaultsInput merges Settings into the server-wide default Account settings, leaving keys not present in Settings unchanged.

type UpdateServerAccountDefaultsOutput added in v0.3.0 

type UpdateServerAccountDefaultsOutput struct{}

UpdateServerAccountDefaultsOutput holds the result of UpdateServerAccountDefaults.

type UpdateServerAccountPrefsInput added in v0.3.0 

type UpdateServerAccountPrefsInput struct {
	Preferences cgpdata.Dictionary // required
}

UpdateServerAccountPrefsInput merges Preferences into the server-wide default Account Preferences, leaving keys not present in Preferences unchanged.

type UpdateServerAccountPrefsOutput added in v0.3.0 

type UpdateServerAccountPrefsOutput struct{}

UpdateServerAccountPrefsOutput holds the result of UpdateServerAccountPrefs.

type UpdateServerSettingsInput added in v0.3.0 

type UpdateServerSettingsInput struct {
	Settings cgpdata.Dictionary // required
}

UpdateServerSettingsInput merges Settings into the "other" Server settings, leaving keys not present in Settings unchanged.

type UpdateServerSettingsOutput added in v0.3.0 

type UpdateServerSettingsOutput struct{}

UpdateServerSettingsOutput holds the result of UpdateServerSettings.

type UpdateSessionInput added in v0.3.0 

type UpdateSessionInput struct {
	SessionID  string             // required
	DomainName string             // optional; the Domain the session's Account belongs to
	Settings   cgpdata.Dictionary // required
}

UpdateSessionInput modifies a Session's custom parameters. In Settings, the special string value "#NULL#" removes the corresponding attribute.

type UpdateSessionOutput added in v0.3.0 

type UpdateSessionOutput struct{}

UpdateSessionOutput holds the result of UpdateSession.

type UpdateStorageFileAttrInput added in v0.3.0 

type UpdateStorageFileAttrInput struct {
	AccountName     string        // required; "*" names the current authenticated Account
	FileName        string        // required
	Attributes      cgpdata.Array // required: an Array of XML elements - the new attribute values
	AuthAccountName string        // optional: run the command on behalf of this Account
}

UpdateStorageFileAttrInput updates attributes of an Account File Storage file or file directory.

type UpdateStorageFileAttrOutput added in v0.3.0 

type UpdateStorageFileAttrOutput struct{}

UpdateStorageFileAttrOutput holds the result of UpdateStorageFileAttr.

type UploadPluginFileInput added in v0.3.0 

type UploadPluginFileInput struct {
	Content []byte // required; the plugin binary representation
	DryRun  bool   // optional; check the plugin without installing it
}

UploadPluginFileInput uploads a plugin binary to the server.

type UploadPluginFileOutput added in v0.3.0 

type UploadPluginFileOutput struct{}

UploadPluginFileOutput holds the result of UploadPluginFile.

type VerifyAccountIdentityInput added in v0.3.0 

type VerifyAccountIdentityInput struct {
	AccountName string // required; "*" names the current authenticated Account
	Identity    string // required, e.g. `Real Name <user@domain.dom>`
}

VerifyAccountIdentityInput checks whether identity is a legal 'From:' header value for an Account.

type VerifyAccountIdentityOutput added in v0.3.0 

type VerifyAccountIdentityOutput struct{}

VerifyAccountIdentityOutput holds the result of VerifyAccountIdentity.

type VerifyAccountPasswordInput 

type VerifyAccountPasswordInput struct {
	AccountName string // required; "*" names the current authenticated Account
	Password    string // required
}

VerifyAccountPasswordInput checks a candidate password against an account's actual one, without changing it.

type VerifyAccountPasswordOutput 

type VerifyAccountPasswordOutput struct{}

VerifyAccountPasswordOutput holds the result of VerifyAccountPassword.

type WriteLogInput added in v0.3.0 

type WriteLogInput struct {
	Level  int    // required
	Record string // required
}

WriteLogInput stores one record into the Server Log; records written this way carry the SYSTEM prefix.

type WriteLogOutput added in v0.3.0 

type WriteLogOutput struct{}

WriteLogOutput holds the result of WriteLog.

type WriteStorageFileInput added in v0.2.0 

type WriteStorageFileInput struct {
	AccountName string // required; "*" names the current authenticated Account
	FileName    string // required
	Content     []byte // stored as a datablock; empty content is allowed
}

WriteStorageFileInput stores a file in the Account File Storage, replacing an existing file with the same name. A FileName ending in "/" creates a directory; Content must be empty in that case.

type WriteStorageFileOutput added in v0.2.0 

type WriteStorageFileOutput struct{}

WriteStorageFileOutput holds the result of WriteStorageFile.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.