access: All users
Returns detailed information about one or all SMTP subscribers:
sp get smtp subscribers [{-n | --name} <NAME>] [-H | noheader] [{-D | --delim <DELIMITER>}]
| Argument | Description |
|---|---|
| { -n | --namserver } | Specifies the name of the smtp subscriber for which to retrieve information. If you do not specify this option, the command returns information for all subscribers. |
| { -H | --noheader } | Suppresses column headings. |
| { -D | --delim } | Delimits columns with the specified delimiter. Headings are also delimited unless suppressed. The delimiter can be any character or string. |
Following are the default SMTP subscribers:
| Subscriber | Description |
|---|---|
| SMTP_Info_Short |
Short email message, informational severity |
| SMTP_Info_Long | Long email message, informational severity |
| SMTP_Warning_Short | Short email message, warning severity |
| SMTP_Warning_Long | Long email message, warning severity |
| SMTP_Critical_Short | Short email message, critical severity |
| SMTP_Critical_Long | Long email message, critical severity |
Long e-mail messages contain full event details in the message body while short e-mail messages contain no message body and a descriptive subject line (the same subject as used for long messages). The short format is intended to be used with pagers and other wireless access devices with which message size constraints may prevent reception of the long format message.
Return Codes
Following are the return values for this command:
| Code | Numeric Code | Description |
|---|---|---|
| NWSE_Success | 0 | Command successfully completed. |
| NWSE_InvalidUsage | 1 | Invalid usage: bad parameter usage, conflicting options specified. |
| NWSE_RPCTimeout | 2 | Request was issued, but was not serviced by the server. RPC procedure timed out and the request may or may not have been serviced by the server. |
| NWSE_RPCNotConnected | 3 | Unable to connect to the RPC server. |
| NWSE_NotFound | 5 | The subscriber name was not found. |