Google Message Security Batch Reference Guide - Manual (Page 399)

Chapter 7
Batch User Fields 411
Batch User Fields
Chapter 7
About Batch User Fields
The batch user fields hold user-level data which a command can either create,
delete, display, list, or modify. This information is diverse. It can be names, email
addresses, numbers, dispositions, on/off switches, boolean true/false values.
User Field Reference Page Syntax Notations
Each field’s syntax section uses notation and punctuation to show you where to
put your specific information, and what information is required or optional:
The reference pages use the Administration Console syntax and have an example
for each field:
• The field name is required. In the Administration Console batch page,
commas are required.
• Information between ‘< >’ symbols means you need to add your specific
information here. (for example: = becomes
[email protected] )
• Information between ‘[ ]’ square brackets mean this type of information is
optional.
• A choice of values are separated by ‘|’. (for example: lang_locale= code string | NULL > means you have a choice of
lang_locale=en_us.utf8,
or lang_locale=NULL )
• Some fields have ‘+’ or ‘-’ notations. Read the field description and examples
carefully to understand what these notations mean for that particular field.
• It is important to confirm you have authorization to display or edit a field
(Read/Write authorization). The Authorization section shows each field’s
requirements.
• The Related Commands section shows which commands take the field as
input or as output. Input means the field is used in the command’s arguments.
Output means the command returns this field-value pair when the command
is successfully executed.