|
Command
|
Description
|
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 Quarantine as the user's primary email address. Syntax and example: addalias <user address>, <alias> , [ confirm ] addalias msmith@example.com, mary@example.com, confirm |
addallowedip |
The addallowedip command limits emails from a domain to the assigned IP range for all users in the specified organization and suborganizations. Syntax and example: addallowedip <org name>, <domain name:netblock> addallowedip sales, example.com:648.23.0.0/16 |
adddomain |
The adddomain command adds a domain to your organization hierarchy. Syntax and example: adddomain <org name | iid>, domain=<domain name> adddomain "Jumbo's Western Region", domain=example.com |
addorg |
The addorg command adds a sub-organization to your organizational hierarchy. Syntax and example: addorg <org name>, parent=<parent org> [, <field>=<value>, ...] addorg "Jumbo's Org", parent="Jumbo,San Carlos", autocreate_smtp=on |
adduser |
The adduser command adds users to the Email Control service. Syntax and example: adduser <user address> [, <field>=<value>, ...], [org=<org name>], [welcome=<1 | 0>] adduser jim@example.com, approved_senders=+hugeisp.com, welcome=1 |
blockprovuser |
The blockprovuser command sets a provisional user as permanently blocked from being added to the email protection service. This occurs when using SmartCreate mail handling policy. Syntax and example: blockprovuser <user address> blockprovuser john@example.com |
checklatency |
The checklatency command measures the connection delay between the email data center and your email server. This is the Latency Test. Syntax and example: checklatency <email config org>, mailhost=<mail server> checklatency sales email config, mailhost=my.mailserver.com |
checkroute |
The checkroute command, or Traceroute Test, traces the network route from the server to the input mail server. Syntax and example: checkroute <email config org>, mailhost=<mail server | IP address> checkroute salesemailconfig, mailhost=mailserver.example.com |
clearallowedips |
The clearallowedips command removes all IP limitations configured in an organization. Syntax and example: clearallowedips <org name> clearallowedips MyOrg |
deletealias |
The deletealias command removes a user's alias completely from the Email Control service. Syntax and example: deletealias <alias> deletealias myalias@example.com |
deleteallowedip |
The deleteallowedip command removes all netblocks configured in the organization. Syntax and example: deleteallowedip <org name>,<domain name:netblock> deleteallowedip sales, example.com:648.23.0.0/16 |
deletedomain |
The deletedomain command removes the domain from your organizational hierarchy. Syntax and example: deletedomain <domain name | domain id> deletedomain example.com |
deletedomainalias |
The deletedomainalias, a ScanSafe Web Services operation, is a wrapper around the modifydomain batch command. It deletes the domain aliases. Syntax and C# example: deletedomainalias <authentication credentials, domain name, alias> ... String domainAlias = <domain alias entered by user>; aliasRecord.alias = "-" + domainAlias; ... |
deleteorg |
The deleteorg command removes an organization from the Email Control service. Syntax and example: deleteorg <org name | iid> deleteorg "Jumbo's Western Region" |
deleteprovuser |
The deleteprovuser command removes a provisional user that is known to be illegitimate. Syntax and example: deleteprovuser <user address> deleteprovuser john@example.com |
deleteuser |
The deleteuser command removes users from the Email Control service. Syntax and example: deleteuser <user address> | user_id> , confirm deleteuser msmith@example.com, confirm |
displaydomain |
The displaydomain command displays all of the selected domain's settings information. Syntax and example: displaydomain <domain name | domain id> displaydomain example.com |
displayorg |
The displayorg command displays all the selected organization's settings information. Syntax and example: displayorg <org name | org's iid> displayorg "Jumbo's Western Region" |
displayprovuser |
The displayprovuser command shows the active list of provisional users. Syntax and example: displayprovuser <email address> displayprovuser john@example.com |
displayspool |
The displayspool command shows the Spool Manager settings for your email config organization. Syntax and example: displayspool <email config org> displayspool jumboemailconfig |
displayuser |
The displayuser command shows all the user's settings information. Syntax and example: displayuser <user address | u_id> displayuser msmith@example.com |
domain_tls add |
The domain_tls 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. Note: Encryption Manager Policy Enforced TLS is a optional product. Syntax and example: domain_tls add org=<email config orgtag | ID>, hop=<ib_sender | ob_recipient>, domain=<domain name> domain_tls add org=<Salesemailconfig, hop=ib_sender, domain=example.com |
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. Note: Encryption Manager Policy Enforced TLS is a optional product. Syntax and example: domain_tls delete org=<email config orgtag | ID>, hop=<ib_sender | ob_recipient>, domain=<domain name> domain_tls delete org=<Salesemailconfig, hop=ib_sender, domain=example.com |
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. Note: Encryption Manager Policy Enforced TLS is a optional product. Syntax and example: domain_tls display org=<email config orgtag | ID>, hop=<ib_sender | ob_recipient> domain_tls display org=<Salesemailconfig, hop=ib_sender |
encryption display_org |
The encryption display_org command displays an organization's encryption information. Syntax and example: encryption display_org, orgtag=<org name> encryption display_org, orgtag=Sales |
encryption display_user |
The encryption display_user command displays user specific encryption information. Syntax and example: encryption display_user, address=<user address> encryption display_user, address=msmith@example.com |
encryption list_users |
The encryption list_users command lists all encryption users in this organization. Syntax and example: encryption list_users, orgtag=<org name>, <ext_encrypt=<on | off | match> encryption list_users, orgtag=Sales, ext_encrypt=on |
encryption modify_org |
The encryption list_users command lists all encryption users in this organization. Syntax and example: encryption modify_org, orgtag=<org name>, service=<on | off |match> [,cascade=1] encryption modify_org, orgtag=Sales, service=on |
encryption modify_user |
The encryption modify_user command modifies encryption settings for a user. Syntax and example: encryption modify_user, address=<user address>, service=<on | off |match> encryption modify_user, address=msmith@example.com, service=on |
getorgreport |
The getorgreport command builds a traffic, virus, spam, or usage report for a selected organization. Syntax and example: getorgreport <org name>, report=<report type>, date=<date>, [top=<integer>] 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. Syntax and example: help <command> help displayorg |
listdomains |
The listdomains command returns a list of domains in an organization. The list can be all domains or it can be sorted and filtered. Syntax and example: listdomains <domain name qstring | ALL> , targetOrg=<org name> [,orgtaggs=<orgtag qstring> ] [, primaryqs=<primary domain qstring> ] [,aliases=<0 | 1> ] [,childorgs=<0 | 1> ] [,sort=<sortspec> ] [,fields=<fieldlist> ] [,start=<startindex> ] [,end=<endindex> ] 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. Syntax and example: listorgs <orgtag gstring | ALL> , targetOrg=<org name> [ , childorgs=<0|1> ] [ , sort=<sortspec> ] [ , fields=<fieldlist> ] [ , start=<starindex> ] [ , end=<endindex> ] listorgs ALL, targetOrg=sales, sort=IID:nd |
listprovusers |
The listprovusers command returns a list of provisional users. The list can be all provisional users or it can be sorted and filtered. Syntax and example: listprovusers <org name> [, subset=ALL | BLOCK | UNBLOCK] [, addressqs=<match spec>] [, childorgs=0 | 1] [, sort=<sortspec> ] [, fields=<fieldlist> ] [, start=<startindex> ] [, end=<endindex> ] 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. Syntax and example: listusers <user address qstring | `ALL' , targetOrg=<org name> [, orgtagqs=<orgtag qstring>] [, primaryqs=<primary address qstring>] [, aliases=<0 | 1>] [, childorgs=<0 | 1>] [, sort=<sortspec>] [, fields=<fieldlist>] [, start=<startindex>] [, end=<endindex>] [, type_of_user=<im | all>] listusers ALL, targetOrg=sales, sort=ADDRESS:a |
modifydomain |
The modifydomain command can move a domain, set subdomain stripping, and modify domain aliases. Syntax and example: modifydomain <domain name>, [neworg=<org name> | substrip=<yes | no> | alias=<alias name| -alias name>] modifydomain example.com, substrip=no |
modifyorg |
The modifyorg command modifies an organization's settings. Syntax and example: modifyorg <org name> [,field=<value>, ...] modifyorg sales, im_enable=on |
modifyuser |
The modifyuser command modifies a user's settings. Syntax and example: modifyuser <user address> [, <field>=<value>, ...] modifyuser msmith@example.com, junkmail_filter=0 |
password force_update |
The password force_update command forces a user or all users in an organization to change their passwords the next time the user logs into the system. This command is used with an organization using the PMP password policy configuration. Syntax and examples: password force_update user=<user address> password force_update org=<org name> [, cascade= <yes | no>] password force_update user=msmith@example.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 password policy configuration. Syntax and examples: password reset user=<user address> [, password=<text>] [, notify=<yes | no>] password reset user=msmith@example.com password reset user=msmith@example.com, password=a8f2KTT*#, notify=yes |
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. Syntax and example: password_policy display org=<org name> password_policy display org=Sales |
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. Syntax and example: password_policy update org=<org name> [, min_length=<1 - 10>] [, required_complexity=<no | yes | null>] [, 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 >] [, cascade= <no | yes | null>] password_policy update org=Sales, min_length=6, required_complexity=yes, lockout_period=60 |
promoteprovuser |
The promoteprovuser command adds a provisional user to the Email Control service and removes the provisional user record. This command is used with SmartCreate. Syntax and example: promoteprovuser <user address> promoteprovuser provuser@example.com |
resetuser |
The resetuser command resets a suspended user to the settings of the organization's Default User. Syntax and example: resetuser <user address> resetuser msmith@example.com |
setorgsubstripping |
The setorgsubstripping command enables domain substripping for all domains in an organization. Syntax and example: setorgsubstripping <org name | iid>,<on/1 | off/0> setorgsubstripping sales,1 |
showallowedips |
The showallowedips command lists all allowed sending IPs configured in an organization. Syntax and example: showallowedips <org name> showallowedips sales |
suspenduser |
The suspenduser command suspends a user by disabling all filtering and the user's access to the Message Center. Syntax and example: suspenduser <user address> [ , notify] [ , hardsuspend] [ , deliver] suspenduser msmith@example.com, hardsuspend suspenduser msmith@example.com, notify |
testfirewall |
The testfirewall command tests whether your firewall allows email traffic from IP addresses outside of the Email Control service IP range. Syntax and example: testfirewall <user address> testfirewall jumbomailserver@example.com |
testmail |
The testmail command verifies whether your email server can receive a message. This is the SMTP Message Test. Syntax and example: testmail <user address>, mailtype=<1 | 0> testmail msmith@example.com, mailtype=1 |
testmx |
The testmx command tests your MX records. This is the MX Record Test. Syntax and example: testmx <domain name> testmx mailserver.example.com |
unblockprovuser |
The unblockprovuser command unblocks provisional users who have been blocked from becoming regular users. Provisional users are created with SmartCreate. Syntax and example: unblockprovuser <user address> unblockprovuser msmith@example.com |
user_im_settings_display |
The user_im_settings display command displays IM settings for a given user email address. Syntax and example: user_im_settings display address=<user address> user_im_settings display address=msmith@example.com |
Feedback