SP Update SMTP Subscriber Subcommand

access: Administrators, Managers

Updates information for an existing SMTP subscriber.

sp update smtp subscriber
{-n | --name} NAME {-r | --recipients} ADDRESS LIST

Arguments Description
{-n | --name}

Specifies the name of the SMTP subscriber to update. This argument is repeatable to update multiple SMTP subscribers at one time.

{-r | --recipients} Specifies the address list of recipients for the SMTP subscriber.

Note: All options replace the existing values with the new value. Unspecified options leave existing settings as they are. For example, if you only specify the -r option for an existing subscriber, the existing e-mail address list is replaced with the new list specified in the command.

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_Warn_Short Short email message, warning severity
SMTP_Warn_Long Long email message, warning severity
SMTP_Crit_Short Short email message, critical severity
SMTP_Crit_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.
NWSE_NoPermission 6 Not authorized to perform this operation.

Related Topics

System Management Commands

SP Command