zmsoap

ZCS Administrator Guide 8.0

Open Source Edition

Appendix A Command-Line Utilities > zmsoap

zmsoap

Prints mail, account, and admin information in the SOAP format.

Syntax

zmsoap [options] <path1 [<path2>...]

Description

Long Name

Short Name

Description

--help

-h

Prints usage information

--mailbox

-m

<name> Displays mailbox account name. Mail and account requests are sent to this account.

This attribute is also used for authentication if -a and -z are not specified

--target

<name>Displays the target account name to which the requests are sent. Used only for non-admin sessions

--admin name

-a

<name>Displays the admin account name to authenticate as

--zadmin

-z

Displays the Zimbra admin name and password to authenticate as

--password

-p

<pass>Displays account password

--passfile

-P

<path> Reads password from a file

--element

-e

<path> Displays the root element path. If specified, all path arguments that do not start with a slash (/) are relative to this element

--type

-t

<type> Displays the SOAP request type. Can either be mail, account, or admin

--url

-u

<http[s]://...> Displays the server hostname and optional port value

--verbose

-v

Prints the SOAP request and other status information

path

<[path...]> Displays the element or attribute path and value. Roughly follows the XPath syntax as:

[/]element1[/element2][/@attr][=value]

Long Name	Short Name	Description
--help	-h	Prints usage information
--mailbox	-m	<name> Displays mailbox account name. Mail and account requests are sent to this account. This attribute is also used for authentication if -a and -z are not specified
--target		<name>Displays the target account name to which the requests are sent. Used only for non-admin sessions
--admin name	-a	<name>Displays the admin account name to authenticate as
--zadmin	-z	Displays the Zimbra admin name and password to authenticate as
--password	-p	<pass>Displays account password
--passfile	-P	<path> Reads password from a file
--element	-e	<path> Displays the root element path. If specified, all path arguments that do not start with a slash (/) are relative to this element
--type	-t	<type> Displays the SOAP request type. Can either be mail, account, or admin
--url	-u	<http[s]://...> Displays the server hostname and optional port value
--verbose	-v	Prints the SOAP request and other status information
path		<[path...]> Displays the element or attribute path and value. Roughly follows the XPath syntax as: [/]element1[/element2][/@attr][=value]