Message Security Batch Reference Guide • • • • Google Message Filtering Google Message Security Google Message Discovery Message Security and Discovery for Google Apps Premier Edition
Google, Inc. 1600 Amphitheatre Parkway Mountain View, CA 94043 www.google.com Part number: EEBR_R646_00 29 February 2012 © Copyright 2012 Google, Inc. All rights reserved. Google, the Google logo, Google Message Filtering, Google Message Security, Google Message Discovery, Postini, the Postini logo, Postini Perimeter Manager, Postini Threat Identification Network (PTIN), Postini Industry Heuristics, and PREEMPT are trademarks, registered trademarks, or service marks of Google, Inc.
This software is provided “AS IS.” The copyright holders disclaim all warranties, either express or implied, including but not limited to implied warranties of merchantability and fitness for a particular purpose, with respect to this code and accompanying documentation. Although their code does not appear in gd 1.8.4, the authors wish to thank David Koblas, David Rowley, and Hutchison Avenue Software Corporation for their prior contributions.
Contents Chapter 1: Introduction to Batch Processing ................................................. 13 About this Book.................................................................................................... 13 Related Documentation ................................................................................ 14 About Batch Processing ...................................................................................... 15 When To Use Batch .................................................
IP Locking Commands.......................................................................................100 List Commands..................................................................................................100 Message Archiving Message Archiving Commands..........................................101 Message Encryption Commands.......................................................................102 Modify Commands................................................................................
archive_settings display.....................................................................................148 archive_settings modify .....................................................................................150 blockprovuser ....................................................................................................152 checklatency ......................................................................................................153 checkroute ......................................
password force_update .....................................................................................265 password reset ..................................................................................................267 password_policy display ....................................................................................269 password_policy update ....................................................................................271 promoteprovuser..............................................
is_email_config ..................................................................................................347 journaling ...........................................................................................................348 lang_locale (for orgs) .........................................................................................350 lastmod_date (for orgs)......................................................................................351 mail_flow..................................
active .................................................................................................................412 address ..............................................................................................................413 approved_recipients ..........................................................................................414 approved_senders (for users)............................................................................416 blocked_senders (for users) ................
domainname ......................................................................................................470 org (for domains) ...............................................................................................471 primary_did ........................................................................................................472 primary_dom......................................................................................................473 substrip ................................
Chapter 10: Batch Spool Fields......................................................................521 About Batch Spool Fields ..................................................................................521 Spool Field Reference Page Syntax Notations ..........................................521 auto_unspool .....................................................................................................522 despool_max_connections .................................................................
Chapter 1 Introduction to Batch Processing Chapter 1 About this Book Welcome to the Batch Reference Guide for Message Security. The book components are: • The Batch Command Line Interface -- The batch commands offer a quick and efficient command line interface to perform a large number of configuration changes. • The EZCommand Interface -- Is a Perl-based scripting interface that allows administrators to perform a subset of basic administrative tasks.
The Message Security service Customer Care does not provide technical support for configuring mail servers or third-party products. In the event of an issue with these products, you should consult with your administrator. Google accepts no responsibility with third-party products. Please contact Postini Professional Services (professionalservices@postini.com) for consulting services.
Document Description Postini Message Archiving Administration Guide Instructions for setting up and administering Message Archiving to provide long-term, immutable storage of your organization’s electronic communications. Postini Message Archiving User’s Guide Instructions for retrieving and exporting email messages, IM conversations, and IM file transfers from your corporate message archive.
Batch Validation In the Administration Console’s Batch page, the batch validator checks either a batch file or batch commands typed in to the batch page for: • Syntax errors within each command • Ability to process the command based on the administrator’s level or authorization • Existence of orgs, users, aliases and domains affected by commands Resulting success and error messages are displayed on the screen. Validation does not process any commands.
2. Create and enter your batch commands by either of the following methods: If you need to work with several batch command modifications or lists, create a text file containing the batch commands and browse for that file. • The file can have any file extension. • If writing comments in the file begin the comment line with # on a separate line. #This is an example of a batch command file comment line • The full command syntax must be on one line.
This process code ensures that batch files are not submitted by inadvertently clicking Submit job instead of Validate. If you do not enter the process code, then your batch file will not be uploaded or processed. 6. For a quick check on your command syntax, use the command line Help feature. a. Either in your batch file or in the command field, type help . For example: help displayorg b. Click the Submit job button.
Following are the batch command syntax tokens: • batch-command -- The name of the batch command to process. • 1st-argument -- The domain, organization, user, or alias being acted upon by the batch command. • 1st-option -- The first batch command optional argument which modifies the behavior of the batch command. • 2nd-option -- The second batch command optional argument which modifies the behavior of the batch command. • 1st-field -- The first field being assigned by the batch command.
This example uses the ‘Sales’ organization which has two domains, ‘@sales.jumboinc.com’ and ‘@support.jumboinc.com’. It returns all of the users whose addresses end with ‘sales.jumboinc.com’. listusers sales.jumboinc.com$, targetOrg=Sales, aliases=0, childorgs=1, sort=ADDRESS:a, fields=ADDRESS • The listusers command searches for all user addresses that end with ‘sales.jumboinc.com’. The $ flag targets the search to text ending with the given address string ‘sales.jumboinc.com’.
8. You can now validate this file and upload it as a batch file as described in “Batch Processing Steps” on page 16. Modifying Users in a Domain with Download Users/Settings An alternative to using the list commands is to use the Download Users/Settings. To modify all users in a domain, download the list of all users and craft it into a batch file using the modifyuser batch command. 1. Open the Administration Console and select the Orgs and Users tab. 2.
About EZCommand EZCommand is a Perl-based scripting interface that allows administrators to perform basic tasks without having to log in to the Administration Console. EZCommand facilitates the integration of various administrative functions with the administrator’s tools and applications. Note: This interface is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Note: You can create or modify this shared secret using the modifyorg command and the remotecmd_secret field. For example: modifyorg sales, remotecmd_secret=swordfish 3. Check and set administrator privileges for the organizations you plan to work with. EZCommands are only limited by the authorization for the administrator who processes the. See The Message Security Administration Guide, “Administrators” chapter for details on authorization.
EZCommand Response Codes The HTTP response will contain a two-part return value: • status: 1 for success or 0 for failure • message: contains additional details EZCommand Example For example, to add the user, agoodman@jumboinc.com using the privileged account administrator@jumboinc.com, at host name ac-s8.postini.com. Submit: https://ac-s8 .postini.com/exec/ remotecmd?auth=3X2dLdwfb9BLKtmr%2F5f4hOn82rsRLWGadministrator%40ju mboinc.com&cmd=adduser%20agoodman%40jumboinc.
https://ac-s.postini.com/exec/ remotecmd?auth=&cmd=adduser%20agoodman%40jumboinc.com% 2c%20welcome%3d1 where N is the system number and is the SHA1-encrypted shared secret/username pair. Note that this includes *all* non-alphanumeric characters, not just URL specialmeaning characters as defined by RFC2396.
modifyuser Syntax: modifyuser username [field=value]... suspenduser Syntax: suspenduser username [notify] [hardSuspend] [deliver] • suspend: All filtering services are turned off. • notify: User receives mail explaining the suspension. • hardSuspend: User is flagged as not allowed to log into the web site. • deliver: Any quarantined email for the user is delivered. Virus infected email is not cleaned.
Chapter 2 Batch Command and Field Quick Summary Chapter 2 About the Batch Command and Field Quick Summary This index is a quick summary for the batch commands and fields. Each command and field is listed with a simple description, the command’s or field’s syntax, and an example. For other quick reference information, see the “Batch Command Quick Summary” on page 91, “Batch Field Quick Summary” on page 111, and the “Additional Reference Information” on page 569.
Batch Commands addalias The addalias command associates an additional address with a user’s primary email address. The alias receives the same filtering and shares the same User Ouarantine as the user’s primary email address. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Batch Command Syntax and Example: addalias , , [ confirm ] addalias msmith@jumboinc.com, mary@jumboinc.
This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Batch Command Syntax and Example: adduser [, =, ...], [org=], [welcome=<1 | 0>] adduser jim@jumboinc.com, approved_senders=+hugeisp.com, welcome=1 archive_settings display The archive_settings display command displays the archive settings for an organization.
checklatency The checklatency command measures the connection delay between the email data center and your email server. This is the Latency Test. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Batch Command Syntax and Example: checklatency , mailhost= checklatency sales email config, mailhost=my.mailserver.
This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Batch Command Syntax and Example: deletedomain deletedomain jumboinc.com deleteorg The deleteorg command removes an organization from the Message Security service. Batch Command Syntax and Example: deleteorg deleteorg “Jumbo’s Western Region” deleteprovuser The deleteprovuser command removes a provisional user that is known to be illegitimate.
displaydomain The displaydomain command displays all of the selected domain’s settings information. Batch Command Syntax and Example: displaydomain displaydomain jumboinc.com displayorg The displayorg command displays all the selected organization’s settings information. Batch Command Syntax and Example: displayorg displayorg “Jumbo’s Western Region” displayprovuser The displayprovuser command shows the active list of provisional users.
displayspool displayspool jumboemailconfig displayuser The displayuser command shows all the user’s settings information. Batch Command Syntax and Example: displayuser displayuser msmith@jumboinc.com domain_tls add The domain_tls add add command adds Policy-Enforced TLS to organizations which need to identify domain names that require inbound and outbound message traffic to be sent via a TLS connection.
domain_tls display The domain_tls display command displays Policy-Enforced TLS settings for organizations which need to identify domain names that require inbound and outbound message traffic to be sent via a TLS connection. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Batch Command Syntax and Example: encryption display_user, address= encryption display_user, address=msmith@jumboinc.com encrypton list_users The encryption list_users command lists all encryption users in this organization. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
getorgreport The getorgreport command builds a traffic, virus, spam, or usage report for a selected organization. Batch Command Syntax and Example: getorgreport , report=, date=, [top=] getorgreport sales, report=traffic_summary, date=20060916-20060901 getorgreport sales, report=spam_summary, date=20060331, top=10 getorgreport sales, report=usage_summary, date=20060331 help The help command lists the syntax, example, and quick tips for a command.
im display The im display command displays an IM record for an IM screen name. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Batch Command Syntax and Example: im display im_name= im display im_name=MSN:kristie_kerns@hotmail.com im list The im list command displays IM screen names for a specific organization.
iplock add_range org=, domain=, range=[/] Single Domain and IP Address/CIDR Subnet iplock add_range org=sales_email_config, domain=jumboinc.com, range=64.18.0.0 iplock add_range org=sales_email_config, domain=jumboinc.com, range=64.18.0.0/16 iplock delete The iplock delete command removes all domains with IP limitations configured in the specified email configuration organization.
This command is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Batch Command Syntax and Examples: iplock display org= iplock display org=sales_email_config iplock set_disposition The iplock set_disposition command configures the IP lock’s response behavior when a message does not match the IP range. Note: This command is not available in this version.
listdomains , targetOrg= [,orgtaggs= ] [, primaryqs= ] [,aliases=<0 | 1> ] [,childorgs=<0 | 1> ] [,sort= ] [,fields= ] [,start= ] [,end= ] listdomains ALL, targetOrg=sales, childorgs=1, sort=ORGTAG:a listorgs The listorgs command returns a list of organizations. The list can be all organizations or it can be sorted and filtered.
listprovusers [, subset=ALL | BLOCK | UNBLOCK] [, addressqs=] [, childorgs=0 | 1] [, sort= ] [, fields= ] [, start= ] [, end= ] listprovusers My Company, subset=ALL, sort=TS1:d, fields=ADDRESS|TS1|TS3 listusers The listusers command returns a list of users. The list can be all users or it can be sorted and filtered.
Batch Command Syntax and Example: modifydomain , [neworg= | substrip= | alias=] modifydomain jumboinc.com, substrip=no modifyorg The modifyorg command modifies an organization’s settings. Batch Command Syntax and Example: modifyorg [,field=, ...] modifyorg sales, im_enable=on modifyuser The modifyuser command modifies a user’s settings. Batch Command Syntax and Example: modifyuser [, =, ...
notification modify type=attachment_manager_inbound, org= [ , | unlink | default ] notification modify type=attachment_manager_inbound, org=sales, state=user, text=default notification modify type=attachment_manager_outbound, org= [ , state= user | quarantine redirect | both | off ] | [ , text=link: | unlink | default ] noti
notification modify type=welcome_user, org= [ , state= ] | [ , text=link: | unlink | default ] | [ , cc= ] notification modify type=welcome_user, org=sales, state=on, text=default, cc=msmith@jumboinc.com org_im_sesttings display The org_im_settings display command displays all of the IM settings for an organization.
password force_update user= password force_update org= [, cascade= ] password force_update user=msmith@jumboinc.com password force_update org=Sales password force_update org=Sales, cascade=yes password reset The password reset command resets a user’s password. This command is used with an organization using the PMP or PMP password policy configuration. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
password_policy update > | > [, min_length=<1 - 10> | null ] [, required_complexity=] [, max_login_attempts=<1 - 10 | null>] [, lockout_period=<1 - 999 number of minutes | null>] [, max_password_age=<1 - 999 number of days | null>] [, password_history=<0 | 1 - 24 | null>] [, cascade= ] password_policy update org=Sales, min_length=6, required_complexity=yes, lockout_period=60 promoteprovuser The promoteprovuser command adds a provisional user to
Batch Command Syntax and Example: setorgsubstripping , setorgsubstripping sales,1 suspenduser The suspenduser command suspends a user by disabling all filtering and the user’s access to the Message Center. Batch Command Syntax and Example: suspenduser [ , notify] [ , hardSuspend] [ , deliver] suspenduser msmith@jumboinc.com, hardSuspend suspenduser msmith@jumboinc.
Batch Command Syntax and Example: testmx testmx mailserver.jumboinc.com unblockprovuser The unblockprovuser command unblocks provisional users who have been blocked from becoming regular users. Provisional users are created with SmartCreate. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Batch Command Syntax and Example: unblockprovuser unblockprovuser msmith@jumboinc.
user_im_settings display The user_im_settings display command displays IM settings for a given user email address. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Batch Command Syntax and Example: user_im_settings display address= user_im_settings display address=msmith@jumboinc.com user_im_settings modify The user_im_settings modify command modifies IM settings for a given user email address.
alias = , ... modifydomain jumboinc.com, alias=jumboalias.com aliasedfrom The aliasedfrom field lists a domain’s aliases. Syntax and Example: aliasedfrom < domain’s alias >, ... aliasedfrom “hugeisp.com, jumboincwest.com” aliasedto The aliasedto field lists the domain associated with this alias. Syntax and Example: aliasedto aliasedto jumboinc.com created_ts (for domains) The created_ts (for domains) field holds the domain’s creation timestamp.
domainname= domainname jumboinc.com org (for domains) The org (for domains) field holds the organization associated with the domain. Syntax and Example: org = org sales primary_did The primary_did field holds the primary domain ID. Syntax and Example: primary_did = primary_did 100001012 primary_dom The primary_dom field holds the primary domain name associated with a domain alias. Syntax and Example: primary_dom = < primary domain name > primary_dom jumboinc.
sub_strip=< on/1 | off/0 > sub_strip=on substrip The substrip field enables subdomain substripping for the domain. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Syntax and Example: substrip=< on/1 | off/0 > substrip=on Organization Fields approved_senders (for orgs) The approved_senders (for orgs) field holds an email address or domain to be added or removed from the organization-level Approved Senders list.
archive_enable= archive_settings modify org=Jumbo ABC, archive_enable=on, mail_flow=on, journaling=on async_bounce The async_bounce field lists whether the Connection Manager’s Asynchronous Bouncing control is activated for inbound traffic. This control is for email servers that issue “unknown user” bounce messages asynchronously and require added security. This field is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
modifyorg sales, authentication_data=”mypopserver, +jumboinc.com” modifyorg sales, authentication_data=”mypopserver, @USERDOMAIN” modifyorg sales, authentication_data=”mypopserver, +USERDOMAIN” authentication_type The authentication_type field holds the type of authentication protocol used by an organization.
Syntax and Example: blocked_senders=< [+] | -emailaddress> | < [+] | -domain name | empty>,... modifyorg sales, blocked_senders=+jim@hugeisp.com bounce_fragments The bounce_fragments field enables partial message fragments to be quarantined or bounced. Syntax and Example: bounce_fragments= modifyorg sales, bounce_fragments=on company_name The company_name field holds the company or entity name that is used in email notifications.
createor The creator field lists the ID of the administrator who created the organization. Syntax and Example: creator= creator msmith@jumboinc.com custom_journal The custom_journal field is an on/off switch for IM conversations sent to the IM administrator’s email address. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
disable_first_spam The disable_first_spam field is an organization-level activation switch for a new user’s notification telling the user the first spam message has been quarantined in the user’s Message Center. Syntax and Example: disable_first_spam=<0/on | 1/off | NULL ()> modifyorg sales, disable_first_spam=1 disposition_virus The disposition_virus field holds the disposition status of an email containing a virus.
footer_on The footer_on field holds the activation status for an organization-level outbound Compliance Footer which describes an email policy or legal compliance. Syntax and Example: footer_on= modifyorg sales, footer_on=on iid The iid field lists the unique sequential database assigned key for this organization. Syntax and Example: iid= iid 100050344 im_enable The im_enable field is an organization-level switch enabling IM Security.
im_proto_enable The im_proto_enable field lists what IM protocols are allowed for the organization. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Syntax and Example: im_proto_enable=<+ | -protocol>,... | NULL modifyorg sales, im_proto_enable=+yahoo,-AIM is_email_config The is_email_config field states whether a configuration is the email config organization or not.
lastmod_date (for orgs) The lastmod_date (for orgs) field holds the date the organization was last modified. Syntax and Example: lastmod_date=
This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Syntax and Example: message_encryption_criteria= | NULL modifyorg sales, message_encryption_criteria=This message is encrypted ndr The ndr field holds outbound mail configuration (block or blackhole) for undeliverable bounce messages generated by the organization’s mail server. This is the control for Undeliverable Bounce Message handling.
Syntax and Example: nullsender_disposition= | ERROR | NULL > addorg Sales, parent=”Jumbo,San Carlos”, nullsender_disposition=quarantine modifyorg Sales, nullsender_disposition=blackhole modifyorg Sales, nullsender_disposition=”511 Refused - no sender” addorg Sales, parent=”Jumbo, San Carlos”, nullsender_disposition=”ERROR 499 Deferred - no sender” nullsender_headertag_validation The nullsender_headertag_validation field holds the number of hours an NDR or “bounce”
Syntax and Example: out_at_notify_on=< 0 | 1 | 2 | 3 | NULL ()> modifyorg sales, out_at_notify_on=1 outbound_max_message_size The outbound_max_message_size field holds the maximum size of attachmentsper-message that users in the organization can send. Syntax and Example: outbound_max_message_size=<1 - 300 (MB) | NULL (200M)> modifyorg sales, outbound_max_message_size=200 outbound_virus The outbound_virus field holds the activation status for outbound virus scanning.
qsum_actionable The qsum_actionable field determines if Quarantine Summary links are available. Syntax and Example: qsum_actionable=<“not actionable” | “basic delivery”> modifyorg sales, qsum_actionable=”not actionable” qsum_enable The qsum_enable field is a switch that sends the Quarantine Summary notifications.
qtine_redir_out_atq The qtine_redir_out_atq field holds the user address for the Attachment Manager quarantined email for this organization. When an outbound message is quarantined by Attachment Manager, the message is stored in this Message Center. Syntax and Example: qtine_redir_out_atq= modifyorg sales, qtine_redir_out_atq=support@jumboinc.
quarantine_links The quarantine_links field is a switch to enable quarantine message links to be available in the Message Center. Syntax and Example: quarantine_links= modifyorg sales, quarantine_links=0 quarsum_links The quarsum_links field is a switch enabling Quarantine Summary message links to be available.
spam_notify_on The spam_notify_on field is a switch enabling the sending of spam quarantine notifications. Syntax and Example: spam_notify_on=
tls_notify_admin The tls_notify_admin field lists the administrator who receives the email config organization’s Policy-Enforced TLS alerts. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Syntax and Example: tls_notify_admin = modifyorg Sales tls_notify_admin = msmith@jumboinc.com tls_notify_on The tls_notify_on field enables Policy-Enforced TLS alerts for an email config organization.
virus_notify (for orgs) The virus_notify (for orgs) field specifies how frequently virus notification email will be generated for the organization. Syntax and Example: virus_notify=<0 | 1 | 9 | NULL ()> modifyorg JumboInc virus_notify=9 welcome_on The welcome_on field allows the system to send out welcome notifications. It shows whether a message should receive a welcome message at some point within the next 24 hours.
modifyorg sales, zero_hour_scan=1 Report Fields acc_messages The acc_messages field holds the number of email messages sent to accounts or aliases registered in the Message Security service for the Traffic Report. Syntax and Example: acc_messages = acc_message 2 account The account field holds the user account for spam and virus messages in the orglevel Spam and Virus Reports.
bulk The bulk field holds the total number of messages quarantined by the general category for junk email filtering for the Spam Report Syntax and example: bulk= bulk 3 bytes The bytes field holds the total number of quarantined spam or virus messages in bytes for the Spam or Virus Report. Syntax and Example: bytes= bytes 3 cleanings The cleanings field holds the number of viruses cleaned for the Virus Report.
commerce= commerce 3 customerid The customerid field holds unique identifying number for an Message Security service account customer. Used in the Usage Report. Syntax and Example: customerid= customerid 11111101 customername The customername field holds the name of the customer. Used in the Usage Report.
messages The messages field holds the total number of messages for the Usage Report. Syntax and Example: messages = messages 11 mmf The mmf field holds the total number of Get Rich messages for the Spam Report. Syntax and Example: mmf= mmf 3 naughty The naughty field holds the total number of messages triggering the Sexually Explicit junk email filter for the Spam Report.
num_f_messages The num_f_messages field holds the total number of messages delivered directly to your mail server for all addresses in the server’s domain for the Traffic Report. This is Forward Acct Messages. Syntax and Example: num_f_messages= num_f_messages 3 num_messages The num_messages field holds the total number of messages passed through the Message Security service for the Traffic Report.
Syntax and Example: num_viruses = num_viruses 3 pct_bh_bytes The pct_bh_bytes field holds the total percent of blackholed messages in bytes for the Traffic Report. Syntax and Example: pct_bh_bytes= pct_bh_bytes 3 pct_bh_messages The pct_bh_messages field holds the total percent of blackholed messages for the Traffic Report.
pct_q_bytes The pct_q_bytes field holds the total percent of quarantined messages in bytes for the Traffic Report. Syntax and Example: pct_q_bytes= pct_q_bytes 3 pct_q_messages The pct_q_messages field holds the total percent of quarantined messages for the Traffic Report. Syntax and Example: pct_q_messages= pct_q_messages 3 productid The productid field holds the Message Security service product name for the Usage Report.
recip= recip msmith@jumboinc.com sellerid The sellerid field holds the unique identifying number of the Message Security service seller for the Usage Report. Syntax and Example: sellerid= sellerid 11111801 ssb The ssb field holds the number of messages impacted by the Blatant Spam Blocking for the Spam Report.
Spool Fields These fields are applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. auto_unspool The auto_unspool field is the on/off switch for automatically delivering spooled messages. Syntax and Example: auto_unspool= auto_unspool ’0’ despool_max_connections The despool_max_connections field holds the maximum number of dedicated connections which will deliver your spooled mail when an outage is complete.
quota The quota field holds the assigned space available for spooling for this email config managed by Spool Manager. Syntax and Example: quota= quota 5242880 spool_delay The spool_delay field, in conjunction with connection failures, determines how many seconds before spooling starts. Syntax and Example: spool_delay=<900 | 1800 | 3600> spool_delay 900 spool_mech The spool_mech field holds the initiation mechanism that starts spooling.
used_pct= < total number string> status Suspended used_size The used_size field holds the used amount of allocated spool storage for an email config managed by Spool Manager. Syntax and Example: used_size=< total amount in bytes > used_pct 3.00 User Fields active The active field indicates whether the user has ever logged into the Message Center. Syntax and Example: active= active 1 (yes) address The address field holds the email address of the user or the user’s alias.
approved_recipients=< [+] | -user address>< [+] | -domain name>,... | ‘empty’ modifyuser msmith@jumboinc.com, approved_recipients=newupdates@hugeisp.com approved_senders (for users) The approved_senders (for users) field holds an email address or domain to be added or removed from the user-level Approved Senders list in the user’s Message Center. Syntax and Example: approved_senders=< [+] | -user address>, ... | < [+] | -domainname>,... | modifyuser msmith@jumbocinc.
created_ts (for users) The created_ts (for users) field holds the date the im_map record was created. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Syntax and Example: created_ts= created_ts: 2006/04/14 00:36:28 GMT filter_adult The filter_adult field holds the sexual content filter settings for the user. Syntax and Example: filter_adult= modifyuser msmith@jumboinc.
filter_offers= modifyuser msmith@jumboinc.com, filter_offers=moderate filter_racial The filter_racial field holds Racially Insensitive category filter setting for the user. Syntax and Example: fitler_racial= modifyuser msmith@jumboinc.com, filter_racial=moderate im_name The im_name field holds the IM user’s im screen name. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
lang_locale (for users) The lang_locale (for users) field enables user-level language localization in Message Center II’s static text, the default top text, character sets, and date format. Syntax and Example: lang_locale= modifyuser msmith@jumboinc.com, lang_locale=en_us.utf8 lastmod_date (for users) The lastmod_date (for users) field shows the last time the user record was modified.
message_limit The message_limit field holds the maximum number of messages allowed per day for this user. Syntax and Example: message_limit=<0 - 99999999> | NULL modifyuser msmith@jumboinc.com, message_limit= 1000 message_limited The message_limited field is yes/no switch showing the user has reached the daily message limit. Syntax and Example: message_limited= message_limited 0 (no) notice_address The notice_address field holds the address where notifications for this user are sent.
password= modifyuser msmith@jumboinc.com, password=3pds9999 primary The primary field holds the primary user’s unique identifying ID. Syntax and Example: primary = primary 202846402 primaryadd The primary_add field holds the primary user address. Syntax and Example: primary_add = < user name > primary_add msmith@jumboinc.com timezone (for users) The timezone (for users) field holds the user’s timezone, a UNIX TZ string.
TS3 The TS3 field holds the timestamp for the oldest email message to a provisional user. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Syntax and Example: TS3= < time in UNIX seconds > TS3 1145962000 uid The uid field holds the user’s unique ID. Syntax and Example: uid = < user ID > uid 202846402 u_id The u_id field holds a unique ID for this user.
virus_notify=<0 | 1 | 9 | NULL ()> modifyuser msmith@jumboinc.com, virus_notify=1 virus_state The virus_state field is an on/off/unavailable switch for virus scanning functionality. Syntax and Example: virus_state=<0/on | 1/off | 2/unavailable> modifyuser msmith@jumboinc.com, virus_state=on weblocked The weblocked field is an on/off switch giving Message Center access for the user. Syntax and Example: weblocked=<0/no | 1/yes> modifyuser msmith@jumboinc.
Batch Command and Field Quick Summary 89
Chapter 3 Batch Command Quick Summary Chapter 3 About the Batch Command Quick Summary This index is a quick summary mapping commands to categories of common tasks. Several commands create, display, or modify the data fields. Use this quick reference to discover which commands are specialized for a particular task, and to decide the best way to automate your organization management.
Add Commands Domains adddomain -- The adddomain command adds a domain to your organization hierarchy. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Domain Aliases modifydomain -- The adddomain command adds a domain to your organization hierarchy. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Policy Enforced TLS, Message Encryption domain_tls add -- The domain_tls add command adds Policy-Enforced TLS enablement to organizations which need to identify domain names that require inbound and outbound message traffic to be sent via a TLS connection. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Users adduser -- The adduser command adds users to the Message Security service.
IP Locking iplock delete -- The iplock delete command removes all domains with IP limitations configured in the specified email configuration organization. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. iplock delete_range -- The iplock delete_range command removes either one IP limitation or all IP limitations for one domain configured in the specified email config organization.
Display and Report Commands Domains displaydomain -- The displaydomain command displays all of the selected domain’s settings information. Help help -- The help command lists the syntax, example, and quick tips for a command. IM Security im display -- The im display command displays an IM record for an IM screen name. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Organizations displayorg -- The displayorg command displays all the selected organization’s settings information PMP Passwords password_policy display -- The password_policy display command displays the password policy for an organization. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Users displayuser -- The displayuser command shows all the user’s settings information. Domain Management Commands Add Domains adddomain -- The adddomain command adds a domain to your organization hierarchy. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Delete deletedomain -- The deletedomain command removes the domain from your organizational hierarchy.
Policy Enforced TLS, Message Encryption domain_tls add -- The domain_tls add command adds Policy-Enforced TLS enablement to organizations which need to identify domain names that require inbound and outbound message traffic to be sent via a TLS connection. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Delete im delete -- The im delete command deletes the IM record associated with the user’s IM screen name. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. user_im_settings delete -- The user_im_settings delete command deletes an IM settings record for a given user email address. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
IP Locking Commands Add iplock add_range -- The iplock add_range command allows emails from specific domains with specific IP addresses to be delivered to an organization and its suborganizations.This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Delete iplock delete -- The iplock delete command removes all domains with IP limitations configured in the specified email configuration organization.
IM Security im list -- The im list command displays IM screen names for a specific organization. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. im listforuser -- The im listforuser command displays the complete list of IM screen names associated with a user’s email address. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Modify archive_settings modify -- The archive_settings modify command edits the archive settings for an organization. Message Encryption Commands Policy Enforced TLS domain_tls add -- The domain_tls add command adds Policy-Enforced TLS enablement to organizations which need to identify domain names that require inbound and outbound message traffic to be sent via a TLS connection. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
encryption modify_user -- The encryption modify_user command modifies encryption settings for a user. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Modify Commands Domains modifydomain -- The modifydomain command can move a domain, set subdomain stripping, and modify domain aliases. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Organizations modifyorg -- The modifyorg command modifies an organization’s settings. PMP Passwords password force_update -- The password force_update command forces a user or all users in an organization to change their passwords when logging into the system. This command is used with an organization using the PMP password policy configuration. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Organization Management Commands Add addorg -- The addorg command adds a sub-organization to your organizational hierarchy. Delete deleteorg -- The deleteorg command removes an organization from the Message Security service. Display displayorg -- The displayorg command displays all the selected organization’s settings information. org_im_settings display -- The org_im_settings display command displays all of the IM settings for an organization.
PMP Passwords password force_update -- The password force_update command forces a user or all users in an organization to change their passwords when logging into the system. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. password reset -- The password reset command resets a user’s password. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Unblock unblockprovuser -- The unblockprovuser command unblocks provisional users who have been blocked from becoming regular users. Provisional users are created with SmartCreate. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Spooling Commands Display displayspool -- The displayspool command shows the Spool Manager settings for your email config organization.
Traceroute checkroute -- The checkroute command, or Traceroute Test, traces the network route from the server to the input mail server. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. User Management Commands Add adduser -- The adduser command adds users to the Message Security service. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
user_im_settings display -- The user_im_settings display command displays IM settings for a given user email address. This is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. List listusers -- The listusers command returns a list of users. The list can be all users or it can be sorted and filtered. im listforuser -- The im listforuser command displays the complete list of IM screen names associated with a user’s email address.
Chapter 4 Batch Field Quick Summary Chapter 4 About the Batch Field Quick Summary This index is a quick summary mapping fields to categories of common tasks. Use this quick reference to discover which fields are specialized for a particular task, and to decide the best way to automate your organization management.
Fields -- Related Commands • qtine_redir_out_atq -- displayorg, modifyorg • qtine_redir_out_virus -- displayorg, modifyorg Default User Fields Default User • Name Fields -- Related Commands • default_user -- displayorg, displayuser, modifyuser Spam • Spam on/off Fields -- Related Commands • junkmail_filter -- displayuser, modifyuser Virus • Virus on/off Fields -- Related Commands • virus_state -- displayuser, modifyuser Filters • Adult Settings Fields -- Related Commands • • filter_adult --
Fields -- Related Commands • • filter_getrich -- adduser, displayuser, modifyuser Offers Settings Fields -- Related Commands • • filter_offers -- adduser, displayuser, modifyuser Racial Settings Fields -- Related Commands • filter_racial -- adduser, displayuser, modifyuser Domain General Settings Fields IDs and Name • Alias related domain Fields -- Related Commands • • primary_dom -- listdomains Domain alias Fields -- Related Commands • • alias -- deletedomain, displaydomain, listdomains ID Fi
Substripping • On/Off Fields -- Related Commands • substrip -- displaydomain • sub_strip -- Administration Console-Domain Download/Settings Early Detection Quarantine Fields • On/Off Fields -- Related Commands • • zero_hour_scan -- displayorg, modifyorg Notification Fields -- Related Commands • zero_hour_notify_on -- displayorg, modifyorg Email Config Fields Disaster Recovery/Spooling • On/Off Fields -- Related Commands • • auto_unspool -- displayorg Org name Fields -- Related Commands • •
Fields -- Related Commands • • quota -- displayspool Time before spooling Fields -- Related Commands • • spool_delay -- displayspool Email Config status Fields -- Related Commands • • status -- displayspool Unspooling connection rate Fields -- Related Commands • • despool_max_connections -- displayspool Used allowed space Fields -- Related Commands • • used_pct -- displayspool Allocated space Fields -- Related Commands • used_size -- displayspool IP Locking • Add Fields -- Related Commands
Fields -- Related Commands • orgname -- iplock display Message Encryption (See User, General Setting Fields) • External On/Off Match Fields -- Related Commands • • message_encryption (for orgs) -- displayorg, modifyorg Header text Fields -- Related Commands • • message_encryption_criteria -- displayorg, modifyorg Policy-Enforced TLS administrator Fields -- Related Commands • • tls_notify_admin -- displayorg, modifyorg Policy-Enforced TLS alert Fields -- Related Commands • tls_notify_on -- displ
Fields -- Related Commands • • authentication_type -- displayorg EZCommand secret Fields -- Related Commands • remotecmd_secret -- displayorg, modifyorg General Info • Creation method Fields -- Related Commands • • create_method (for orgs) -- displayorg Creation date Fields -- Related Commands • • created_date -- displayorg Modify date Fields -- Related Commands • lastmod_date (for orgs) -- displayorg Org ID and Names • ID Fields -- Related Commands • • iid -- adddomain, deleteorg, displayor
Fields -- Related Commands • • support_contact -- displayorg, modifyorg Account ID Fields -- Related Commands • • customerid -- getorgreport Creator of org Fields -- Related Commands • • creator -- displayorg Notification name Fields -- Related Commands • company_name -- displayorg, modifyorg Org Management • Add an org Fields -- Related Commands • • orgname -- addorg Delete an org Fields -- Related Commands • • orgname -- deleteorg Edit/Move an org Fields -- Related Commands • • orgname
Fields -- Related Commands • im_enable -- modifyorg, org_im_settings modify, displayorg, org_im_settings display Fields -- Related Commands • im_external_enable -- displayorg, org_im_settings display Fields -- Related Commands • custom_journal -- org_im_settings modify, org_im_settings display Fields -- Related Commands • • standard_journal -- org_im_settings modify, org_im_settings display Protocols on/off Fields -- Related Commands • • im_proto_enable -- displayorg, org_im_settings display Rece
Message Limits Fields (for Orgs) Inbound • Attachment Size Fields -- Related Commands • • max_message_size -- displayorg, modifyorg Msg.
Notifications Fields (for Orgs) Notifications • On/Off Fields -- Related Commands • disable_first_spam -- displayorg, modifyorg • welcome_on -- displayorg, modifyorg Outbound Compliance Footer Compliance • Compliance footer’s related organization Fields -- Related Commands • • iid -- adddomain, deleteorg, displayorg, modifyorg, setorgsubstripping, im display, listdomains, listorgs, listusers On/Off Fields -- Related Commands • footer_on -- displayorg, modifyorg Quarantine Summary Notification •
Reports, Spam Fields Inbound • Name Fields -- Related Commands • • account -- getorgreport Quarantined messages from Blocked Senders list Fields -- Related Commands • • bad_isp -- getorgreport Quarantined senders from Blocked Senders list Fields -- Related Commands • • bad_sender -- getorgreport Total Blatant Spam Blocked messages Fields -- Related Commands • • ssb -- getorgreport Total Get Rich messages Fields -- Related Commands • • mmf -- getorgreport Total junk in quarantine Fields -- Re
Fields -- Related Commands • • naughty -- getorgreport Total spam in quarantine in bytes Fields -- Related Commands • • bytes -- getorgreport Total special offers Fields -- Related Commands • commerce -- getorgreport Reports, Traffic Fields Inbound • Forward Acct.
Fields -- Related Commands • • num_messages -- getorgreport Total of mail going to accounts Fields -- Related Commands • • acc_messages -- getorgreport • num_bh_messages -- getorgreport Total msgs in bytes Fields -- Related Commands • • num_bytes -- getorgreport Total quarantined Fields -- Related Commands • • num_q_messages -- getorgreport • pct_q_messages -- getorgreport Total quarantined in bytes Fields -- Related Commands • pct_q_bytes -- getorgreport Reports, Usage Fields Inbound •
Fields -- Related Commands • • sellerid -- getorgreport Total messages Fields -- Related Commands • • messages -- getorgreport Total users Fields -- Related Commands • • users -- getorgreport Usage amount in bytes Fields -- Related Commands • stored_size -- getorgreport Reports, Virus Fields Inbound • Name Fields -- Related Commands • • account -- getorgreport Total failed viruses cleanings Fields -- Related Commands • • clean_failures -- getorgreport Total quarantined Fields -- Related Com
Fields -- Related Commands • bytes -- getorgreport Sender List Fields (for Orgs) Approved Senders • Addresses, domains Fields -- Related Commands • approved_senders (for orgs) -- displayorg, modifyorg Blocked Senders • Addresses, domains Fields -- Related Commands • • blocked_senders (for orgs) -- displayorg, modifyorg Total blocked ISPs Fields -- Related Commands • • bad_isp -- getorgreport Total blocked senders Fields -- Related Commands • bad_sender -- getorgreport Sender Lists Fields (for
Blocked • Addresses, domains Fields -- Related Commands • blocked_senders (for users) -- adduser, modifyuser, displayuser Spam Filtering Fields (for Orgs) Inbound • Disposition Fields -- Related Commands • • blatant_spam -- displayorg, modifyorg On/Off header tags Fields -- Related Commands • • tagonly_spam -- displayorg, modifyorg On/Off quarantine notify Fields -- Related Commands • • spam_notify_on -- displayorg, modifyorg Redirect address Fields -- Related Commands • qtine_redir_spam -- di
Fields -- Related Commands • • filter_adult -- adduser, modifyuser, displayuser • filter_bulk -- adduser, modifyuser, displayuser • filter_getrich -- adduser, modifyuser, displayuser • filter_offers -- adduser, modifyuser, displayuser • filter_racial -- adduser, modifyuser, displayuser On/Off Fields -- Related Commands • junkmail_filter -- adduser, modifyuser, displayuser System Testing Fields Testing • Firewall Fields -- Related Commands • • address -- testfirewall Latency Fields -- Relat
User, Access Fields (for Orgs) Message Center • On/Off Fields -- Related Commands • • quarantine_links -- displayorg, modifyorg • quarsum_links -- displayorg, modifyorg Language Fields -- Related Commands • • lang_locale (for orgs) -- displayorg, modifyorg Time Fields -- Related Commands • timezone (for orgs) -- modifyorg Unrecognized addresses • On/Off Fields -- Related Commands • • async_bounce -- displayorg, modifyorg • blatant_spam -- modifyorg • non_account_bounce -- displayorg, mod
Fields -- Related Commands • • lang_locale (for orgs) -- displayorg, modifyorg NDR Fields -- Related Commands • • ndr -- displayorg, modifyorg • nullsender_disposition -- addorg, displayorg, modifyorg • nullsender_headertag_validation -- displayorg, modifyorg On/Off Fields -- Related Commands • qsum_enable -- displayorg, modifyorg User, General Setting Fields General User Setings • Creation method Fields -- Related Commands • • create_method (for users) -- displayuser Modify date Fields -- R
Fields -- Related Commands • • address -- adduser, modifyuser, displayuser (For more cmds, see address page) Name, ID Fields -- Related Commands • orgid -- adduser, modifyuser, displayuser Message Center • Yes/No Fields -- Related Commands • active -- displayuser • weblocked -- adduser, modifyuser, displayuser Message Encryption • External on/off match Fields -- Related Commands • message_encrypt (for users) -- adduser, modifyuser, displayuser Passwords • First password, set by system Fields --
Fields -- Related Commands • TS1 -- listprovusers Time/Language • Creation timestamp Fields -- Related Commands • • created_ts (for users) -- listdomains, im display Quarantine Summary language Fields -- Related Commands • • lang_locale (for users) -- adduser, modifyuser, displayuser Timezone for Message Center II & Message Center Classic (for scheduling wireless forwarding timezone only) Fields -- Related Commands • timezone (for users) -- adduser, modifyuser, displayuser User management • Add
Fields -- Related Commands • • address -- suspenduser User alais Fields -- Related Commands • address -- addalias, deletealias, displayuser, listusers Wireless Forwarding • On/Off/Unavailable Fields -- Related Commands • wireless_state -- addalias, deletealias, displayuser Virus Blocking Fields (for Orgs) Inbound • Disposition Fields -- Related Commands • • disposition_virus -- displayorg, modifyorg Message fragments Fields -- Related Commands • • bounce_fragments -- displayorg, modifyorg Non-
Fields -- Related Commands • • virus_clean -- displayorg, modifyorg Redirect address Fields -- Related Commands • • qtine_redir_virus -- displayorg, modifyorg Sensitivity Fields -- Related Commands • antivirus_sensitivity -- displayorg, modifyorg Outbound • Disposition Fields -- Related Commands • • outbound_virus_disposition -- displayorg, modifyorg On/Off Fields -- Related Commands • outbound_virus -- displayorg, modifyorg Virus Blocking Fields (for Users) Inbound • Frequency of notification
Chapter 5 Batch Commands Chapter 5 About Batch Commands The batch commands let you automate the management of large organizational configurations. These commands can add, delete, display, list, modify, test, and report on your organization configurations.
See “Batch Command and Field Quick Summary” on page 27 for an overall syntax summary, and see “Batch Command Quick Summary” on page 91 for more information.
addalias The addalias command associates an additional address with a user’s primary email address. The alias receives the same filtering and shares the same User Ouarantine as the user’s primary email address. This command is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Syntax addalias , , [confirm] Example addalias msmith@jumboinc.com, mary@jumboinc.
If is an existing alias for another user, the alias will be transferred to the new . If is an existing user’s primary address: • The existing user’s primary address is deleted. This primary address name becomes an alias for the new user’s primary address. • Any associated aliases for the existing user will be deleted and will become aliases for the new user’s primary address. • The existing user’s messages will be transferred before creating the alias.
‘No arguments supplied’ ‘No domain record exists for targetalias. Please add the domain first and then add aliases.’ ‘Invalid address (reason) =>The targetAlias is not valid)’ ‘No user ‘username’.’ ‘You don’t have permission to add aliases to username.’ ‘Please don’t alias accounts to themselves.’ ‘Can’t alias username; in use as an admin.’ ‘targetalias cannot be assigned to username because targetalias already exists as a user which you are not authorized to delete.
listusers ALL, primaryqs=jim@jumboinc.com, targetOrg=100046262, childorgs=1, aliases=1 listusers =alias4mary@jumboinc.com, targetOrg=200046262, childorgs=1, aliases=1, fields=ADDRESS|PRIMARY_ADD • A deactivated user can be added as an alias to another user. In the instance of an alias creation, the deactivated user’s record is purged from the system. For more information about deactivated users, see “deleteuser” on page 164. • When using a batch file, comments begin with a ‘#’ hash symbol.
Example adddomain sales, domain=jumboinc.com adddomain “Jumbo’s Western Region”, domain=jumboinc.com Description Adds the domain record to the organization • -- The organization where you wish to add the domain. Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols. • -- The name of the domain being added.
Notes • Confirm the domain is already associated with an email config. If not, add the domain to the email config. • A domain must be added below its associated email config organization. • In addition when using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name.
Description Creates a new organization, , underneath the parent organization, . • -- The name of the sub organization being added. Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols. • parent -- The new organization’s parent.
Related Commands Batch Commands: deleteorg, displayorg, getorgreport, listorgs, modifyorg, org_im_settings display, org_im_settings modify, setorgsubstripping Related Fields • Input: orgname • Optional field input: approved_senders (for orgs), archive, async_bounce, at_notify_on, authentication_data, blatant_spam, blatant_spam, blocked_senders (for orgs), company_name, creator, default_user, disable_first_spam, disposition_virus, message_encryption (for orgs), footer_on, iid, im_enable, im_external_enab
Example Batch command interface examples: • Add a user, add to the user’s approved_senders list, and send out an immediate welcome notification: adduser jim@jumboinc.com, approved_senders=+hugeisp.com, welcome=1 • If the org is not included, the command adds the user to the organization associated with the user’s domain. This is the default behavior: adduser msmith@jumboinc.com • Adds a user to the Company Sales organization: adduser msmith@jumboinc.
adduser msmith@jumboinc.com changes to adduser%20msmith%40jumboinc.com WARNING: Do not add a distribution list or a mailing list as a user account unless you have included these lists in your contracted user count. Doing so may cause you to incur additional costs. Consider adding the lists as aliases to an existing user account designed for this purpose. Errors • Possible batch command errors include: ‘No such user ‘username’ (unknown administrator address supplied).’ ‘String authorization failed.
‘Created new user msmith@jumboinc.com in organization Finance.’ • When used as an EZCommand, the HTTP response will contain a two-part return value: • status -- 1 for success or 0 for failure • message -- Contains errors and additional details Authorization • Read: Add Users • Write: Add Users Classification Batch user management; EZCommand-enabled Notes • The user’s email account must be set up on your email server.
Related: active, address, approved_senders (for users), approved_recipients, blocked_senders (for users), message_encrypt (for users), message_encrypt (for users), filter_adult, filter_bulk, filter_getrich, filter_offers, filter_racial, initial_password, junkmail_filter, lang_locale (for users), message_count, message_limit, message_limited, notice_address, orgid, password, timezone (for users), timezone (for users), user_id, virus_notify (for users), virus_state, weblocked, welcome_count, wireless_state S
If your archive feature is not enabled, this error message is returned: archive_settings display error: select * from archive_configs where iid=; no rows selected Note: In the Administration Console’s go to the Archive settings page for your organization to configure this organization’s archive functionality.
Related Fields • Input: orgname • Related: archive, archive_enable, custom_journal, retention_months, standard_journal See Also “Building a Batch File” on page 19 “Editing Message Archiving Settings” on page 564 Postini Message Archiving Administration Guide archive_settings modify The archive_settings modify command edits the archive settings for an organization.This command applies to Postini Message Archiving, which is only used with Message Security installations.
Description Archive settings can only be made on a user org (not account or email config orgs). • org -- The name of the organization associated with this archive. Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols. In addition when using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name.
Related Fields • Input: orgname • Related: archive, archive_enable, custom_journal, retention_months, standard_journal See Also “Building a Batch File” on page 19 “Editing Message Archiving Settings” on page 564 Postini Message Archiving Administration Guide blockprovuser The blockprovuser command sets a provisional user as permanently blocked from being added to the Message Security service. This occurs when using the SmartCreate user management feature.
Classification Batch user management Notes • Do this for users you don’t want to provide Message Security for, or for a user who has left your company but continues to receive email. • Used with SmartCreate, newly added users are unconfirmed provisional users. These users are promoted to regular user after verified as associated with someone in your org by receiving 3 legitimate emails within a week. Or the user can be blocked or unblocked from being added to the Message Security service.
Syntax checklatency , mailhost= Example checklatency sales email config, mailhost=my.mailserver.com Description Measures the time to open the SMTP connection with the target email server, . • = Name of the email config containing the mailhost Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols.
Notes • Use the Latency Test if you want to see how well the network is responding. The test results are relative and must be compared to normal test results when your system is experiencing similar traffic. As a rule, the lower the latency the better. But increased network latency alone is not a sign of email trouble in the Message Security service. • Use the checkroute command, Traceroute Test, to narrow the possible cause of slow latency.
Example checkroute salesemailconfig, mailhost=mailserver.jumboinc.com Description Traces the connection from the server to the input mail server, . A common traceroute test traces the network hops between the Message Security service and your server. • -- Name of the email config containing the mailhost Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols.
Notes • When a firewall blocks a traceroute test, this may take a few minutes. • Some service providers prevent traceroutes. • Traceroute tests to your email server are only helpful when paired with the traceroute results from your email server to the Message Security service. • In addition when using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name.
Description Batch Interface Description for deletealias Deletes the alias address, . • -- The user alias being deleted. Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols. EZCommand Description for deletealias See the Batch Interface Description for deletealias for general usage details. When used as an EZCommand, the command must be URL-escaped in order to properly submitted.
Return Values • Batch command interface return values: • If the helpdesk@jumboinc.com user alias was deleted, this string is returned: ‘ Deleted alias helpdesk@jumboinc.com from user msmith@jumboinc.com.
The Message Security Administration Guide, “Users and Quarantines” deletedomain The deletedomain command removes the domain from your organizational hierarchy. This command is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Syntax deletedomain Example deletedomain jumboinc.com Description Deletes the domain record, , from the Message Security service. • -- The domain being deleted.
Notes • Remove all users in this domain before removing the domain. • Edit the domain’s DNS MX entries to the Message Security service. • To move a domain, see the modifydomain command.
Description Deletes the organization identified by the . • -- The organization being deleted. Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols. Errors If you have tried to delete an organization with existing user records, you will get this error message: has users which must be deleted before it can be.
Related Commands Batch Commands: addorg, displayorg, getorgreport, listorgs, modifyorg, org_im_settings display, org_im_settings modify, setorgsubstripping Related Fields Input: orgname, iid See Also “Building a Batch File” on page 19 The Message Security Administration Guide, “Organization Management” deleteprovuser The deleteprovuser command removes a provisional user that is known to be illegitimate. It won’t appear on your bill.
Authorization • Read: Delete Users • Write: Delete Users Classification Batch user management Notes • Used with SmartCreate, newly added users are unconfirmed provisional users. These users are promoted to a regular user after verified as associated with someone in your org by receiving 3 legitimate emails with a week. Once this criteria is met, the user is added to service. Otherwise the user is deleted. • In addition when using a batch file, comments begin with a ‘#’ hash symbol.
Syntax deleteuser [ , deactivate] [ , purge] [ , confirm ] Example deleteuser msmith@jumboinc.com If the user being deleted is an administrator, use confirm: deleteuser admin@jumboinc.com, confirm Description Batch Interface Description for deleteuser Deletes a user record, from the Message Security service. • -- The name of the user being deleted.
Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols. • deactivate -- The user record is deactivated until the day after the user’s quarantine period has expired. At this point, the user record is purged from the system. • To purge a deactivated user, the user must first be added to the system using the command “adduser” on page 144, and then purged from the system.
‘No such user ‘username’ (unknown administrator address supplied).’ ‘String authorization failed.’ ‘No commands to process.’ ‘Command not recognized: command.’ ‘You don’t have permission to insert users into org name.’ ‘No such organization ‘org name’.’ ‘No default user available for organization org name.’ ‘No secret key in database’.’ Note: This means “no secret key” found in the organization’s EZCommand Shared Secret.
Notes • When using the batch commandline interface, remove an administrator’s record before removing the administrator’s user record. See the confirm parameter above. • If removing a Default User, first remove the user from all associated organizations. • In addition when using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name.
Description Displays the domain settings for the -- The domain being displayed. Return Values For Batch command interface, these values are returned: • If the hugeisp.com domain is associated with the sales organization, substripping is off, and hugeisp.com is a domain alias for the jumboinc.com domain, these comma delimited field-value strings are returned: org sales, substrip 0, aliasedto jumboinc.com, domainid 900000811 domainname hugeisip.com • If the jumboinc.
Related Fields • Input: domainid, domainname • Output: alias, aliasedfrom, aliasedto, org (orgname), substrip • Related: domainid, domainname, iid, primary_did See Also “Building a Batch File” on page 19 “Message Center Settings and Password Examples” on page 536 The Message Security Administration Guide, “Domains” displayorg The displayorg command displays all the selected organization’s settings information.
antivirus_sensitivity 0 (normal), approved_senders empty, archive 1 (on), async_bounce NULL (), at_notify_on NULL (), authentication_data NULL, authentication_type 1 (PMP), autocreate_web 0 (off), blatant_spam ERROR 571 Message Refused, blocked_senders empty, bounce_fragments NULL (), company_name Jumbo Inc, creator 200122328 (msmith@jumboinc.com), create_method 2, created_date 1145975006 default_message_limit NULL, default_user 200122277 (pdefault@jumboinc.
virus_clean 1 (on), virus_notify 0 (Immediately), welcome_on 1 (on) zero_hour_notify_on 0 (off) zero_hour_scan 0 (off) Authorization • Read: Organization Management • Write: Organization Management Classification Batch organization management Notes • Child organization settings are not displayed. • In addition when using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name.
parent_org, qsum_actionable, qsum_enable, qtine_redir_atq, qtine_redir_ndr, qtine_redir_out_atq, qtine_redir_out_virus, qtine_redir_spam, qtine_redir_virus, quarantine_links, quarsum_links, remotecmd_secret, spam_notify_on, support_contact, tagonly_spam, timezone (for orgs), tls_notify_admin, tls_notify_on, virus_clean, virus_notify (for orgs), welcome_on See Also “Building a Batch File” on page 19 “Message Center Settings and Password Examples” on page 536 “Resetting Users” on page 553 “Viewing Your Organ
Description Displays a provisional user address and the last time an email was received. The time is in UNIX seconds. Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols Return Values Using the Administration Console syntax: ProvUser: john@jumboinc.com Org: 100048729 TS1: 1141420639 TS3: 1141429660 The numbers following the return values are time stamps.
Related Fields • Input: address • Output: iid, TS1, TS3 See Also “Building a Batch File” on page 19 “Editing Your Mail Handling Policies (Non Account Bounce)” on page 562 The Message Security Administration Guide, “Users and Quarantines” displayspool The displayspool command shows the Spool Manager settings for your email config organization. This command is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols. Errors • When there is a failed connection during the spool delay period, mail is deferred with the SMTP error 451 Can’t connect to yourdomain.com psmtp. According to SMTP protocol, mail will defer for 56 days before bouncing back to the sender.
Notes • If within one minute three connection attempts to your mail server fail, Spool Manager starts the spool delay period which is 15 minutes by default. • During the spool delay period, Spool Manager will begin to spool your mail. If there’s a successful connection during this period, the Spool Manager returns to monitoring connections to your mail server. The spooling will continue until the spool is full, until you suspend the spooling, or until spooling automatically unspools.
displayuser The displayuser command shows all the user’s settings information. Syntax displayuser Example displayuser msmith@jumboinc.com Description Displays information on user settings either by the . • -- The user whose settings are being displayed.
timezone NULL, user_id 202846402, virus_notify NULL (), virus_state 0 (on), weblocked 0 (no), welcome_count 1, wireless_state 1 (off) Authorization • Read: User Settings • Write: User Settings Classification Batch user management Notes In addition when using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name.
“Message Center Settings and Password Examples” on page 536 “Viewing Your Organization’s Sender Lists” on page 554 “Viewing Message Center Settings” on page 536 “Viewing Authentication and Password Settings” on page 540 “Editing a PMP Password” on page 541 “Seeing if a User Has Received a Welcome Notification” on page 547 “Resending the Welcome Notification” on page 548 The Message Security Administration Guide, “Users and Quarantines” domain_tls add The domain_tls add command adds Postini Policy-Enforced
Description Adds Policy-Enforced TLS for orgs that need to identify domains that need inbound or outbound message traffic (ib_sender or ob_recipient) to be sent via a Transport Layer Security (TLS) connection. This command is run at the email config-level.
Related Commands Batch Commands: domain_tls delete, domain_tls display, domain_tls modify Related Fields message_encryption (for orgs) See Also “Building a Batch File” on page 19 Postini Encryption Services Administration Guide, “Policy Enforced TLS” domain_tls delete The domain_tls delete command deletes the organization’s Policy-Enforced TLS settings which identify domain names that require inbound and outbound message traffic to be sent via a TLS connection.
Description Deletes an organization’s Policy-Enforced TLS settings. This command is run at the email config-level. • orgtag -- Org name or ID of an existing email config organization enabled for Policy-Enforced TLS • hop -- Conversation segment between the Message Security service and a recipient or sender • • ib_sender -- Inbound sender to the Message Security service • ob_recipient -- Outbound message traffic from the Message Security service to the recipient.
Related Commands Batch Commands: domain_tls add, domain_tls display, domain_tls modify Related Fields message_encryption (for orgs) See Also “Building a Batch File” on page 19 Postini Encryption Services Administration Guide, “Policy Enforced TLS” domain_tls display The domain_tls display command displays Policy-Enforced TLS settings for organizations which need to identify domain names that require inbound and outbound message traffic to be sent via a TLS connection.
Description Displays an organization’s Transport Layer Security (TLS) settings. This command is run at the email config-level. • orgtag -- Org name or ID of an existing email config organization enabled for Policy-Enforced TLS • hop -- Conversation segment between the Message Security service and a recipient or sender • • ib_sender -- Inbound sender to the Message Security service • ob_recipient -- Outbound message traffic from the Message Security service to the recipient.
Authorization • Read: Organization Management, Inbound Transport Security if using inbound or Outbound Transport Security if using outbound.
Example domain_tls modify org=Salesemailconfig, hop=ib_sender, domain=_default, cert_validation=verify Description Edits Policy-Enforced TLS for organizations. This command is run at the email config-level.
Related Commands Batch Commands: domain_tls add, domain_tls delete, domain_tls display Related Fields Input: orgname, domainname See Also “Building a Batch File” on page 19 Postini Encryption Services Administration Guide, “Policy Enforced TLS” encryption display_org The encryption display_org command displays an organization’s encryption information. This command applies to Postini Message Encryption, which is only used with Message Security installations.
ext_encrypt route_id out_tls_source_flags out_tls_recipient_flags in_tls_flags Authorization • Read: Message Encryption Management, Outbound Message Encryption • Write: Message Encryption Management, Outbound Message Encryption Classification Batch organization management Notes The ext_encrypt_criteria and ext_encrypt are the message_encryption (for orgs), message_encryption_criteria fields. In addition when using a batch file, comments begin with a ‘#’ hash symbol.
encryption display_user The encryption display_user command displays user specific encryption information. This command applies to Postini Message Encryption, which is only used with Message Security installations. This command is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Syntax encryption display_user, address= Example encryption display_user, address=msmith@jumboinc.
Notes • The ext_encrypt_criteria and ext_encrypt are the message_encryption (for orgs), message_encryption_criteria fields. • In addition when using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name.
Description Lists all encryption users in this organization. Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols Return Values Returns the user address which has the message encryption fields set. The user’s organization, user address, ext_encrypt setting, and the ext_encrypt_criteria setting are returned.
See Also “Building a Batch File” on page 19 Postini Encryption Services Administration Guide encryption modify_org The encryption modify_org command modifies external encryption settings for an organization. This command applies to Postini Message Encryption, an optional product. This command is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Description Modifies the encryption settings for an organization. • -- The organization being modified. Note: Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols. • ‘service=on’ -- Encryption is enabled • ‘service=off’ -- Encryption is disabled • ‘service=match -- System looks in the message header for string. If the string is found, the message is encrypted.
Billing only applies to organization and individual user external encryption settings. Content Manager encryption rules are not included. • For best practice, we recommend using the encryption modify_org command rather than the modifyorg command used with the message_encryption (for orgs) field. The encryption commands are more efficient. The encryption family of commands offer additional encryption features within each command call.
Example encryption modify_user, address=msmith@jumboinc.com, service=on Description Modifies the encryption settings for a user. • ‘service=on’ -- Encryption is enabled • ‘service=off’ -- Encryption is disabled • ‘service=match -- System looks in the message header for string. If the string is found, the message is encrypted. The default is sensitivity: company-confidential. • ‘service=default’ -- Sets the message encryption behavior to match the user’s organization message encryption setting.
Billing only applies to organization and individual user external encryption settings. Content Manager encryption rules are not included. • For best practice, we recommend using the encryption modify_user command rather than the modifyuser command used with the message_encrypt (for users) field. The encryption commands are more efficient. The encryption family of commands offer additional encryption features within each command call.
getorgreport sales, report=spam_summary, date=20060331 getorgreport sales, report=usage_summary, date=20060331 getorgreport sales, report=spam_summary, date=20060331, top=10 Description Build a report of type for organization, for a given day, . This is done at the account org level. • -- The organization referred to by the reports.
Errors • If using the Administration Console, verify the organization exists. Or verify the command punctuation (‘,’) is correct: • “No report matches ''. • “Report currently unavailable” • Verify you are using the correct date syntax for this report type, and you have included the parameter ‘date=’: • “Please enter a date in format: YYYYMMDD.” • Check your mail server’s mail flow: • “The org test does not have usage data rolled up. Please try an account level org.
inf_deliveries 0, num_viruses 6 Spam Spam Report returns these comma delimited fields for each user’s report in the list. account Jumbo Inc, bad_isp 0, bad_sender 0, bulk 28, bytes 123320, commerce 4, deliveries 45, mmf 11, naughty 2, num_spams 45, racial 0, ssb 0 Usage Usage Report returns these comma delimited fields for each customer’s report in the list.
Notes • In addition when using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name. • Confirm you have the correct Account-level access privileges before using this command. The getorgreport summaries in the Administration Console Batch Results page return the report fields in easy to read labels. Below are the report field names followed by the Batch page field labels.
racial -- Racially Insensitive deliveries -- Deliverd from Quarantine bulk -- Bulk Mail Usage Usage report fields -- Batch page field labels customerid -- customerid customername -- customer name messages -- values productid -- productid sellerid -- sellerid stored_size -- values users -- values (can be users, stored_size, messages) Related Commands Batch Commands: addorg, deleteorg, displayorg, listorgs, modifyorg, org_im_settings display, org_im_settings modify, setorgsubstripping Related Fields • Inp
Syntax help Example help displayorg Description Displays syntax, example, and quick tips for a command. Errors Always test your command syntax before using the command in a final production configuration. Some help command output may include arguments that you do not have access to, depending upon your administrative authority level. Using these arguments can return errors if you do not have authority to call these arguments.
iplock add_range The iplock add_range command allows emails from specific domains with specific IP addresses to be delivered to an organization and its sub-organizations. This command is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
If junk email messages are reaching your users because the sender is falsifying a domain name in your Approved Senders list, and if this spoofed domain is vital to your business and cannot be removed from the approved senders list, use this batch command to set up an IP lock on this domain. Note: To create these IP locks you can create a batch file which should be maintained and kept up to date with all valid IP's for the allowed domain.
For more information about CIDR notation, see RFC 1518, 1519, and 4632 at the Internet Engineering Task Force (IETF) RFC page. In addition, the Internet has several Subnet calculators which are useful determining your Subnet Block. For a good selection, search either for Subnet calculator or CIDR calculator. Note: This command does not support the subnet mask notation. WARNING: Before applying this command: • If you already have a list of locked domains, copy them out prior to making any changes.
Command: iplock add_range org=_email_config , domain=jumboinc.com, range=64.18.0.0/16 Returns: Added jumboinc.com as allowed for 64.18.0.0/16 iplock display command returns: jumboinc.com -> 64.18.0.0/16 Authorization • Read: Junk Email Settings • Write: Junk Email Settings Classification Batch organization IP management Notes • With the iplock set of commands, you: • Apply a domain’s IP lock at an email config organization level. • Add a single domain or IP range.
See Also “Building a Batch File” on page 19 The Message Security Administration Guide, “IP Ranges and Security”, and “Avoid Spoofing” iplock delete The iplock delete command removes all domains with IP limitations configured in the specified email configuration organization. This command is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
WARNING: The is necessary for the command to be processed, however, all entries of this domain are deleted. Any sub-org’s domains are deleted when parent org IP settings change. Peer organizations or organizations higher in the hierarchy are not overwritten.
iplock delete_range The iplock delete_range command removes either one IP limitation or all IP limitations for one domain configured in the specified email config organization. This command is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Syntax iplock delete_range org=, domain=, range=< | all> Example If the domain has multiple IP limitations (63.18.0.0/16, 64.18.0.
Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols. • -- The name of the sender’s domain whose messages are locked to this organization. This domain can be the message’s envelope MAIL FROM address or the message’s header From: address. • [CIDR subnet]-- The NetBlock with the IP address and the optional subnet.
Notes • The iplock delete_range command clears the one or all IP locks for a specfic domain. The iplock delete_range command deletes all IP locks for all domains associated with an email config organization. • If an email config organization is converted to a simple organization, the IP locks for any domain associated with the email config is deleted. The information is not retained. • In addition when using a batch file, comments begin with a ‘#’ hash symbol.
Example iplock display org=sales_email_config Description The iplock display batch command lists all domain and associated IP addresses locked to an organization. • -- The name of the email config organization where this configuration will be configured. Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols. Return Values Domain has two locked IP addresses jumboinc.com -> 64.
Notes • If an email config organization is converted to a user organization, the IP locks for any domain associated with the email config is deleted. The information is not retained. • In addition when using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name.
Example The default behavior is to reject with a 550 error any message that does not match the IP range: iplock set_disposition org=sales_email_config, domain=jumboinc.com, disposition=reject Description Sets the response behavior for any messages that do not match the IP lock range for . • -- The name of the email config organization where this configuration is configured. These configurations affect the email config organization and all sub-orgs.
Notes • The iplock set_disposition command is not available in this version. The default behavior is to ‘reject’ a message that does not match a locked IP range for a specific domain. • In addition when using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name.
Example • Batch command interface examples: • List all domains starting with the sales org, and sort the results by org name in ASCII ascending order: listdomains ALL, targetOrg=sales, childorgs=1, sort=ORGTAG:a It is important to set the targetOrg value if your authorization is limited to the targetOrg or below. Otherwise the system will return an authorization error.
qstring The qstring rules are: • If the target text starts with ‘=’, the result must be an exact match. For example, =jumboinc.com returns exact matches. • If the target text starts with ‘%’, the result can be a substring match. For example, %jumbo returns all domain names containing jumbo. • If the target text ends with ‘$’, the result ends with this match. For example, .com$ returns all domain names ending in .com.
aliases The aliases parameter values are: ‘aliases=0’ -- Do not include domain aliases in the search results. ‘aliases=1’ -- Include domain aliases Default: aliases=1 childorgs Use this parameter if you need to list sub organizations. This is especially true when using the targetOrg option. 0/No -- Do not include sub organizations in the search results 1/Yes -- Include sub organizations Default: childorgs=1 sort Pairs of sortable fields and sort order separated by either a ‘ : ’ or ‘ | ’.
fields The fields parameter is a list of field data displayed in the search results. These are separated by ‘ | ‘. • All of the sortable fields can be used. See the sort parameter option. domain_id start The start parameter is the starting index of the paginated sorted results returned in the search. Default: start=0 end The end parameter is the ending index of the paginated sorted results returned in the search.
Authorization • Read: Edit Organizations • Write: Edit Organizations Note: The qstring filtering requires at least one All Standard Privileges authorization. Classification Batch domain management Notes • In addition when using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name. • Note spelling of the ‘orgtagqs’ parameter.
Syntax listorgs [ , targetOrg= ] [ , childorgs=<0/No | 1/Yes> ] [ , sort= ] [ , fields= ] [ , start= ] [ , end= ] Example Batch command interface examples: • To list all orgs under the sales organization, and sort these by the org’s ID in numeric descending order: listorgs ALL, targetOrg=sales, sort=IID:nd • To list all orgs that contain ‘POP’ in the organization’s name: listorgs %POP, targetOrg=sales • To list all organizatio
orgtag qstring The ‘orgtag qstring’ is the organization you are searching for. This is the target text matched to the search results using the qstring rules explained below. qstring The qstring parameter values are: • If the target text starts with ‘=’, the result must be an exact match. For example, =sales returns exact matches. • If the target text starts with ‘%’, the result can be a substring match. For example, %POP returns all organization names containing POP.
Sortable fields include: • ORGTAG • IID Sort order include: • a = ASCII ascending • d = ASCII descending • na = numeric ascending • nd = numeric descending Default: sort=IID:na fields List of field data to display in search results. These are separated by ‘ | ’. • All of the sortable fields can be used. See the sort parameter option.
Return values using Administration Console syntax: 100001011 sales 1 of a total of 1 matching records found. • Return values are dependent upon the command’s parameter options. For example, using listorgs ALL, targetOrg=Sales, childorgs=1, fields=lang_locale will return only the Sales organization’s and sub organization’s localized language values. (shown in the Administration Console syntax): es.iso-8859-1 ja_jp.iso-2022-jp en_us.iso-8859-1 fr.utf8 de.utf8 en_us.
Related Commands Batch Commands: addorg, deleteorg, displayorg, getorgreport, modifyorg, org_im_settings display, org_im_settings modify, setorgsubstripping Related Fields • Input: archive, at_notify_on, bounce_fragments, creator, default_user, disable_first_spam, footer_on, iid, im_enable, im_external_enable, im_proto_enable, lang_locale (for orgs), non_account_virus_scan, orgname, orgtag, out_at_notify_on, spam_notify_on, support_contact, timezone (for orgs), virus_clean, welcome_on • Output: archive,
Example listprovusers My Company, subset=ALL, sort=TS1:d, fields=ADDRESS|TS1|TS3 Description Displays information about a set of provisional users, filtering and sorting as requested. • -- The organization associated with the provisional users. Note: Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols.
The match specifications include: • If the target text starts with ‘=’, the result must be an exact match. For example, =msmith@jumboinc.com returns exact matches. • If the target text starts with ‘%’, the result can be a substring match. For example, %smith returns all provisional user address containing smith. • If the target text ends with ‘$’, the result ends with this match. For example, .com$ returns all provisional user addresses ending in .com.
fields The fields parameter is a list of fields to display in results, separated by ‘ | ’. Note: This is limited to sortable fields. See the sort option. Default: fields=ADDRESS|TS1 start The start parameter is the starting index of the pagination for sorted result pairs returned in the search. Default: start=0 end The end parameter is the ending index of the pagination sorted result set returned in the search. end=last Return Values If the Sales organization had one provisional user, joe@jumboinc.
Notes • If your account has the SmartCreate feature enabled, users in your domains whose address ends in @yourdomain, will be added automatically to the Message Security service as unconfirmed provisional users. These users are promoted to regular users after being verified as associated with someone in your org by receiving 3 legitimate emails with a week. Once this criteria is met, the user is added to the service. Otherwise the user is deleted and you are not billed for it.
[, sort=] [, fields=] [, start=] [, end=] [, type_of_user=] Example • To list all of the aliases for a single user, use the example below. The return values are a comma separated list of aliases for jim@jumboinc.com: listusers ALL, primaryqs=jim@jumboinc.com, targetOrg=100046262, childorgs=1, aliases=1 • To list all primary user addresses and associated aliases in an org hierarchy, use the example below.
address qstring An address qstring parameter is the partial or full user’s email address. This is the target text to match with the search results using the qstring rules explained below. qstring The qstring includes: • If target text starts with ‘=’, the result must be an exact match. For example, =msmith@jumboinc.com returns exact matches. • If the target text starts with ‘%’, the result can be a substring match. For example, %smith returns all users’ addresses containing smith.
aliases The aliases parameter includes: • aliases=0 -- Don’t include user aliases in the search results. • aliases=1 -- Include user aliases childorgs Use this parameter if you need to list sub organizations. This is especially true when using the targetOrg option.
To list all users starting with the Sales organization, and including whether the user is active, how the user was created and the date of creation: listusers ALL, targetOrg=Sales, childorgs=1, fields=active|create_method|created_ts Default: fields=ADDRESS|ORGTAG start The start parameter is the starting index of the paginated sorted result pairs to return in the search. Default: start=0 end The end parameter is the ending index of the paginated sorted result pairs to return in the search.
msmith@jumboinc.com sales 1 of a total of 1 matching records found. • Return values are dependent upon the command’s parameter options. For example, using listusers ALL, targetOrg=Sales, childorgs=1, fields=IID will return only the org ID values for all users in the Sales organization and sub organizations. (shown in the Administration Console syntax): 100046267 100052426 100045290 3 of a total of 3 matching records found.
Related Fields • Input: active, address, create_method (for users), created_ts (for users), orgname, orgtag, primary_add, timezone (for users), u_id • Output: active, address, create_method (for users), created_ts (for users), orgname, orgtag, primary_add, timezone (for users), u_id See Also “Building a Batch File” on page 19 “Message Center Settings and Password Examples” on page 536 “Viewing Your Organization’s Sender Lists” on page 554 “Resetting Users” on page 553 “Listing User Aliases and Primary A
modifydomain jumboinc.com, alias=jumboalias.com • To delete jumboalias.com domain alias and add another: modifydomain jumboinc.com, alias=’-jumboalias.com, jumbo.com’ • To turn subdomain substripping on, delete an alias, and add a new domain alias: modifydomain jumboinc.com, substrip=1, alias=”-jumbo.com, jumboalias.com” Note the double quotes for the comma delimited alias values. • To set catch@jumboinc.com as the domain’s catchall mailbox: modifydomain jumboinc.com, catchall=catch@jumboinc.
‘Moved domain western.sales.jumboinc.com from Sales to WestCoastSales.’ Authorization • Read: Edit Organizations • Write: Edit Organizations Classification Batch domain management Notes When using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name.
Example modifyorg sales, support_contact=user_support@jumboinc.com, max_message_size=250 modifyorg sales, im_enable=on Description Modifies an organization record. • -- The organization being modified. Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols. • = -- Any org-level field that you have privileges to edit.
Whenever the shared secret is changed in the scripts, it should also be changed in the authentication_data field for the org which contains the users being authenticated. • If an email config organization is converted to a simple organization, the IP locks for any domain associated with the email config is deleted. The information is not retained. To display an email config organization’s IP locks for a domain, see the iplock display command.
“Viewing Message Center Settings” on page 536 “Viewing and Editing Message Encryption Settings” on page 565 “Setting a Virus Notification Interval” on page 549 The Message Security Administration Guide, “Organization Management” modifyuser The modifyuser command modifies a user’s settings. Syntax modifyuser [, =, ...] Example modifyuser msmith@jumboinc.com modifyuser msmith@jumboinc.com, junkmail_filter=0 modifyuser msmith@jumboinc.
EZCommand Description for modifyuser See the Batch Interface Description for modifyuser for general usage details. • When used as an EZCommand, the command must be URL-escaped in order to properly submitted. Example: modifyuser msmith@jumboinc.com, junkmail_filter=0 changes to modifyuser%20msmith%40jumboinc.com%20junkmail_filter=0 Errors • Possible error messages include: ‘No such user ‘username’ (unknown administrator address supplied).’ ‘String authorization failed.’ ‘No commands to process.
‘Modified msmith@jumboinc.com: Set filter_getrich to moderate. Set filter_adult to 13.’ • When used as an EZCommand, the HTTP response will contain a two-part return value: • status -- 1 for success or 0 for failure • message -- Contains errors and additional details Authorization • Read: User Settings • Write: User Settings Classification Batch user management; EZCommand-enabled Notes • Avoid updating a Default User.
Related Fields Input: active, address, approved_senders (for users), approved_recipients, blocked_senders (for users), message_encrypt (for users), filter_adult, filter_bulk, filter_getrich, filter_offers, filter_racial, filter_racial, initial_password, junkmail_filter, lang_locale (for users), message_count, message_limit, message_limited, notice_address, orgid, password, timezone (for users), timezone (for users), user_id, virus_notify (for users), virus_state, weblocked, welcome_count, wireless_state Se
Description Displays an organization’s notification attributes depending on the notification type Notification type descriptions: • all -- Only used for displaying. Will display all notification settings for the target organization. • attachment_manager_inbound -- Notification sent when an attachment arrives on inbound mail. This is only used with Message Security installations. • attachment_manager_outbound -- Notification sent when an attachment is sent on outbound mail.
notification display type=all attachment_manager_inbound notification settings: state=off text=default attachment_manager_outbound notification settings: state=off text=default early_detection_quarantine notification settings: state=off text=default first_spam notification settings: cc=none state=on text=default password_reset notification settings: text=default quarantine_summary notification settings: delivery_hour=9 pm inbox_delivery=on state=on subject_links=on text=default spam notification settings: c
notification display type=early_detection_quarantine state=off text=default notification display type=first_spam cc=none state=on text=default notification display type=password_reset text=default notification display type=quarantine_summary delivery_hour=9 pm inbox_delivery=on state=on subject_links=on text=default notification display type=spam cc=none frequency=Daily state=on text=default notification display type=suspension text=default notification display type=virus cc=none state=Immediately tex
Authorization • Read: Notification Messages, Edit Organizations (as a general rule) • Write: Notification Messages, Edit Organizations (as a general rule) Note: The authorizations are dependent upon the type of notification.
notification modify type=password_reset, org= [ , text=link: | unlink | default ] notification modify type=quarantine_summary, org= [ , state= ] | [ , inbox_delivery= ] | [ , delivery_hour=<4 thru 21 which is an hour between 4 a.m. and 9 p.
Notification type descriptions: • • • attachment_manager_inbound -- Notification sent when an attachment arrives on inbound mail. This is only used with Message Security installations. • state=< user | quarantine redirect | both | off> -- Sends attachment manager notifications directly to the user, the quarantine redirect address, both the user and the redirect, or off. This is optional.
Note: If an organization does not have the notification’s feature, an “Invalid notification type.” error is returned. • • • first_spam -- Notification sent when the first spam message gets quarantined in a new user’s Message Center • state=< on/1 | off/0> -- An on/off switch for first spam notifications. This is optional.
unlinking shared notifications, the designated org keeps a copy of the notification, but it can not be updated by the other sharing org. This is optional. • • cc=< user address > -- The address of the user who will be cc’ed when the notication is sent. This address must be a valid user under the same email config. This is optional. • frequency=< 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 > -- Number of days between spam notification updates. For frequency=1, this means daily notification updates.
Authorization • Read: Notification Messages, Edit Organizations (as a general rule) • Write: Notification Messages, Edit Organizations (as a general rule) Note: The authorizations are dependent upon the type of notification.
Description Displays an im settings record for a given org: • orgtag -- Name of the organization whose IM settings are being displayed. Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols. Errors Possible errors include: “You don’t have Instant Messenger feature.” “Please enter an orgtag” “You have entered an invalid organization or one that you do not have permission over.
Related Commands Batch Commands: iplock add_range, im display, im list, im listforuser, listusers, modifyorg, user_im_settings add, user_im_settings delete, user_im_settings display, user_im_settings modify, org_im_settings modify Related Fields • Input: orgname, orgtag • Output: custom_journal, file_transfer_receive, file_transfer_send, standard_journal, archive, im_enable, im_external_enable, im_proto_enable See Also “Building a Batch File” on page 19 “Editing Message Archiving Settings” on page 564
Description Modifies an the organization im settings record for a given orgtag: • orgtag -- The organization name Enclose or in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols. • disposition -- The setting for the organization’s IM archiving strategy. • disposition_email -- The IM user’s email address Errors Possible errors include: “You don’t have Instant Messanger feature.
Notes • The file transfer controls affect Yahoo!, AIM, and MSN. At this time, Google Talk transfers are blocked by default. • In addition when using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name.
Example • To force an individual user to change a password: password force_update user=msmith@jumboinc.com • To force all users in an organization to change their passwords: password force_update org=Sales • To force all users in an organization to change their passwords and include all users in sub-organizations: password force_update org=Sales, cascade=yes Description Forces either a user or all users in an organization to change passwords. These can not be done at the same time.
Notes When using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name. Related Commands Batch Commands: password reset, password_policy display, password_policy update Related Fields Input: address, orgname See Also “Building a Batch File” on page 19 The Message Security Administration Guide, “User Authentication” password reset The password reset command resets a user’s password.
password reset user=msmith@jumboinc.com, password=a8f2KTT*#, notify=yes Description Resets a PMP user’s password. • If a user and a clear text password are specified, this password is set following the user’s organizational PMP password policies. If the password does not match the password policies, it is rejected and the user tries again. • If a user is specified without a specific password, a randomly derived password will be generated using the organization’s password policies.
Related Fields Input: address See Also “Building a Batch File” on page 19 The Message Security Administration Guide, “User Authentication” password_policy display The password_policy display command displays the password policy for an organization. This command is used with an organization using the PMP password policy configuration. This command is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
This org does not have the appropriate feature authorization. If you have the wrong authorization privileges: You do not have the proper authorization to perform password_policy display. Return Values In the Administration Console, this information is returned for the Sales organization.
Related Commands Batch Commands: password force_update, password reset, password_policy update Related Fields Input: orgname See Also “Building a Batch File” on page 19 The Message Security Administration Guide, “User Authentication” password_policy update The password_policy update command creates a password policy for a new organization or updates the password policy for an existing organization. This command is used with an organization using the PMP password policy configuration.
Example • The basic setting recommendation is for min_length=6 and required_complexity=yes. The remaining parameters should match your company’s password policy.
Description Updates the password policy for an existing organization, including suborganizations if cascade is enabled. If a PMP password policy configuration does not exist for this organization, one is created with the default settings. • -- The email config organization being updated. • min_length -- The minimum number of characters in the password. The values can range from 1 to 10.
Default: max_password_age=null • ‘cascade=no’ -- Sub organization passwords will not be updated with new changes. • ‘cascade=yes’ -- Sub organization passwords will be updated. Use caution with this option. This will propagate the updates to all sub organizations regardless of individual users requirements. Note: Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols.
Related Commands Batch Commands: password force_update, password reset, password_policy display Related Fields Input: orgname See Also “Building a Batch File” on page 19 The Message Security Administration Guide, “User Authentication” promoteprovuser The promoteprovuser command adds a provisional user to the Message Security service and removes the provisional user record. This command is used with SmartCreate.
Authorization • Read: Add Users • Write: Add Users Classification Batch user management Notes • Used with SmartCreate, newly added users are unconfirmed provisional users and are promoted to a regular user after verified as associated with someone in your org by receiving 3 legitimate emails with a week. Once this criteria is met, the user is added to service. Otherwise the user is deleted. • In addition when using a batch file, comments begin with a ‘#’ hash symbol.
Syntax resetuser Example resetuser msmith@jumboinc.com Description Resets most user fields for to the settings of the default user for the organization is in. This will clear most customizations made since the user was created. Below are the fields that do not change when a user is reset. Note: Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols.
Related Commands Batch Commands: modifyuser, suspenduser Related Fields Input: address See Also “Building a Batch File” on page 19 “Resetting Users” on page 553 The Message Security Administration Guide, “Users and Quarantines” setorgsubstripping The setorgsubstripping command enables domain substripping for all domains in an organization. This command is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Errors “Please supply a valid sub-stripping value (0 or 1)” -- Do not use ‘on’ or ‘off’ with this command. Return Values If the sales organization domain substripping was enabled, the command would return: Set sub-strip state of sales to 1. Authorization • Read: Edit Organizations • Write: Edit Organization Classification Batch domain management Notes • Org Substripping enables subdomain stripping for all domains in a particular organization. For example, the jumboinc.
Related Fields • Input: orgname, iid • Related: substrip See Also “Building a Batch File” on page 19 The Message Security Administration Guide, “Domains” showallowedips The showallowedips command lists all allowed sending domains and associated IPs configured in an organization. This command is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Note: The iplock display command has replaced the showallowedips command.
Return Values No Locked Domain:IP addresses No ip / domain mappings present. Locked Domain:IP addresses domain.com -> 64.19.7.234/16 Authorization • Read: Application Management, Junk Email Settings • Write: Read-only for administrators Classification Batch IP management Notes In addition when using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name.
suspenduser The suspenduser command suspends a user by disabling all filtering and the user’s access to the Message Center. Syntax suspenduser [ , notify] [ , hardSuspend] [ , deliver] Example suspenduser msmith@jumboinc.com, hardSuspend suspenduser msmith@jumboinc.com, notify, hardSuspend, deliver suspenduser msmith@jumboinc.com Description Batch Interface Description for suspenduser Suspends . All filtering is turned off/on.
This is a positional parameter and is optional. If used, the parameter must be at the end of the command. There is no numeric equivalent. EZCommand Description for suspenduser See the Batch Interface Description for suspenduser for general usage details. When used as an EZCommand, the command must be URL-escaped in order to properly submitted. For example: suspenduser msmith@jumboinc.com, notify changes to suspenduser%20msmith%40jumboinc.
status -- 1 for success or 0 for failure message -- Contains errors and additional details Authorization Write: Help Desk Classification Batch user management; EZCommand-enabled Notes • Fully suspended users (users suspended using the batch command suspenduser msmith@jumboinc.com, hardsuspend) are not counted as accounts in the billing statements. • To unsuspend users in the core batch environment, use the resetuser command. See the Task Example, “Resetting Users” on page 553, for more information.
testfirewall The testfirewall command tests whether your firewall allows email traffic from IP addresses outside of the Message Security service IP range. This command is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Syntax testfirewall Example testfirewall jumbomailserver@jumboinc.com Description Determines if connections to the mail server are not blocked by the firewall.
Classification Batch test management Notes • Malicious senders may attempt to send traffic directly to port 25 on your server, and bypass filtering and security. We recommend you configure your email server or firewall to accept traffic only from the Message Security service. • When using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name.
Syntax testmail , mailtype=<1 | 0> Example testmail msmith@jumboinc.com, mailtype=1 Description Sends a test email to the input email address. . The test generates an actual message. You should use an email address that is an account on your email server and is registered with the Message Security service. • -- Address of the user to be used as the message recipient.
HELO failed. • SMTP Connection failed -- See The Message Security Administration Guide, “Troubleshooting Incoming Email Delivery” for full steps. • HELO failed -- This usually indicates an issue with your mail server. Look at your mail server logs for the exact SMTP error it returned. This information will help you resolve this issue. • MAIL FROM failed -- This indicates that your mail server will not accept the sender or timed out during this phase of the test.
Sending RECPT TO Sending data End of data dot Success The email data center can deliver email to this email server. In all 3 cases the recipient, msmith@jumboinc.com, will receive a test email message. Authorization • Read: User Settings • Write: Read-only for administrators Classification Batch test management Notes In addition when using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name.
Syntax testmx Example testmx mailserver.jumboinc.com Description Checks the mail exchange record of the input domain, . • = Name of the domain whose DNS MX entries you wish to test Errors Test Fails • If the MX Record test fails for the selected domain, emails may not be filtered or even bounce. You will see the results of the test followed by the relevant parts of your DNS MX entries as seen by the DNS servers used by the Message Security service.
or Multiple MX records found containing ‘sNbM.psmtp.com’ -- Remove the duplicate entry listed. • Unable to resolve ‘jumboinc.com’ -- Create a DNS MX entries for the domain on the authority DNS server. Currently no entries can be found. This may be a symptom of trouble with your authority DNS server. • Non-psmtp MX record found: ‘jumboinc.
Related Fields Input: domainname See Also “Building a Batch File” on page 19 The Message Security Administration Guide, “Test Tools & Mail Flow Troubleshooting” unblockprovuser The unblockprovuser command unblocks provisional users who have been blocked from becoming regular users. Provisional users are created with SmartCreate. This command is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Classification Batch user management Notes • Used with SmartCreate, newly added users are unconfirmed provisional users. These users are promoted to regular user after verified as associated with someone in your org by receiving 3 legitimate emails within a week. Or the user can be blocked or unblocked from being added to the Message Security service. Once the email criteria is met, the user is added to service. Otherwise the user is deleted.
Syntax user_im_settings add address=, external_enable=, proto_enable=< + | - >all | aim | msn | yahoo | google> Example user_im_settings add address=msmith@jumboinc.com, external_enable=on, proto_enable=+all Description Adds an user im settings record for a given user address. • address -- Address of user email Note: Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols.
Authorization • Read: IM Management • Write: IM Management Classification Batch IM user management Notes In addition when using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name.
Example user_im_settings delete address=msmith@jumboinc.com Description Deletes an user im settings record for a given user address. • address -- Email address of the user. Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols. Errors Possible errors include: “You don’t have Instant Messenger feature.” “Please enter the address to delete the user im settings record.
Related Commands Batch Commands: iplock add_range, im delete, im display, im list, im listforuser, listusers, modifyorg, user_im_settings add, user_im_settings display, user_im_settings modify, org_im_settings display, org_im_settings modify Related Fields Input: address See Also “Building a Batch File” on page 19 user_im_settings display The user_im_settings display command displays IM settings for a given user email address. Postini IM Security is an optional product.
Errors Possible errors include: “You don’t have Instant Messenger feature.” “Please enter the address to display the user im settings record.” “Cannot find the user with address” “You don’t have permission to perform this command.” “No Such User.
Related Fields • Input: address • Output: address, file_transfer_receive, file_transfer_send, im_external_enable, im_proto_enable, u_id See Also “Building a Batch File” on page 19 user_im_settings modify The user_im_settings modify command modifies IM settings for a given user email address. Postini IM Security is an optional product. This command is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Note: Enclose in double quotes or preceded with a ‘\’ symbol if it contains a quote (‘), double quote (“), backslash (\), apostrophe, commas, #, = symbols. • external_enabled=on -- Enables IM users to communicate outside of your organization • external_enabled=off -- Disables IM communication outside of your organization • proto_enabled -- Either adds or removes a protocol • file_transfer_receive -- Enables receiving IM file transfers internally within the organization or to everyone.
Notes • New IM record values are inherited from the user’s org im settings. • In addition when using a batch file, comments begin with a ‘#’ hash symbol. If not on a separate line, the hash symbol could be interpreted as part of a user or organization name.
Chapter 6 Batch Organization Fields Chapter 6 About Batch Organization Fields The batch organization fields hold org-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.
The reference pages use the Administration Console syntax and have an example for each field: • The field name is required. In the Administration Console, commas are required. • Information between ‘< >’ symbols means you need to add your specific information here. (for example: = becomes approved_senders=+mary@hugeisp.com) • Information between ‘[ ]’ square brackets mean this type of information is optional. • A choice of values are separated by ‘|’.
modifyorg sales, antivirus_sensitivity=16 Description Flag indicating whether virus cleaning is allowed for this organization. • normal /0/NULL-- Virus sensitivity is at the normal strength for this organization. The normal strength value can be the string normal, 0, or NULL. We recommend using the string normal since it is easier to read. This is the default. • aggressive/16 -- Virus sensitivity is at the aggressive strength for this organization.
approved_senders (for orgs) The approved_senders field holds an email address or domain to be added or removed from the organization-level Approved Senders list. Syntax approved_senders=< [+ ] | -email address>, ... | < [+] | -domain name>,...| Examples • When field is returned as output: approved_senders jim@hugeisp.com • Adding a sender to the org’s Approved Senders list, either is correct: modifyorg sales, approved_senders=+jim@hugeisp.com modifyorg sales, approved_senders=jim@hugeisp.
Field Type Org-level Authorization • Read: Junk Email • Write: Junk Email Notes • Mail from senders on this list will bypass the Junk Email filters. • Entries apply to all users in the organization, but are not visible to the organization’s users allowing the administrator to customize the lists between organizations. • If virus blocking is enabled for the recipient, message will not be delivered even though on the Approved Senders list.
See Also “Viewing Your Organization’s Sender Lists” on page 554 “Adding Users and Domains to Sender Lists” on page 555 “Viewing Message Center Settings” on page 536 The Message Security Administration Guide, “Approved and Blocked Sender Lists” archive The archive field lists whether archiving is on or off for an organization. This field applies to Postini Message Archiving, which is only used with Message Security installations.
Authorization • Read: Edit organizations • Write: Edit organizations Notes The archive field is the same value as the archive_enable field which is used by the archive_settings commands.
archive_enable NULL • To change the setting: archive_settings modify org=Jumbo ABC, archive_enable=on, mail_flow=on, journaling=on Description Lists archiving state • on -- Archiving is on for this organization. • off -- Archiving is off for this organization. • NULL -- This field is not active. Default: off Field Type Org-level Authorization • Read: Edit organizations • Write: Edit organizations Notes • When archiving is enabled, mail_flow and journaling must be on.
See Also Editing Message Archiving Settings Postini Message Archiving Administration Guide async_bounce The async_bounce field lists whether the Connection Manager’s Asynchronous Bouncing control is activated for inbound traffic. This control is for email servers that issue “unknown user” bounce messages asynchronously and require added security. This field is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Authorization • Read: Auto Connection Manager • Write: Auto Connection Manager Notes When activating this service, it is important to keep your user list up to date to avoid Directory Harvest Attacks (DHA) false positives.
modifyorg sales, at_notify_on=1 Description Notification sent to recipient of Inbound Attachment Manager notifications: • 0 (Off ) -- Notification is turned off for the org • 1 (Send to Redirect) - If your spam filters are configured to deliver all user spam to a single administrator’s quarantine, the notification is sent to this administrator. This is also known as a redirect to the Attachment Manager Quarantine Redirect address.
See Also The Message Security Administration Guide, “Quarantine Summary & Notifications” authentication_data The authentication_data field holds the text used for non-PMP authentication of users and administrators when logging into the Message Center or Administration Console. This field is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Description String holding the text that is used to validate users in a non-PMP authenticated organization which are either POP or XAuth. To enable XAuth, a request must be submitted through a support ticket. • XAuth Authentication -- Example of Syntax: authentication_data= • When used with an EZCommand solution, the authstring is URL escaped. See “EZCommand Reference” on page 24.
Notes POP authentication is the only authentication method compatible with the blatant_spam field.
Description Defines the type of authentication used by an organization: • 1 = Privately Managed Passwords, (PMP) • 4 = POP Authentication, (POP) • 5 = SHA1 Cross-Authentication, (XAuth) Note: To change your authentication type, please contact your support representative. Field Type Org-level Authorization • Read: Edit Organizations • Write: Read-only for administrators Notes This field is useful with the authentication_data field.
autocreate_web The autocreate_web field determines whether users can be automtically created when the organization is using POP authentication. This is the Web Autocreate feature. After an organization’s Authentication Method is set to POP and the Authentication Data is configured, an administrator can either enable user autocreation or not. For this autocreation method, a user is added automatically to the Message Security service when first logging in to the Message Center.
Notes • Applies only if the organization has associated domains. • Web Autocreate works only for orgs that use POP Authentication. • Web Autocreate does not work if the org is an email server config. • Users are added to the organization associated with the domain. • After enabling, send a message to users requesting that they log in to the Message Center to activate their own spam filtering account.
Description Turns OFF, deletes , or bounces the most obvious spam before it reaches the email servers: • OFF or NULL-- Turns this feature off for the org • blackhole -- Deletes obvious spam without sending a return error • ERROR 571 Message Refused -- Bounces obvious spam back to the sender with the error message Field Type Org-level Authorization • Read -- Junk Email • Write -- Junk Email Notes • Messages from approved senders or containing approved conten
blocked_senders (for orgs) The blocked_senders field lists an email address or a domain to be added or removed from the organization-level Blocked Senders list. All messages from these senders or domains will be quarantined. Syntax blocked_senders=< [+] | -emailaddress> | < [+] | -domain name | empty>,...
Authorization • Read: Junk Email • Write: Junk Email Notes • Entries apply to all users in the organization, but are not visible to the organization’s users allowing the administrator to customize the lists between organizations. • At the organization-level, the Blocked Senders list overrides the Approved Senders list. At the user-level, the Approved Senders list overrides the Blocked Senders list. The user-level Approved Senders list overrides the organization-level Blocked Senders list.
“Adding Users and Domains to Sender Lists” on page 555 “Viewing Message Center Settings” on page 536 The Message Security Administration Guide, “Approved and Blocked Sender Lists” bounce_fragments The bounce_fragments field enables partial message fragments to be recieved or bounced.
Related Commands • Output: displayorg • Input: addorg, modifyorg See Also The Message Security Administration Guide, “Organization Management” company_name The company_name field holds the company or entity name that is used in email notifications. Syntax company_name= Examples • When the field is returned as output: company_name “Jumbo Inc” • To modify the company name: modifyorg sales, company_name=Jumbo Inc Description Company or entity name that is used in the email notifications.
Related Commands • Output: displayorg • Input: modifyorg See Also “Viewing Authentication and Password Settings” on page 540 “Seeing if a User Has Received a Welcome Notification” on page 547 The Message Security Administration Guide, “Organization Management” create_method (for orgs) The create_method field shows how an organization was created.
Notes • This field only applies to deployments of Perimeter Manager Enterprise Edition, Release 5.0 and later. This includes Message Security for Enterprises. • Organizations created during a Directory Sync synchronization are created by the addorg command, and the organizations’ create_method field value is 3. Directory Sync is an optional feature.
Field Type Org-level Authorization • Read: Edit Organizations • Write: Read-only for administrators. Notes This field only applies to deployments of Perimeter Manager Enterprise Edition, Release 5.0 and later.
creator 202781130 (msmith@jumboinc.com) Description The creator field lists the user ID and address of the administrator who created the organization. • NULL (none) -- This field is not active.
Examples • When the field is returned as output: custom_journal on • To change the setting: org_im_settings modify orgtag=sales, disposition=”archive,cuztom_journal” Description On and Off switch for IM conversations sent to IM administrator’s email. • on -- Enables IM conversations to be sent to admin’s email address • off -- Disables IM conversations to be sent to admin’s email address • Enclose a disposition list in double quotes if it contains commas.
Related Commands • Input: org_im_settings modify • Output: org_im_settings display Related Fields archive, standard_journal See Also “Editing Message Archiving Settings” on page 564 Postini Message Archiving Administration Guide default_message_limit The default_message_limit field holds the maximum number of messages each registered user or alias in an organization can receive per day.
Field Type Org-level Authorization • Read: Traffic Limits • Write: Traffic Limits Notes • When exceeded, incoming messages are bounced, returning a 554 Mailbox limit exceeded error message to the sender. • Setting a message limit is useful for protecting mail servers against malicious attacks. • All messages are counted against this limit, including legitimate and quarantined messages. • The count is approximate, so it’s suggested only for values over 100.
default_user The default_user field lists the name of the organization’s Default User template used when creating a new user in this org. Syntax default_user= | postinidefault@ | @ Examples • When assigning the field: modifyorg sales, pdefault@jumboinc.com • When the field is returned as output (using Administration Console syntax): default_user 200122277 (pdefault@jumboinc.
Notes • Every org containing users must have a Default User. • You can create additional Default Users, give them unique settings, and assign them to separate orgs. New users in these orgs get the unique settings.
Description Switch for first spam notification. • 1/off -- The first spam notification will be sent to users in this organization. This is the default setting. • 0/on-- The first spam notification will not be sent to users in this organization. • NULL () -- This field is not active.
disposition_virus The disposition_virus field holds the disposition status of an email containing a virus. The disposition can be either redirected, deleted, quarantined, or tagged as a virus in the message email headers.
Notes When a virus is detected, the Message Security service inserts the X-pstnvirus header to show what virus was caught. The format of the header when a virus is detected by McAfee is: X-pstnvirus: McAfee_Virus_Name For further details on one of these viruses, you can search for McAfee_Virus_Name at the McAfee Virus Information Library site: http://vil.nai.
Related Fields antivirus_sensitivity, non_account_virus_scan, timezone (for orgs), virus_clean, virus_notify (for orgs) See Also “Viewing Your Organization’s Sender Lists” on page 554 “Adding Users and Domains to Sender Lists” on page 555 The Message Security Administration Guide, “Virus Blocking” file_transfer_receive The file_transfer_receive field enables receiving IM file transfers internally within the organization or to everyone. This field applies to Postini IM Security, an optional product.
Description • Enables IM file transfers internally and externally. The file transfer controls affect Yahoo!, AIM, and MSN.
Syntax file_transfer_send=< off | internal_only | include_external > Examples • When the field is returned as output: file_transfer_send off • When modifying an organization’s IM record: org_im_settings modify orgtag=sales, file_transfer_send=internal_only Description • Enables sending IM file transfers internally and externally. The file transfer controls affect Yahoo!, AIM, and MSN.
Related Fields file_transfer_receive See Also footer_on The footer_on field holds the activation status for an organization-level outbound Compliance Footer which describes an email policy or legal compliance. This is only used with Message Security installations. Syntax footer_on= Examples • When assigning the field: modifyorg sales, footer_on=on • When the field is returned as output: footer_on 0 (off) Description Switch for outbound compliance footer.
Related Commands • Output: displayorg • Input: modifyorg See Also The Message Security Administration Guide, “Configuring Outbound Servers” iid The iid field lists the unique sequential database assigned key for this organization. Syntax iid= Examples When the field is returned as output: iid 100050344 Description Sequential database assigned key.
Notes An organization can be referenced by several different fields: • orgname -- The organization’s string name • orgtag -- The organization’s string name in the database • iid -- The organization’s unique sequential database assigned key • orgid -- The user-level foreign key for the organization’s iid field. • org -- In both the domain and spool context, this is the associated organization to the domain or to the spooling event.
im_enable 1 (on) • To change the setting: modifyorg= sales, im_enable=on Description Enables IM Security: • off -- Disables IM usage for an organization. • on -- IM management is enabled. • NULL () -- This field is not active. Note: The numeric equivalents to ‘on’ and ‘off’ are useful for debugging purposes. For robust production code, use the text value, ‘on’ or ‘off’.
im_external_enable The im_external_enable field is an organization-level IM Security switch which enables IM users to communicate with external users. Postini IM Security is an optional product. This field is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Authorization • Read: IM Management • Write: IM Management Notes External messages are any IM communication with user’s outside of the accountlevel organization.
Examples • When the field is returned as output: im_proto_enable +all, +msn, +aim, +yahoo, +google • Adding a protocol and removing another: modifyorg sales, im_proto_enable=+yahoo,-AIM • Adding all protocols to the im_proto_enable field via the proto_enable parameter: user_im_settings add address=msmith@jumboinc.com, external_enable=on, proto_enable=+all Description Specifies what IM protocols are allowed: • + -- Adds the protocol to the list.
Related Commands • Input: user_im_settings add, user_im_settings modify • Output: displayorg, org_im_settings display,user_im_settings display Related Fields im_enable, im_external_enable See Also “Editing Message Archiving Settings” on page 564 is_email_config The is_email_config field states whether a configuration is the email config organization or not. This field is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Notes If an email config organization which has blocked IP ranges for a domain is converted to a user organization, the blocked IP ranges are deleted. The information is not kept. To see an email config organization’s IP locks, see the iplock display command.
Examples archive_settings modify org=Jumbo ABC, archive_enable=on, mail_flow=on, journaling=on Description Enables archiving of journaled messages: • on -- Journaling is enabled • off -- Journaling is not enabled Note: The archive_enable field must be enabled for mail_flow and journaling to be modified.
lang_locale (for orgs) The lang_locale field enables organization-level language localization in the Quarantine Summary’s static text, the default top text, character sets, and date format. Syntax lang_locale= Examples • When the field is returned as output, example as empty: lang_locale NULL • English (U.S.) UTF-8 with date format: Quarantine Summary 9/14/2006 5:00 P.M. modifyorg sales, lang_locale=en_us.
Related Commands • Output: displayorg • Input: modifyorg See Also “Viewing Message Center Settings” on page 536 “Editing Quarantine Summary Notifications” on page 546 The Message Security Administration Guide, “Quarantine Summary & Notifications” lastmod_date (for orgs) The lastmod_date field holds the date the organization was last modified.
Authorization • Read: Edit Organization • Write: Read-only for administrators Related Commands Output: displayorg See Also The Message Security Administration Guide, “Organization Management” mail_flow The mail_flow field turns on or off the inbound and outbound archiving. This field applies to Postini Message Archiving, which is only used with Message Security installations.
Field Type Org-level Authorization • Read: Edit organizations • Write: Edit organizations Related Commands • Input: archive_settings modify • Output: archive_settings display Related Fields archive, archive_enable, journaling, retention_months See Also “Editing Message Archiving Settings” on page 564 Postini Message Archiving Administration Guide max_message_size The max_message_size field holds the organization-level maximum size of inbound attachments-per-message that users can receive.
modifyorg sales, max_message_size=250 Description Maximum size of inbound messages in megabytes, allowed for this organization. • NULL (200M) -- This field is not active. Default: max_message_size=200 M • When an attached message exceeds this limit it is bounced. And a SMTP error 552 Message too large - psmtp message is returned to the sender.
See Also “Viewing Message Center Settings” on page 536 “Viewing Message Center Settings” on page 536 The Message Security Administration Guide, “Organization Management” message_encryption (for orgs) The message_encryption field enables outbound organization-level messages to be encrypted and sent to a secure portal. This field applies to Postini Message Encryption, which is only used with Message Security installations.
Field Type Org-level Authorization • Read: Outbound Message Encryption • Write: Outbound Message Encryption Notes Entries apply to all users in the organization Related Commands • Output: displayorg • Input: modifyorg • Related: displayuser (Output), domain_tls add, domain_tls delete, domain_tls display, encryption display_org Related Fields message_encrypt (for users), message_encryption_criteria See Also “Viewing and Editing Message Encryption Settings” on page 565 Postini Encryption Services
Syntax message_encryption_criteria= | NULL Examples • When the field is returned as output: message_encryption_criteria Encrypt this message • To change the setting: modifyorg sales, message_encryption_criteria=This message is encrypted Description Holds a header string used to identify outbound messages that need to be encrypted. • -- Message text. • NULL -- This field is not active.
See Also “Viewing and Editing Message Encryption Settings” on page 565 Postini Encryption Services Administration Guide, “How Connection Security Works” ndr The ndr field holds outbound mail configuration (block or blackhole) for undeliverable bounce messages generated by the organization’s mail server. This is the control for Undeliverable Bounce Message handling. This is only used with Message Security installations.
Field Type Org-level Authorization • Read: Outbound Server Management • Write: Outbound Server Management Notes Some mail servers silently discard these messages when they are not deliverable. Others, such as Microsoft Exchange and qmail, accept all mail traffic and then create a new outgoing mail message in the event there is no recipient account. If the sending address is forged or unavailable, undeliverable bounce messages may become caught in your system.
Syntax non_account_bounce= Examples • When the field is returned as output: non_account_bounce 1 (on) • To change the setting: modifyorg sales, non_account_bounce=on Description Mail is bounced if the recipient is not found in the database. The SMTP error message 550 No such user - psmtp is returned to the sender. • on -- Mail is bounced if not addressed to a registered user or alias. • off -- This feature is not available. • NULL -- This field is not active.
Notes • By activating this feature, the Message Security service will compare directory information with incoming recipients to measure erroneous delivery attempts. When activating this service, it is imperative that you keep your directory up to date. • This setting is used for organizations that contain domains. Non-Account Bouncing applies to all domains in an organization. • Non-Account Bouncing takes precedence over non_account_virus_scan.
Description Enables an inbound message for unregistered users to be filtered for viruses. There is no notification associated with this disposition: • on -- Deletes virus-infected messages sent to unregistered users, before they reach your mail server. This takes priority over disposition_virus. Default: non_account_virus_scan=on for accounts created in version 6.7 and above. • off -- Message sent to unregistered users are not scanned for viruses.
Related Commands • Output: displayorg • Input: addorg, modifyorg Related Fields disposition_virus, non_account_bounce See Also “Viewing Authentication and Password Settings” on page 540 “Seeing if a User Has Received a Welcome Notification” on page 547 The Message Security Administration Guide, “Virus Blocking” nullsender_disposition The nullsender_disposition field holds a Non-Delivery Report/Receipt (NDR) message disposition, allowing organizations to filter inbound valid and spam NDRs.
Description This field holds the disposition for a valid or spam NDR inbound message based on the null sender address in the envelope’s FROM field.The NDR filter does not block NDRs with a sender address. An example of a valid NDR message is, after sending mail to someone’s who is out of the office, your mail server receives an auto-reply vacation report.
Notes • The nullsender_disposition field’s value takes precedence over Approved/ Blocked Senders, Content Manager or Attachment Manager rules. The NDR filter runs before the junk filters. Virus blocking processes NDR messages as usual. • The nullsender_disposition field’s quarantined and blocked totals appear in the Traffic reports by domain and by recipient. • When initially using this field, set the disposition to quarantine.
Syntax nullsender_headertag_validation=< 1 - 336 | 0 | NULL > Examples When the field is given as input: modifyorg Sales, nullsender_headertag_validation=120 When field is returned as output: nullsender_headertag_validation 120 Description When valid messages are sent out, digital signatures are added to the message’s Received Header. The nullsender_headertag_validation field holds the number of hours this digital signature is valid if the sent message is returned with a NDR or bounce message.
Related Commands • Input: modifyorg • Output: displayorg Related Fields • ndr (for Message Security product only), nullsender_disposition See Also The Message Security Administration Guide, “Content Manager” orgname The orgname field lists the name of the current organization.
Description A unique name used to reference an organization within the Administration Console: • Enclose the organization’s name in double quotes if it contains an apostrophe or commas. The unique identifying number (iid) of the organization can sometimes be substituted for orgname. The IID is useful for debugging purposes. For robust production code, use the orgname field value.
Related Commands • Output: displayorg • Input: adddomain, addorg, adduser, archive_settings display, archive_settings modify, checklatency, checkroute, deleteorg, displayorg, displayspool, domain_tls add, domain_tls delete, domain_tls display, domain_tls modify, encryption display_org, encryption modify_org, getorgreport, iplock add_range, iplock delete, iplock delete_range, iplock display, iplock set_disposition, listdomains, listorgs, listprovusers, listusers, modifydomain, modifyorg, notification disp
Field Type Org-level Authorization • Read: Edit Organizations • Write: Edit Organizations Notes The batch interface allows apostrophes, commas, #, =, “ “, ‘ ‘ symbols in user or organization names. These must be either in double quotes or proceeded by a ‘\’ symbol.
Examples • The field as output of a command: out_at_notify_on 0 • To change the setting: modifyorg sales, out_at_notify_on=1 Description Notification sent to recipient of Outbound Attachment Manager notifications: • 0 (Off) -- Notification is turned off for this organization • 1 (Send to Redirect) -- If your spam filters are configured to deliver all user spam to a single administrator’s quarantine, the notification is sent to this administrator.
Related Fields at_notify_on (Inbound), max_message_size, outbound_max_message_size, qsum_actionable, qsum_enable, qtine_redir_atq, qtine_redir_out_atq, qtine_redir_ndr See Also “Viewing Authentication and Password Settings” on page 540 “Seeing if a User Has Received a Welcome Notification” on page 547 The Message Security Administration Guide, “Quarantine Summary and Notifications” outbound_max_message_size The outbound_max_message_size field holds the maximum size of attachmentsper-message that users in
Field Type Org-level Authorization • Read: Outbound Applications Management • Write: Outbound Applications Management Notes Messages that exceed this limit are bounced, returning a SMTP error 552 Message too large - psmtp message to the sender.
Examples • When returned from displayorg: outbound_virus 1 (on) • When assigned: modifyorg sales, outbound_virus=1 Description Switch for outbound virus scanning. • on -- Virus scanning is enabled for outbound messages • off -- This feature is not available for this organization Note: The numeric equivalents to ‘on’ and ‘off’ are useful for debugging purposes. For robust production code, use the text value, ‘on’ or ‘off’.
outbound_virus_disposition The outbound_virus_disposition field lists the disposition (bounce or redirect) of an outbound email containing a virus. This is only used with Message Security installations.
Related Commands • Output: displayorg • Input: modifyorg Related Fields disposition_virus, out_at_notify_on, outbound_virus See Also The Message Security Administration Guide, “Virus Blocking” parent_org The parent_org field lists the organization that is one level up in the org hierarchy.
Description A valid orgname: • Entering a new parent reassigns the current org to a new parent, moving it to a new location in the hierarchy. • The parent organization’s name can be the unique identifying number (IID) of the organization • Enclose in double quotes or preceded with a ‘\’ symbol if it contains an apostrophe or commas, #, =, “ “, ‘ ‘ symbols. Note: The parent_org, as an organization, has an associated iid value, a unique identifying organization number.
See Also The Message Security Administration Guide, “Organization Management” qsum_actionable The qsum_actionable field determines if Quarantine Summary links are available. Syntax qsum_actionable=<“not actionable” | “basic delivery”> Examples • When the field is returned as output: qsum_actionable not actionable • To change the setting: modifyorg sales, qsum_actionable=”not actionable” Description Lists whether links available in Quarantine Summary notifications.
Related Commands • Output: displayorg • Input: modifyorg Related Fields at_notify_on (Inbound), max_message_size, out_at_notify_on, outbound_max_message_size, qsum_enable, qtine_redir_atq, qtine_redir_out_atq, qtine_redir_ndr See Also “Viewing Message Center Settings” on page 536 “Editing Quarantine Summary Notifications” on page 546 The Message Security Administration Guide, “Quarantine Summary and Notifications” qsum_enable The qsum_enable field is a switch that sends the Quarantine Summary notifica
Description Switch for send quarantine summary notifications.
Syntax qtine_redir_atq=< valid user address | NULL (none) > Examples • When the field is returned as output, example as empty: qtine_redir_atq NULL (none) • To change the setting: modifyorg sales, qtine_redir_atq=msmith@jumboinc.com Description If your spam filters are configured to deliver all user spam to a single administrator’s quarantine, the notification is sent to this administrator . This is also known as a redirect to the Attachment Manager Quarantine Redirect address.
See Also The Message Security Administration Guide, “Quarantine Summary and Notifications” qtine_redir_ndr The qtine_redir_ndr field holds the user email address for the quarantined outbound Undeliverable Bounce Messages. When an outbound message is quarantined as an undeliverable Bounce message, the message is stored in this Message Center. This is only used with Message Security installations.
Related Commands • Output: displayorg • Input: modifyorg Related Fields at_notify_on (Inbound), max_message_size, out_at_notify_on, outbound_max_message_size, qsum_actionable, qsum_enable, qtine_redir_atq, qtine_redir_out_atq See Also “Viewing Message Center Settings” on page 536 “Editing Quarantine Summary Notifications” on page 546 The Message Security Administration Guide, “Quarantine Summary and Notifications” qtine_redir_out_atq The qtine_redir_out_atq field holds the user address for the Attachm
Field Type Org-level Authorization • Read: Outbound Applications Management • Write: Outbound Applications Management Related Commands • Input: modifyorg • Output: displayorg Related Fields at_notify_on (Inbound), max_message_size, out_at_notify_on, outbound_max_message_size, qsum_actionable, qsum_enable, qtine_redir_atq, qtine_redir_ndr See Also “Viewing Message Center Settings” on page 536 “Editing Quarantine Summary Notifications” on page 546 The Message Security Administration Guide, “Quaranti
Examples • When the field is returned as output: qtine_redir_out_virus support@jumboinc.com • To change the setting: modifyorg sales, qtine_redir_out_virus=support@jumboinc.com Description Outbound virus email for this organization is quarantined to this user. • NULL (none) -- This field is not active.
qtine_redir_spam The qtine_redir_spam field holds email address for the user receiving inbound spam email quarantine for an organization. When an outbound message is quarantined as spam, the message is stored in this Message Center. This is only used with Message Security installations. Syntax qtine_redir_spam= Examples • When the field is returned as output: qtine_redir_spam support@hugeisp.
See Also “Viewing Message Center Settings” on page 536 “Editing Quarantine Summary Notifications” on page 546 The Message Security Administration Guide, “Quarantine Summary and Notifications” qtine_redir_virus The qtine_redir_virus holds the email address for the user receiving inbound virus email quarantine for an organization. When an outbound message is quarantined as a virus, the message is stored in this Message Center. This is only used with Message Security installations.
Related Commands • Output: displayorg • Input: modifyorg See Also The Message Security Administration Guide, “Quarantine Summary and Notifications” quarantine_links The quarantine_links field is a switch to enable quarantine message links to be available in the Message Center.
Authorization • Read: Junk Email • Write: Junk Email Related Commands • Output: displayorg • Input: modifyorg Related Fields quarsum_links See Also “Editing Message Center Access and Settings” on page 538 “Viewing Authentication and Password Settings” on page 540 The Message Security Administration Guide, “Quarantine Summary and Notifications” quarsum_links The quarsum_links field is a switch enabling Quarantine Summary message links to be available.
Description Enable quarantine summary message link. • off -- Disables the Quarantine Summary links • on -- Enables the Quarantine Summary links • NULL () -- This field is not active. Note: The numeric equivalents to ‘on’ and ‘off’ are useful for debugging purposes. For robust production code, use the text value, ‘on’ or ‘off’.
remotecmd_secret The remotecmd_secret field holds the shared secret for digitally signing EZCommand URLs. This field is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Syntax remotecmd_secret= Examples • When the field is returned as output: remotecmd_secret swordfish • To change the setting: modifyorg sales, remotecmd_secret=swordfish Description Shared secret for digitally signing EZCommand URLs.
Related Fields authentication_data See Also The Message Security Administration Guide, “Batch Processing and EZCommands retention_months The retention_months field holds the number of months archived messages are retained for an organization. This field applies to Postini Message Archiving, which is only used with Message Security installations.
Authorization • Read: Edit organizations-Advanced Applications-Message Archiving • Write: Read-only for administrators Related Commands Output: archive_settings display Related Fields archive, mail_flow, journaling See Also Postini Message Archiving Administration Guide spam_notify_on The spam_notify_on field is a switch enabling the sending of spam quarantine notifications.
Description Sends spam quarantined notifications: • on -- Spam quarantine notifications can be sent • NULL ()-- This field is not active.
This field is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Notes An organization’s IM conversations are journaled by being sent as email to participants and/or text of the conversation is sent directly to the Message Archiving for storage: • Standard journaling -- IM conversation text is sent as an email message to all conversation participants who are in this user’s organization. This is equivalent to the ‘Standard Email’ feature in the Administration Console.
Examples • When the field is returned as output: support_contact support@hugeisp.com • To change the setting: modifyorg sales, support_contact=support@hugeisp.com Description Address of support contact for the organization: • Address must look like a real email address. This address does not have to be registered with the Message Security service. • Domain or user must be identified in the Message Security service system and removable to the same mailhost as this organization.
See Also “Viewing Authentication and Password Settings” on page 540 “Seeing if a User Has Received a Welcome Notification” on page 547 The Message Security Administration Guide, “Organization Management.” tagonly_spam The tagonly_spam field enables adding header tags to a spam email instead of forwarding the email to quarantine.
Authorization • Read: Junk Email • Write: Junk Email Related Commands • Output: displayorg • Input: modifyorg Related Fields blatant_spam, spam_notify_on See Also The Message Security Administration Guide, “Quarantine Summary and Notifications” timezone (for orgs) The timezone field holds the user’s timezone, a UNIX TZ string used in Message Center II.
Field Type Org-level Authorization • Read: Application Management, Account Settings, Regional Settings • Write: Application Management, Account Settings, Regional Settings Related Commands • Output: displayorg • Related: displayuser Related Fields timezone (for users) See Also The Message Security Administration Guide, “The Message Center” tls_notify_admin The tls_notify_admin field lists the administrator who receives the email config organization’s Policy Enforced TLS alerts.
modifyorg Sales tls_notify_admin = msmith@jumboinc.com • To enable a TLS alert: modifyorg Sales tls_notify_admin = msmith@jumboinc.com, tls_notify_on=600 Description Lists the email config organization’s administrator address which will receive the TLS alerts. The user receiving these alerts must be an administrator for the email config organization.
tls_notify_on The tls_notify_on field enables Policy-Enforced TLS alerts for an email config organization. It also acts as a throttle for the alert notifications by designating how much time elapses before additional notifications. This field applies to Postini Policy-Enforced TLS, which is only used with Message Security installations. This field is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Related Commands • Input: modifyorg • Output: displayorg Related Fields tls_notify_admin See Also Postini Encryption Services Administration Guide, “Policy Enforced TLS” virus_clean The virus_clean field is a flag indicating whether a virus cleaning is allowed for this organization.
Field Type Org-level Authorization • Read: Virus • Write: Virus Related Commands • Output: displayorg • Input: modifyorg Related Fields antivirus_sensitivity, disposition_virus, timezone (for orgs), virus_notify (for orgs) See Also “Viewing Your Organization’s Sender Lists” on page 554 “Adding Users and Domains to Sender Lists” on page 555 The Message Security Administration Guide, “Virus Blocking” virus_notify (for orgs) The virus_notify field specifies how frequently virus notification email wi
To change the setting: modifyorg JumboInc virus_notify=9 Description Lists how frequently virus notification email will be generated: • 0 -- Immediately • 1 -- No more than one notice per day • 9 -- Disable notifications for this organization • NULL () -- This field is not active. The default is the user-level virus_notify setting.
See Also “Viewing Authentication and Password Settings” on page 540 “Seeing if a User Has Received a Welcome Notification” on page 547 “Setting a Virus Notification Interval” on page 549 The Message Security Administration Guide, “Virus Blocking” welcome_on The welcome_on field allows the system to send out welcome notifications. It shows whether a message should receive a welcome message at some point within the next 24 hours.
Authorization • Read: Edit Organizations • Write: Edit Organizations Notes The adduser command’s welcome parameter enables the welcome message to be sent immediately.
Examples • When the field is returned as output: zero_hour_notify_on 1 (on) • To change the setting: modifyorg sales, zero_hour_notify_on=on Description • on -- Enables sending a message recipient when Early Detection Quarantine quarantines a message. This message is sent immediately. • off -- Disables sending a message when a message is quarantined by Early Detection Quarantine.
Related Fields “zero_hour_scan” on page 409 See Also zero_hour_scan The zero_hour_scan field enables or disables the Early Detection Quarantine feature. Syntax zero_hour_scan=< 1 | 0 > Examples • When the field is returned as output: zero_hour_scan 1 (on) • To change the setting: modifyorg sales, zero_hour_scan=1 Description • 1 -- Enables Early Detection Quarantine. • 0 -- Disables Early Detection Quarantine.
Notes This field can be viewed before the Early Detection Quarantine waiver is signed. Once the Earlly Detection Quarantine waiver is signed in the Administration Console, this field can be edited. Otherwise, the system returns an error.
Chapter 7 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.
See “Batch Command and Field Quick Summary” on page 27, and “Batch Field Quick Summary” on page 111 for additional information. active The active field indicates whether the user has ever logged into the Message Center. Syntax active=< no/0 | yes/1 > Examples When returned by the displayuser command: active 1 (yes) Description Switch shows whether user has logged into the Message Center.
Related Commands • Input: listusers • Output: displayuser, listusers See Also “Viewing Message Center Settings” on page 536 “Seeing if a User Has Received a Welcome Notification” on page 547 “Resending the Welcome Notification” on page 548 The Message Security Administration Guide, “User’s and Quarantines” address The address field holds the email address of the user or the user’s alias. Syntax address= Examples • When the field is returned as output: address kkerns@jumboinc.
Authorization • Read: Change Address • Write: Change Address Notes The Batch interface allows apostrophes, commas, #, =, “ “, ‘ ‘ symbols in user or organization names. These must be either in double quotes or proceeded by a ‘\’ symbol.
Examples • When the field is returned as output, example as empty: approved_recipients empty • Adding a mailing list to the Approved Mailing list, either is correct: modifyuser msmith@jumboinc.com, approved_recipients=+newupdates@hugeisp.com modifyuser msmith@jumboinc.com, approved_recipients=newupdates@hugeisp.com • Removing a mailing list from a user’s Approved Mailing list: modifyuser msmith@jumboinc.com, approved_recipients=newupdates@hugeisp.
Notes • Adding or deleting a domain applies to subdomains. • Approved Recipient lists have a size limit of 4000 characters which approximately equates to 100 to 130 addresses and domains per list.
modifyuser msmith@jumbocinc.com, approved_senders=-jim@hugeisp.com • Adding a domain and removing a domain from the Approved Senders list, either is correct: modifyuser msmith@jumbocinc.com, approved_senders=”+jumboinc.com,hugeisp.com” modifyuser msmith@jumbocinc.com, approved_senders=”jumboinc.com,hugeisp.com” Note: See “approved_senders (for orgs)” on page 306 (for an org’s Approved Sender lists) for additional examples.
Notes • Mail from senders on this list will bypass the Junk Email filters. • If virus blocking is enabled for the recipient, the message will not be delivered even though on the Approved Senders list. • At the organization-level, the Blocked Senders list overrides the Approved Senders list. At the user-level, the Approved Senders list overrides the Blocked Senders list. The user-level Approved Senders list overrides the organization-level Blocked Senders list.
blocked_senders (for users) The blocked_senders field lists an email address or a domain to be added or removed from the user-level Blocked Senders list. All messages from these senders or domains will be quarantined in the user’s Message Center. Syntax blocked_senders=< [+] | -emailaddress> | < [+] | -domain name> | ,... Examples • When the field is returned as output: blocked-senders empty • Adding a sender to the user’s Blocked Senders list, either is correct: modifyuser msmith@jumboinc.
Field Type User-level Authorization • Read: Senders Lists • Write: Senders Lists Notes • Adding or deleting a domain from the list applies to subdomains. For example, approving the domain jumboinc.com also approves the subdomain sales.jumboinc.com. • If an organization has Industry Heuristics turned on, messages with industry content will still be quarantined if the sender or domain is in user’s Blocked Senders list. • IP addresses can not be added to the user’s Blocked Senders list.
See Also “Viewing Authentication and Password Settings” on page 540 “Viewing Message Center Settings” on page 536 The Message Security Administration Guide, “Approved and Blocked Sender Lists” create_method (for users) The create_method field shows how a user is created. Syntax create_method = < 0 | 1 | 2 | 3 | 5> Examples create_method=0 Description Shows how a user was created.
Notes Organizations created during a Directory Sync synchronization are created by the addorg command, and the organizations’ create_method field value is 3. Directory Sync is an optional feature.
Authorization • Read: User Settings • Write: Read-only for administrators Notes This field only applies to deployments of Perimeter Manager Enterprise Edition, Release 2.5 and later. This includes Message Security for Enterprises.
Description The date the im_map record was created. This date is displayed in the Administration Console in Greenwich Mean Time.
Examples When assigning the field: modifyuser msmith@jumboinc.com, filter_adult=11 modifyuser msmith@jumboinc.
See Also “Editing Message Center Access and Settings” on page 538 “Viewing Authentication and Password Settings” on page 540 The Message Security Administration Guide, “Users and Quarantines” filter_bulk The filter_bulk field holds the general spam filter setting for the user. This filter handles the bulk of the spam being blocked. Syntax filter_bulk= Examples When the field is assigned: modifyuser msmith@jumboinc.com, filter_bulk=11 modifyuser msmith@jumboinc.
Authorization • Read: Spam Filters • Write: Spam Filters Related Commands • Input: adduser, modifyuser • Output: displayuser Related Fields filter_adult, filter_getrich, filter_offers, filter_racial, junkmail_filter, The Message Security Administration Guide, “Approved and Blocked Sender Lists” (for orgs) See Also “Viewing Message Center Settings” on page 536 The Message Security Administration Guide, “Users and Quarantines” filter_getrich The filter_getrich field holds the Get Rich Quick category
Description Level of get-rich-quick content: • 11/off (1) • 12/lenient (2) • 13/moderate (3) (medium, in Message Center II) • 14/moderately-aggressive (4) (aggressive, in Message Center II) • 15/aggressive (5) (very aggressive, in Message Center II) Field Type User-level Authorization • Read: Spam Filters • Write: Spam Filters Related Commands • Input: adduser, modifyuser • Output: displayuser Related Fields filter_adult, filter_bulk, filter_offers, filter_racial, junkmail_filter See Als
Syntax filter_offers= Examples When the field is assigned: modifyuser msmith@jumboinc.com, filter_offers=11 modifyuser msmith@jumboinc.
Related Fields filter_adult, filter_bulk, filter_getrich, filter_racial, junkmail_filter See Also “Viewing Authentication and Password Settings” on page 540 The Message Security Administration Guide, “Users and Quarantines” filter_racial The filter_racial field holds Racially Insensitive category filter setting for the user. Syntax filter_racial= Examples When the field is assigned: modifyuser msmith@jumboinc.com, filter_racial=12 modifyuser msmith@jumboinc.
Authorization • Read: Spam Filters • Write: Spam Filters Related Commands • Input: adduser, modifyuser • Output: displayuser Related Fields filter_adult, filter_bulk, filter_getrich, filter_offers, filter_racial, junkmail_filter See Also “Viewing Message Center Settings” on page 536 The Message Security Administration Guide, “Users and Quarantines” im_name The im_name field holds the IM user’s screen name. This field applies to Postini IM Security, an optional product.
Description The IM user’s screen name. Field Type User-level Authorization • Read: User Settings, IM Management • Write: User Settings, IM Management Related Commands • Input: iplock add_range, im delete, im display, im listforuser • Output: im display, im list, im listforuser See Also initial_password The initial_password field holds the PMP password assigned to this user when the user was first added to the service.
Description System generated temporary password for new users in orgs with PMP authentication. This password expires after 30 days. • NULL -- This field is not active. Field Type User-level Authorization • Read: Change Passwords • Write: Read-only for administrators Notes • Users are prompted to change the password when first logging into the Message Center/or Administration Console. • Requires user org uses PMP authentication.
junkmail_filter The junkmail_filter field is an on/off switch for Spam Filtering. Syntax junkmail_filter= Examples • When the field is assigned: modifyuser msmith@jumbocinc.com, junkmail_filter=on • When the field is returned: junkmail_filter 1 (on) Description Spam filtering control: • off -- Junk email filtering is disabled • on -- Junk email filtering is enabled Note: The numeric equivalents to ‘on’ and ‘off’ are useful for debugging purposes.
Related Fields filter_adult, filter_bulk, filter_getrich, filter_offers, filter_racial See Also “Editing Message Center Access and Settings” on page 538 “Viewing Authentication and Password Settings” on page 540 The Message Security Administration Guide, “Spam Filters” lang_locale (for users) The lang_locale field enables user-level language localization in Message Center’s static text, the default top text, character sets, and date format.
Field Type User-level Authorization • Read: Regional Settings • Write: Regional Settings Related Commands • Input: adduser, modifyuser • Output: displayuser See Also “Viewing Authentication and Password Settings” on page 540 The Message Security Administration Guide, “Quarantine Summary & Notifications” lastmod_date (for users) The lastmod_date field shows the last time the user record was modified.
Field Type User-level Authorization • Read: User Settings • Write: Read-only for administrators Related Commands Output: displayuser Related Fields created_date (for users), created_ts (for users), lastmod_date (for orgs) See Also The Message Security Administration Guide, “Reports” message_count The message_count field holds the approximate number of messages received by this user within one day.
The count goes up in increments of 8 for system performance optimization. Field Type User-level Authorization • Read: Traffic Limits • Write: Read-only for administrators Related Commands Output: displayuser See Also “Viewing Message Center Settings” on page 536 The Message Security Administration Guide, “Users and Quarantines” message_encrypt (for users) The message_encryption field enables outbound user messages to be encrypted and sent to a secure portal.
modifyuser msmith@jumboinc.com, message_encryption=on Note: See message_encryption (for an org’s outbound encrypted messages) for additional examples. Description Enable external encryption: • on -- Messages are always encrypted with Message Security. • off -- Messages not encrypted with Message Security, but may have Transport Layer Security (TLS). • match -- System looks in the message header for “string. If the string is found, the message is encrypted with Message Security.
See Also Postini Encryption Services Administration Guide, “How Connection Security Works” message_limit The message_limit field holds the maximum number of messages allowed per day for this user. Syntax message_limit=<0 - 99999999> | NULL> Examples • When the field is returned as output: message_limit 1000 • To change the setting: modifyuser msmith@jumboinc.com, message_limit= 1000 Description Number of message per day allowable: • NULL -- No limit is set.
Notes • This limit can also be set for individual users or for the organization as a whole. Whichever limit is lower—the org limit or a user’s limit—applies for the user. If a user’s limit is blank and a value is set for the org, the org value applies to the user. • When exceeded, incoming messages are bounced, returning a 554 Mailbox limit exceeded. message to the sender. • Setting a message limit is useful for protecting mail servers against malicious attacks, such as email bombs.
message_limited 0 (no) Description Shows the user has reached the message limit. • no -- Message limit has not been reached • yes -- Message limit has been reached The numeric equivalents to ‘no’ and ‘yes’ are useful for debugging purposes. For robust production code, use the text value, ‘no’ or ‘yes’.
Examples • When the field is returned as output: notice_address msmith@jumboinc.com • Adding a new user: adduser jim@jumboinc.com, notice_address=support@jumboinc.com • Clearing the notice_address field: modifyuser msmith@jumboinc.com, notice_address=NULL Description Address to which system generated notices are sent. • NULL -- This field is not active.
See Also “Editing Message Center Access and Settings” on page 538 The Message Security Administration Guide, “Users and Quarantines” orgid The orgid field holds a unique ID for the organization containing the user. Syntax orgid= Examples • When the field is assigned: orgid=org1 • When the field is returned: orgid 100001012 (sales) Description The user level’s foreign key for the organization’s iid field.
Authorization • Read: User Settings • Write: User Settings Notes • The Batch interface allows apostrophes, commas, #, =, “ “, ‘ ‘ symbols in user or organization names. These must be either in double quotes or proceeded by a ‘\’ symbol.
Syntax password= Examples • When the field is returned as output (encrypted): password 3pds9999 • To change the setting (which is plain text): modifyuser msmith@jumboinc.com, password=swordfish Description This holds the encrypted PMP user password. This allows assigning a new user a new password. The user will need this password to access the user’s Message Center II and/or Administration Console if the user is an administrator. Display shows the encrypted version.
Authorization • Read: Change Passwords • Write: Change Passwords Related Commands • Input: adduser, modifyuser, password reset • Output: displayuser • Related: resetuser Related Fields authentication_data, authentication_type, initial_password, remotecmd_secret See Also “Viewing Authentication and Password Settings” on page 540 “Editing a PMP Password” on page 541 The Message Security Administration Guide, “User Authentication” primary The primary field holds the primary user’s unique identifyin
Field Type User-level Authorization • Read: User Settings • Write: Read-only for administrators Related Commands Output: listusers See Also The Message Security Administration Guide, “Users and Quarantines” primary_add The primary_add field holds the primary user address. Syntax primary_add = < user name > Examples primary_add msmith@jumboinc.
Authorization • Read: User Settings • Write: Read-only for administrators Notes The Batch interface allows apostrophes, commas, #, =, “ “, ‘ ‘ symbols in user or organization names. These must be either in double quotes or proceeded by a ‘\’ symbol. Related Commands • Input: listusers • Output: listusers Related Fields address, primary See Also The Message Security Administration Guide, “Users and Quarantines” timezone (for users) The timezone field holds the user’s timezone, a UNIX TZ string.
Description UNIX TZ timezone for Message Center, and for Message Center Classic user wireless email settings which applies only if Wireless Forwarding is enabled for the user. • NULL -- This field is not active. WARNING: Don’t change this setting in the Administration Console. It should be managed by the users themselves, at the user’s Message Center.
TS1 The TS1 field holds the most recent timestamp for a good email message to a provisional user. This field is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Syntax TS1= < time in UNIX seconds > Examples TS1 1145962000 Description Timestamp of the most recent good email message was received for a provisional user.
Related Commands • Input: listprovusers • Output: displayprovuser • Related: blockprovuser, deleteprovuser, promoteprovuser, unblockprovuser Related Fields address, TS3 See Also The Message Security Administration Guide, “Users and Quarantines” TS3 The TS3 field holds the timestamp for the oldest email message to a provisional user. This field is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Authorization • Read: Add Users • Write: Read-only for administrators Notes Used with SmartCreate, newly added users are unconfirmed provisional users. These users are promoted to regular user after verified as associated with someone in your org by receiving 3 legitimate emails within a week. Or the user can be blocked or unblocked from being added to the Message Security service. Once the email criteria is met, the user is added to service. Otherwise the user is deleted.
Description The user’s unique ID. Field Type User-level Authorization • Read: User Settings • Write: Read-only for administrators Related Commands Output: listusers Related Fields orgid, u_id, user_id See Also The Message Security Administration Guide, “Users and Quarantines” u_id The u_id field holds a unique ID for this user.
Description Unique user ID. This is the same as the uid and user_id fields. Field Type User-level Authorization • Read: User Settings • Write: Read-only for administrators Related Commands • Input: listusers • Output: im display, listusers, user_im_settings display Related Fields orgid, uid, user_id See Also The Message Security Administration Guide, “Users and Quarantines” user_id The user_id field holds a unique ID for this user, and is useful when escalating an issue to Customer Care.
user_id 2001122283 Description Unique key for each user. A user’s primary email address can be changed, but its ID always remains the same. This is the same as the uid and u_id fields.
Examples • When the field is returned as output: virus_notify NULL () • To change the setting: modifyuser msmith@jumboinc.com, virus_notify=1 Description How frequently virus notification email will be generated: • 0 -- Immediately • 1 -- No more than one notice per day • 9 -- Disable notifications • NULL () -- This field is not active. Uses organization setting as the default.
virus_state The virus_state field is an on/off/unavailable switch for virus scanning functionality. Syntax virus_state=< 0/on | 1/off | 2/unavailable > Examples • When assigning the field: modifyuser msmith@jumboinc.com, virus_state=on • When the field is returned: virus_state 0 (on) Description Virus scanning switch for on, off, not allowed.
See Also The Message Security Administration Guide, “Virus Filters” weblocked The weblocked field is an on/off switch giving Message Center Access for the user. Syntax weblocked=<0/no | 1/yes> Examples • When assigning the field: modifyuser msmith@jumboinc.com, weblocked=1 • When the field is returned: weblocked 0 (no) Description Controls web access: • 0/no -- The Message Center Access is enabled. The user can log in. • 1/yes -- The Message Center Access is disabled. The user can not log in.
Related Commands • Input: adduser, modifyuser • Output: displayuser See Also “Editing Message Center Access and Settings” on page 538 The Message Security Administration Guide, “Users and Quarantines” welcome_count The welcome_count field holds whether a welcome message have been sent.
Related Commands Output: displayuser See Also “Viewing Authentication and Password Settings” on page 540 “Seeing if a User Has Received a Welcome Notification” on page 547 The Message Security Administration Guide, “Customizing Notifications” wireless_state The wireless_state field is an on/off/unavailable switch for Wireless Forwarding which allows the user to forward messages to a text-enabled phone, PDA, or other mobile device.
Field Type User-level Authorization Write: Wireless Settings Notes • Available only to North American users and applies only to Message Center Classic. • To make Wireless Forwarding temporarily unavailable for a user without removing this permission, set Wireless Forwarding in the user’s General Settings to “Not allowed.
Chapter 8 Batch Domain Fields Chapter 8 About Batch Domain Fields The batch domain fields hold domain-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.
alias The alias field holds the domain’s aliases. Syntax alias = , ... Examples modifydomain jumboinc.com, alias=jumboalias.com Description Lists a domain’s aliases.
aliasedfrom The aliasedfrom field lists a domain’s aliases. Syntax aliasedfrom < domain’s alias >, ... Examples aliasedfrom jumbo.com aliasedfrom “jumbo.com, jumboincwest.com” Description Lists a domain’s aliases.
Syntax aliasedto Examples aliasedto jumboinc.com Description Lists the domain associated with this alias. Field Type Domain Authorization • Read: Edit Organizations, Manage Domains • Write: Read-only for administrators Related Commands Output: displaydomain See Also The Message Security Administration Guide, “Domains” catchall This is a legacy feature, and available if your account has been configured for a catchall account.
Syntax catchall = Examples catchall catchalluser@jumboinc.com Description User account assigned as the Catchall User for the initial domain. • user address -- Catchall User mail address • NONE -- This feature is not available for this organization.
Related Commands Input: modifydomain Related Fields non_account_virus_scan See Also The Message Security Administration Guide, “Domains” created_ts (for domains) The created_ts (for domains) field holds the domain’s creation timestamp. Syntax created_ts Examples created_ts 1145962000 Description Contains the domains creation timestamp.
Related Commands • Input: listdomains • Output: listdomains Related Fields created_ts (for users) See Also The Message Security Administration Guide, “Reports” domainid The domainid field holds the domain’s unique ID. Syntax domainid = < domain ID > Examples domainid 100001012 Description Holds the domain’s unique ID.
Related Commands • Input: deletedomain, displaydomain, listdomains • Output: listdomains Related Fields domainname, primary_did See Also The Message Security Administration Guide, “Domains” domainname The domainname field holds the name of the domain. Syntax domainname=< domain name > Examples • When the field is returned as output: domainname jumboinc.com • To delete the domain with the domainname ‘jumboinc.com’: deletedomain jumboinc.
Authorization • Read: Edit Organizations, Manage Domains • Write: Edit Organizations, Manage Domains Related Commands • Input: adddomain, deletedomain displaydomain, domain_tls add, domain_tls delete,domain_tls modify, iplock add_range, iplock delete, iplock delete_range, iplock display, iplock set_disposition, listdomains, modifydomain, testmx • Output: displaydomain, listdomains Related Fields domainid, iid, org (for domains), primary_did, substrip See Also The Message Security Administration Gui
Description The organization associated with this domain. Field Type Domain Authorization • Read: Edit Organizations, Manage Domains • Write: Read-only for administrators Related Commands Output: displaydomain See Also The Message Security Administration Guide, “Domains” primary_did The primary_did field holds the primary domain ID. Syntax primary_did = Examples primary_did 100001012 Description A primary domain’s ID (not an alias).
Field Type Domain Authorization • Read: Edit Organizations, Manage Domains • Write: Read-only for administrators Related Commands Output: listdomains See Also The Message Security Administration Guide, “Domains” primary_dom The primary_dom field holds the primary domain name associated with a domain alias. Syntax primary_dom = < primary domain name > Examples primary_dom jumboinc.com Description The primary domain’s name associated with a domain alias.
Authorization • Read: Edit Organizations, Manage Domains • Write: Read-only for administrators Related Commands Output: listdomains See Also The Message Security Administration Guide, “Domains” substrip The substrip field enables subdomain substripping for the domain. This field is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Field Type Domain Authorization • Read: Edit Organizations, Manage Domains • Write: Edit Organizations, Manage Domains Related Commands • Input: adddomain, modifydomain • Output: displaydomain, setorgsubstripping See Also The Message Security Administration Guide, “Domains” sub_strip The sub_strip field enables subdomain substripping for the domain. This field is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
Description Enables subdomain substripping for a domain. The sub domains become aliases for the primary domain. • on -- Domain substripping is enabled • off -- Domain substripping is disabled Note: The sub_strip field is the same as the substrip field.
Chapter 9 Batch Report Fields Chapter 9 About Batch Report Fields The batch report fields hold the return data displayed by the getorgreport command. The reports return information about your organization’s traffic, spam, virus, and billing/usage activity.
acc_messages The acc_messages field holds the number of email messages sent to accounts or aliases registered in the Message Security service for the Traffic Report. Syntax acc_messages = Examples When the field is returned as output: acc_message 2 For a traffic summary report in the Administration Console, acc_messages is the same as Acct Msgs.
Related Fields num_bh_messages, num_bytes, num_f_messages, num_messages, num_q_messages, pct_bh_bytes, pct_bh_messages, pct_f_bytes, pct_f_messages, pct_q_bytes, pct_q_messages, recip See Also The Message Security Administration Guide, “Reports account The account field holds the user account for spam and virus messages in the orglevel Spam and Virus Reports. Syntax account = Examples When the field is returned as output: account Sales Description Virus and Spam Report account name.
Related Commands Output: getorgreport (Org Virus and Spam Summary Reports) Related Fields • spam: bad_isp, bad_sender, bulk, bytes, commerce, deliveries, mmf, naughty, num_spams, racial, ssb • virus: bytes, cleanings, clean_failures, inf_deliveries, num_viruses See Also The Message Security Administration Guide, “Reports” bad_isp The bad_isp field holds the total number of quarantined messages due to a Blocked Senders listed domain. Used in the Spam Report.
Authorization • Read: View Reports • Write: Read-only for administrators Note: Review the getorgreport command authorizations before running the Spam Report summary.
Notes Mail messages that do not match a domain’s IP block and have a quarantine disposition, are included in the bad_sender field’s total. Field Type Org Spam Report Authorization • Read: View Reports • Write: Read-only for administrators Review the getorgreport command authorizations before running the Spam Report summary.
Examples When the field is returned as output: bulk 3 Description General category for junk email filtering (may include characteristics of the other specific filter categories). Field Type Org Spam Report Authorization • Read: View Reports • Write: Read-only for administrators Review the getorgreport command authorizations before running the Spam Report summary.
Syntax bytes= Examples When the field is returned as output: bytes 3 Description Spam and Virus Bytes. Total size of quarantined spam or virus messages. Field Type Org Spam and Virus Report Authorization • Read: View Reports • Write: Read-only for administrators Review the getorgreport command authorizations before running the Spam or Virus Report summary.
cleanings The cleanings field holds the number of viruses cleaned for the Virus Report. Syntax cleanings= Examples When the field is returned as output: cleanings 3 Description Total number of viruses cleaned. Field Type Org Virus Report Authorization • Read: View Reports • Write: Read-only for administrators Review the getorgreport command authorizations before running the Virus Report summary.
See Also The Message Security Administration Guide, “Reports” clean_failures The clean_failures field holds the number of viruses cleaning failures for the Virus Report. Syntax clean_failures= Examples When the field is returned as output: clean_failures 3 Description Total number of viruses cleaning failures.
Related Fields account, bytes, cleanings, inf_deliveries, num_viruses See Also The Message Security Administration Guide, “Reports” commerce The commerce field holds the number of filtered special offers for the Spam Report. Syntax commerce= Examples When the field is returned as output: commerce 3 Description Total number of filtered special offers.
Related Commands Output: getorgreport (Org Spam Summary Report) Related Fields account, bad_isp, bad_sender, bulk, bytes, deliveries, mmf, naughty, num_spams, racial, ssb See Also The Message Security Administration Guide, “Reports” customerid The customerid field holds unique identifying number for an Message Security service account customer. Used in the Usage Report.
Authorization • Read: Account-level permissions • Write: Read-only for administrators Note: Review the getorgreport command authorizations before running the Usage Report summary. Related Commands Output: getorgreport Related Fields customername, messages, productid, sellerid, stored_size, users See Also The Message Security Administration Guide, “Reports” customername The customername field holds the name of the customer. Used in the Usage Report.
Field Type Org Report Management Authorization • Read: Account-level permissions • Write: Read-only for administrators Review the getorgreport command authorizations before running the Usage Report summary.
Description Total number of spam messages delivered from Quarantine to the user’s mailbox. Field Type Org Spam Report Authorization • Read: View Reports • Write: Read-only for administrators Review the getorgreport command authorizations before running the Spam Report summary.
Examples When the field is returned as output: inf_deliveries 3 Description Total number of infected deliveries from quarantine spam messages. Field Type Org Virus Report Authorization • Read: View Reports • Write: Read-only for administrators Review the getorgreport command authorizations before running the VIrus Report summary.
Syntax messages= Examples When the field is returned as output: messages 11 Description Number of messages in Usage Report output Field Type Org Report Management Authorization • Read: Account-level permissions • Write: Read-only for administrators Review the getorgreport command authorizations before running the Usage Report summary.
mmf The mmf field holds the total number of Get Rich messages for the Spam Report. Syntax mmf= Examples When the field is returned as output: mmf 3 Description Total number of Get Rich messages in the Spam Report. Field Type Org Spam Report Authorization • Read: View Reports • Write: Read-only for administrators Review the getorgreport command authorizations before running the Spam Report summary.
See Also The Message Security Administration Guide, “Reports” naughty The naughty field holds the total number of messages triggering the Sexually Explicit junk email filter for the Spam Report. Syntax naughty= Examples When the field is returned as output naughty 3 Description Total number of messages triggering the Sexually Explicit junk email filter.
Related Fields account, bad_isp, bad_sender, bulk, bytes, commerce, deliveries, mmf, num_spams, racial, ssb See Also The Message Security Administration Guide, “Reports” num_bh_messages The num_bh_messages field holds the total size of blackholed messages for the Traffic Report. Syntax num_bh_messages= Examples When the field is returned as output: num_bh_messages 3 For a traffic summary report in the Administration Console, num_bh_messages is the same as Blocked Acct Msgs.
Review the getorgreport command authorizations before running the Traffic Report summary. Related Commands Output: getorgreport Related Fields acc_messages, num_bytes, num_f_messages, num_messages, num_q_messages, pct_bh_bytes, pct_bh_messages, pct_f_bytes, pct_f_messages, pct_q_bytes, pct_q_messages, recip See Also The Message Security Administration Guide, “Reports” num_bytes The num_bytes field holds the total size of messages in bytes for the Traffic Report.
Field Type Org Traffic Report Authorization Read: View Reports Write: Read-only for administrators Related Commands Output: getorgreport (Org Traffic Summary Report) Related Fields acc_messages, num_bh_messages, num_f_messages, num_messages, num_q_messages, pct_bh_bytes, pct_bh_messages, pct_f_bytes, pct_f_messages, pct_q_bytes, pct_q_messages, recip See Also The Message Security Administration Guide, “Reports” num_f_messages The num_f_messages field holds the total number of messages delivered directl
Description Total number of messages delivered directly to your mail server for all addresses in the server’s domain.
Examples When the field is returned as output: num_messages 3 For a traffic summary report in the Administration Console, num_messages is the same as Messages. Description Total number of messages passed through the Message Security service.
Syntax num_q_messages= Examples When the field is returned as output: num_q_messages 3 For a traffic summary report in the Administration Console, num_q_messages is the same as Quarantined Acct Msgs. Description Total number of quarantined messages.
num_spams The num_spams field holds the number of quarantined spam for the Spam Report. Syntax num_spams= Examples When the field is returned as output: num_spams 3 Description Total number of quarantined spam.
See Also The Message Security Administration Guide, “Reports” num_viruses The num_viruses field holds the total number of quarantined viruses for the Virus Report. Syntax num_viruses = Examples When the field is returned as output: num_viruses 3 Description Total number of quarantined viruses.
See Also The Message Security Administration Guide, “Reports” pct_bh_bytes The pct_bh_bytes field holds the total percent of blackholed messages in bytes for the Traffic Report. Syntax pct_bh_bytes= Examples When the field is returned as output: pct_bh_bytes 3.0 For a traffic summary report in the Administration Console, pct_bh_bytes is the same as Blocked Acct Msgs, % of Bytes. Description Total number of percent of blackholed messages in bytes.
Related Fields acc_messages, num_bh_messages, num_bytes, num_f_messages, num_messages, num_q_messages, pct_bh_messages, pct_f_bytes, pct_f_messages, pct_q_bytes, pct_q_messages, recip See Also The Message Security Administration Guide, “Reports” pct_bh_messages The pct_bh_messages field holds the total percent of blackholed messages for the Traffic Report. Syntax pct_bh_messages= Examples When the field is returned as output: pct_bh_messages 3.
Related Commands Output: getorgreport (Org Traffic Summary Report) Related Fields acc_messages, num_bh_messages, num_bytes, num_f_messages, num_messages, num_q_messages, pct_bh_bytes, pct_f_bytes, pct_f_messages, pct_q_bytes, pct_q_messages, recip See Also The Message Security Administration Guide, “Reports” pct_f_bytes The pct_f_bytes field holds the total percent of bytes delivered to your mail server for the account in bytes for the Traffic Report.
Authorization • Read: View Reports • Write: Read-only for administrators Related Commands Output: getorgreport (Org Traffic Summary Report) Related Fields acc_messages, num_bh_messages, num_bytes, num_f_messages, num_messages, num_q_messages, pct_bh_bytes, pct_bh_messages, pct_f_messages, pct_q_bytes, pct_q_messages, recip See Also The Message Security Administration Guide, “Reports” pct_f_messages The pct_f_messages field holds the total percent of messages delivered to your mail server for the acco
Field Type Org Traffic Report Authorization • Read: View Reports • Write: Read-only for administrators Related Commands Output: getorgreport (Org Traffic Summary Report) Related Fields acc_messages, num_bh_messages, num_bytes, num_f_messages, num_messages, num_q_messages, pct_bh_bytes, pct_bh_messages, pct_f_bytes, pct_q_bytes, pct_q_messages, recip See Also The Message Security Administration Guide, “Reports” pct_q_bytes The pct_q_bytes field holds the total percent of quarantined messages in bytes
Description Total number of percent of quarantined messages in bytes.
pct_q_messages 3.0 For a traffic summary report in the Administration Console, pct_q_messages is the same as Quarantined Acct Msgs, % of Msgs. Description Total number of percent of quarantined messages.
Syntax productid= Examples As part of the settings output of the getorgreport command: productid ee Description Product name used in the Usage Report.
Syntax racial= Examples When the field is returned as output: racial 3 Description Total number of messages triggering the Racially Insensitive junk email filter.
recip The recip field holds the email address of the recipient account for the Traffic Report. Syntax recip= Examples When the field is returned as output: recip msmith@jumboinc.com For a traffic summary report in the Administration Console, recip is the same as Recipient. Description Email address of the recipient account.
See Also The Message Security Administration Guide, “Reports” sellerid The sellerid field holds the unique identifying number of the Message Security service seller for the Usage Report Syntax sellerid= Examples As part of the settings output of the getorgreport command: sellerid 11111801 Description Holds the unique identifying number of the Message Security service seller for the Usage Report.
Related Fields customerid, customername, messages, productid, stored_size, users See Also The Message Security Administration Guide, “Reports” ssb The ssb field holds the number of messages impacted by the Blatant Spam Blocking for the Spam Report. Syntax ssb= Examples When the field is returned as output: ssb 3 Description Total number of messages impacted by the Blatant Spam Blocking filter.
Related Fields account, bad_isp, bad_sender, bulk, bytes, commerce, deliveries, mmf, naughty, num_spams, racial See Also The Message Security Administration Guide, “Reports” stored_size The stored_size field holds the total number of stored message bytes in the archive for the last month for the Usage Report. This field applies to Postini Message Archiving, an optional product.
Related Commands Output: getorgreport Related Fields customerid, customername, messages, productid, sellerid, users See Also The Message Security Administration Guide, “Reports” Batch Report Fields 517
users The users field holds the total number of users in the Usage Report. Syntax users= Examples As part of the settings output of the getorgreport command: users 11 Description Number of primary users listed in a Usage Report for an organization. The total does not include user aliases.
Batch Report Fields 519
Chapter 10 Batch Spool Fields Chapter 10 About Batch Spool Fields The batch spool fields hold the return data displayed by the displayspool command. These fields are associated with your email config organization. These fields are applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only.
auto_unspool The auto_unspool field is the on/off switch for automatically delivering spooled messages. Syntax auto_unspool= Examples When the field is returned as output: auto_unspool 0 Description Switch for delivering spooled messages automatically: • on -- Automatic unspooling is enabled. While you have spooled mail, Spool Manager will poll your server one time per minute until it has been available for 3 subsequent minutes.
Related Fields despool_max_connections, duration, org (for spooling), quota, spool_delay, spool_mech, status, used_pct, used_size See Also The Message Security Administration Guide, “Spool Manager” despool_max_connections The despool_max_connections field holds the maximum number of dedicated connections which will deliver your spooled mail when an outage is complete. This is the Unspooling Connection Rate.
Notes • This rate should deliver messages at a volume that your mail servers can safely manage. We recommend allocating no more than 15% of the sum of your connection limits. • The despool_max_connections field is the same as the Unspooling Rate field in the Administration Console batch return value.
Field Type Org Spool management Authorization • Read: Spooling • Write: Read-only for administrators Related Commands Output: displayspool Related Fields auto_unspool, despool_max_connections, org (for spooling), quota, spool_delay, spool_mech, status, used_pct, used_size See Also The Message Security Administration Guide, “Spool Manager” org (for spooling) The org field holds the name of the email config organization managed by Spool Manager.
Description Name of the email config organization associated with spooling. Field Type Org Spool management Authorization • Read: Spooling • Write: Read-only for administrators Notes The Batch interface allows apostrophes, commas, #, =, “ “, ‘ ‘ symbols in user or organization names. These must be either in double quotes or preceeded by a ‘\’ symbol.
Syntax quota= Examples As part of the settings output of the displayspool command: quota 5242880 Description Assigned space available for spooling for this email config in bytes. It is displayed in the Administration Console as MB. Field Type Org Spool management Authorization • Read: Account-level Spooling • Write: Read-only for Account organization administrators Notes • Allocation is altered by amending your service contract.
See Also The Message Security Administration Guide, “Spool Manager” spool_delay The spool_delay field, in conjunction with connection failures, determines how many seconds before spooling starts Syntax spool_delay=<900 | 1800 | 3600> Examples When the field is returned as output: spool_delay 900 Description In seconds, determines how many minutes before spooling starts: • Spooling delay choices are 15 (900 seconds), 30 (1800), 60 (3600) minutes.
Related Commands Output: displayspool Related Fields auto_unspool, despool_max_connections, duration, org (for spooling), quota, spool_mech, status, used_pct, used_size See Also The Message Security Administration Guide, “Spool Manager” spool_mech The spool_mech field holds the initiation mechanism that starts spooling.
Description Spool initiation states: • Automatic -- The Spool Manager starts spooling automatically when there is an outage. Spool Manager must be set to automatic for the automatic initiation to occur. • “Start Manually” -- You may start spooling messages while upgrading server software, hardware, network, or any other process that might interrupt delivery of email messages.
See Also The Message Security Administration Guide, “Spool Manager” status The status field holds email config organization’s status managed by Spool Manager. Syntax status=<“Not Provisioned” | Suspended | “Standing By” | Spooling | Unspooling> Examples As part of the settings output of the displayspool command: status Suspended Description Email config organization’s spooling status: • “Not Provisioned” -- Customers have not purchased spooling services.
Authorization • Read: Spooling • Write: Read-only for administrators Related Commands Output: displayspool Related Fields auto_unspool, despool_max_connections, duration, org (for spooling), quota, spool_delay, spool_mech, used_pct, used_size See Also The Message Security Administration Guide, “Spool Manager” used_pct The used_pct field is the percentage of the assigned spooling space that has been used.
Field Type Org Spool management Authorization • Read: Spooling • Write: Read-only for administrators Notes The used_pct field is the same as the Spool Percent Used field in the Administration Console batch return value.
used_size 0 Description Shows the total of used allocated spool storage in bytes. Spool Manager does not issue alerts for manually initiated spooling. Field Type Org Spool management Authorization • Read: Account-level Spooling • Write: Read-only for Account organization administrators Notes The used_size field is the same as the Spool Used field in the Administration Console batch return value.
Chapter 11 Examples of Common Tasks Chapter 11 About Common Task Examples This chapter presents examples of common organization, Message Center, and notification using the batch command interface. Also included are tasks for Postini Message Archiving, Postini Message Encryption, and Postini IM Security, which are optional products.
#is_email_config yes Each task code sample is documented explaining these inter-relationships and has links to a reference pages for additional examples and information.
The approved_recipients field holds an email address or domain to be added or removed from the Approved Recipients list which is also known as the Approved Mailing list located in the user’s Message Center. The approved_senders (for users) field holds an email address or domain to be added or removed from the user-level Approved Senders list in the user’s Message Center. The Approved Senders list overrides the organization-level Approved Senders and Blocked Senders lists.
The timezone field is shown in the Quarantine Summary and the Message Center. WARNING: Don’t change this setting in the Administration Console. It should be managed by the users themselves, at the user’s Message Center. 6. Also found in the displayuser output, the lang_locale (for users) field enables user-level language localization in Message Center’s static text, the default top text, character sets, and date format. lang_local en_us.
The weblocked field is an on/off switch giving Message Center Access for the any user including the Default User. The ‘0 (no)’ means the access not blocked. It is enabled and users can log into their Message Centers. 3. Using the modifyuser command, enable the Message Center access using the Default User template. modifyuser pdefaultSales@jumboinc.com, weblocked=0 It is important to enable Message Center access at the Default User-level — whether or not you want users to have it.
The junkmail_filter field is an on/off switch for Spam Filtering The filter_adult field holds the sexual content filter settings for the user. The filter_bulk field holds the general spam filter setting for the user. This filter handles the bulk of the spam being blocked. The filter_getrich field holds the Get Rich Quick category filter setting for the user. The filter_offers field holds the Special Offers category filter setting for the user.
Since POP authentication is a non-PMP authentication type, find the authentication_data field which holds the text string used for non-PMP authentication of users and administrators when logging into the Message Center or Administration Console. authentication_data ”apopserver,@jumboinc.com” If the authentication type is XAuth, find the XAuth authentication secret: authentication_data swordfish 2.
The displayuser command’s output lists the password field: password 5d00000 3. Use the modifyuser command to change the user’s PMP password. modifyuser msmith@jumboinc.com, password= 1passWrd Note: To change the passwords for several users, using this example’s syntax, follow the steps explained in “Building a Batch File” on page 19.
Note: The user-level welcome_count field shows whether a welcome message has been sent to a specific user. Use the displayuser command to view this field’s setting. at_notify_on “Send to User” at_notify_on “Send to Both” The at_notify_on field shows the recipient notification status for messages quarantined by the Inbound Attachment Manager. Of the possible values, the notification can be sent to the User or to the redirect address and the User.
The company_name field holds the company or entity name that is used in email notifications. The support_contact field holds the address of the support contact for the organization. This is the sender for org notifications. 3. Using the modifyorg command, change the initial Message Center spam notifications.
displayorg Sales The quarantine_links field is a switch to enable quarantine message links to be available in the Message Center. quarantine_links ’1 (on)’ The quarsum_links field is a switch enabling Quarantine Summary message links to be available. quarsum_links 1 2. Using the displayorg command, determine the general Quarantine Summary notification settings. displayorg Sales The qsum_actionable field holds the action available in Quarantine Summary notifications.
The qtine_redir_spam field holds email address for the user receiving inbound spam email quarantine for an organization. When an outbound message is quarantined as spam, the message is stored in this Message Center. qtine_redir_spam spam_admin@jumboinc.com The qtine_redir_virus field holds the email address for the user receiving inbound virus email quarantine for an organization. When an inbound message is quarantined as a virus, the message is stored in this Message Center.
The qsum_actionable field holds the action available in Quarantine Summary notifications. The qsum_enable field is a switch that sends the Quarantine Summary notifications. It must be ‘on’ for the qsum_actionable field to work. The lang_locale (for orgs) field enables org-level language localization in the Quarantine Summary. 4. Using the modifyorg command, edit the Message Center Quarantine redirected notification settings. modifyorg Sales, qtine_redir_ndr= outboundadmin@jumboinc.
Find the Welcome Notification Setting 1. Using the displayuser command, determine if a user qualifies for a welcome notification. The user must not be active and the user has not yet been welcomed. displayuser msmith@jumboinc.com The active field indicates whether the user has ever logged into the Message Center. If the user is active, a welcome notification is not sent. active ‘1 (yes)’ The welcome_count field indicates if a welcome message has been sent.
2. Using the displayorg command, determine if the My First Spam notification has been sent. displayorg Sales The disable_first_spam field is an activation switch for a new user’s notification telling the user the first spam message has been quarantined in the user’s Message Center. When ‘off’ the user is notified. disable_first_spam 1 3. Using the displayuser command, determine if the user has ever logged in to the Message Center. displayuser msmith@jumboinc.
The virus_notify (for orgs) field holds frequency of a user’s virus notifications. The possible values: 0=immediately 1=nomore than one notice per day 9=disable notification NULL=(user only) use org-level setting virus_notify 9 2. Using the modifyorg command, set a new notification interval. modifyorg Sales, virus_notify=1 3. Using the modifyuser command, set a virus notification interval for a user. modifyuser msmith@jumboinc.
The listorgs command returns a list of your Account, Email Config, and User organizations showing each org’s unique ID number and the organization’s name (iid, orgtag). If you get an error “You don't have permission to listorgs for the organization...”, try starting your list with an org you have authorization for using the targetOrg parameter. listorgs ALL, targetOrg=Sales, childorgs=1 2. Using the displayorg command, display your account organization.
listdomains ALL, aliases=0, childorgs=1 With the parameter aliases=0, the list will be domains only and no domain aliases. 3. If your do not have permission to list all the domains in your account, start the listing with the targetOrg parameter. listdomains ALL, targetOrg=Sales, childorgs=1 If you get an error “You don't have permission to listdomains for the organization...”, try starting your list with an org you have authorization for using the targetOrg parameter. 4.
To locate a Default User either use the default_user field with the displayorg command or see if the listusers command’s output returns a user with the Default User naming convention, pdefault@, postinidefault@, @. default_user pdefault@jumboinc.com The Default User settings template is applied to all new users to this organization unless you modify the new user’s settings with the adduser or modifyuser commands. 4.
2. Using the displayuser command, display the Default User settings. displayuser pdefault@jumboinc.com 3. Using the resetuser command, reset a suspended user. resetuser msmith@jumboinc.com The user will be reset with the Default User settings except for these fields: address, creator, create_method (for users), iid, initial_password, user_id, orgid, welcome_count 4. Using the displayuser command, display the user’s settings. displayuser msmith@jumboinc.
In the displayorg command’s output, find the blocked_senders (for orgs) field which holds lists an email address or a domain for the Blocked Senders list. All messages from these senders or domains are quarantined. blocked_senders jm@jumboinc.com,hugeisp.com If an organization has Industry Heuristics turned on, messages with industry content will still be quarantined if the sender or domain is in organization’s Blocked Senders list. The org-level sender lists are not visible to the user-level sender lists.
modifyorg sales, approved_senders= -jim@hugeisp.com 2. Using the modifyuser command, remove one user from the user-level Approved Senders list. modifyuser msmith@jumboinc.com, approved_senders= -jim@hugeisp.com 3. Using the modifyuser command, remove one user from the user-level Approved Recipients list. modifyuser msmith@jumboinc.com, approved_recipients= newupdates@hugeisp.com Remove One User from a Blocked Senders List 1.
Remove All Users from a Senders List Except for One User 1. Using the modifyorg command, replace the org-level Approved Senders list and the Blocked Senders list with one user. modifyorg msmith@jumboinc.com, approved_senders=jim@hugeisp.com modifyorg msmith@jumboinc.com, blocked_senders=jim@hugeisp.com 2. Using the modifyuser command, replace the user-level Approved Senders and Blocked Senders lists with one user. modifyuser msmith@jumboinc.com, approved_senders=mary@jumboinc.
Viewing Message Limit Policies Message limit policies are for the maximum size of attachments, the maximum number of messages per day, and for the total each user has received. • Setting a message limit is useful for protecting mail servers against malicious attacks, such as email bombs. All messages are counted against this limit, including legitimate and quarantined messages. The count is approximate, so it’s suggested only for values over 100.
The user-level message_limit field holds the maximum number of messages allowed per day for a specific user. message_limit 1000 This limit can also be set for individual users. Whichever limit is lower—the org limit or a user’s limit—applies for the user. If a user’s limit is blank and a value is set for the org, the org value applies to the user. For best practices, manage the message limits at the organizational level.
The default_message_limit field holds the maximum number of messages each registered user or alias in an organization can receive per day. Leave the default_message_limit field blank to impose no limit. All messages are counted against this limit, including legitimate and quarantined messages. The count is approximate, so it’s suggested only for values over 100. Edit User Message Limit Settings 1. Using the modifyuser command, edit the user’s message limit. modifyuser msmith@jumboinc.
To view this organizational hierarchy follow the steps outlined in the task example, “Message Center Settings and Password Examples” on page 536”. See the “Editing Your Mail Handling Policies (Non Account Bounce)” on page 562 task examples for more information. Note: This example uses the Administration Console batch command syntax. View the Bounce, Auto Create, and Content Manager Policies 1. Using the displayorg command, view the Non Account Bounce setting.
The async_bounce field enables the Connection Manager’s control for inbound traffic. This control is for email servers, such as Microsoft Exchange and qmail, that issue “unknown user” asynchronous bounce messages and require added security from the Message Security service. async_bounce on By enabling this field, the Message Security service will compare directory information with incoming recipients to measure erroneous delivery attempts. 5.
listprovusers Sales, subset BLOCKED, childorgs=1, sort=TS1:d The listprovusers command to list all or list a filtered list of your organization’s provisional users. The displayprovuser command to list the last time a provisional user has received an email. displayprovuser msmith@jumboinc.com These users are promoted to a regular user after being verified as associated with someone in your org by receiving 3 legitimate emails within a week. 3.
Static text in the Quarantine Summary, along with the default top text, will display in the chosen language. See “Language and Timezone” on page 569 for supported languages and character encodings, and the field values. Message Archiving Example Editing Message Archiving Settings These commands apply to Postini Message Archiving, an optional product, only used with Message Security installations. Contact your account representative for further information.
3. Using the archive_settings modify command, change the archive settings for an organization. archive_settings modify org=Jumbo ABC, archive_enable=on, mail_flow=on, journaling=on The archive_settings modify command edits the archives’ settings for an organization. Enables or disables archiving. The archive_enable field enables archiving to be on for an organization. The journaling field enables message archive journaling for an organization.
IM Security Example This example is applicable to the Google Message Security, Google Message Discovery, and Google Message Filtering products only. Viewing and Editing an Org’s IM Settings These commands apply to Postini IM Security, an optional product. The IM Security settings can be viewed and edited at the org-level and at the individual user-level. This example is for the org-level settings. Note: This example uses the Administration Console batch command syntax. 1.
listusers ALL, primaryqs=jim@jumboinc.com, targetOrg=100046262, childorgs=1, aliases=1 The return values are a comma separated list of aliases for jim@jumboinc.com 2. List all primary user addresses and associated aliases in an org hierarchy.
Appendix A Additional Reference Information Appendix A Language and Timezone The language for quarantine summary message can be set through the lang_locale field. See “lang_locale (for users)” on page 435 and “lang_locale (for orgs)” on page 350 for more information. Following are the available languages: Language Batch Code Character Encoding English en_us.utf8 English (U.S.) UTF-8 en_us.iso-8859-1 English (U.S.) ISO 8859-1 en_uk.utf8 English (U.K.) UTF-8 en_uk.iso-8859-1 English (U.K.
Language Batch Code Character Encoding Japanese ja_jp.utf8 Japanese UTF-8 ja_jp.euc-jp Japanese EUC-JP ja_jp.shift-jis Japanese SHIFT-JIS ko_kr .utf8 Korean UTF-8 ko_kr.euc-kr Korean EUC-KR nl.utf8 Dutch UTF-8 nl.iso-8859-1 Dutch ISO 8859-1 Polish pl.utf8 Polish UTF-8 Portuguese pt.utf8 Portuguese UTF-8 pt.iso-8859-1 Portuguese ISO 8859-1 Russian ru.utf8 Russian UTF-8 Chinese zh_cn.utf8 Chinese (Simplified) UTF-8 zh_cn.gb2312 Chinese (Simplified) GB2312 zh_tw.
Index A Attachment Manager Fields at_notify_on 312 bounce_fragments 323 qtine_redir_out_atq 383 B batch processing 15 command syntax 18 procedure 16 submitting commands 16 validation 16 when to use 15 Building a batch file Using a List batch command 19 Using Download Users/Settings 21 C CIDR format 212, 216, 218, 220, 222 Command Quick Reference Adding 92 Deleting 93 Displaying and Reporting 95 Domain Management 97 IM Security 98 IP Llocking 100 Listing 100 Message Archiving 101 Message Encryption 102 Modi
modifyorg 246, 563 modifyuser 249, 538, 541, 550 notification display 252 notification modify 256 org_im_settings display 261, 566 org_im_settings modify 263, 566 password force_update 265 password reset 267 password_policy display 269 password_policy update 271 promotprovuser 275, 562 resetuser 276, 553 setorgsubstripping 278 showallowedips 280 suspenduser 282 testfirewall 285 testmail 286 testmx 289 unblockprovuser 292, 562 user_im_settings add 293 user_im_settings delete 295 user_im_settings display 297
im_proto_enable 345 IM Security Tasks Viewing and Editing an Org’s IM Settings 566 IP Range Commands iplock add_delete 216 iplock add_range 212 iplock delete_range 218 iplock display 220 iplock set_disposition 222 showallowedips 280 L Languages and Timezones lang_locale (for orgs) 350 lang_locale (for users) 435 Reference 569 M Message Archiving Commands archive_settings display 148 archive_settings modify 150 Message Archiving Fields archive 308 archive_enable 309, 564 journaling 348, 564 mail_flow 352, 56
qtine_redir_ndr 382 qtine_redir_out_atq 383 qtine_redir_spam 386 qtine_redir_virus 387 quarantine_links 388, 564 quarsum_links 389, 564 remotecmd_secret 391 retention_months 392 spam_notify_on 393, 542, 543 standard_journal 394 support_contact 396, 542, 543 tagonly_spam 398 timezone 399 tls_notify_admin 400 tls_notify_on 402 virus_clean 403 virus_notify 404, 542, 543, 549 welcome_on 406, 542 zero_hour_notifiy_on 407 zero_hour_scan 409 Org Settings Tasks Adding Users and Domains to Sender Lists 555 Editing Y
S SmartCreate, See Provisional User Commands Spool Command displayspool 175 Spool Field Reference page syntax notations 521 Spool Field Syntax Quick Reference 78 Spool Fields auto_unspool 522 despool_max_connections 523 duration 524 org 525 quota 526 spool_delay 528 spool_mech 529 status 531 used_pct 532 used_size 533 T Testing Commands checklatency 153 checkroute 155 testfirewall 285 testmail 286 testmx 289 troubleshooting batch processing 26 U User Commands addalias 137 adduser 144 deletealias 157 deleteu
