---

Class ::nsmcp::SmtpLogTool

::nsmcp::SmtpLogTool create ... \
           [ -authorizer:required authorizer:required ] \
           [ -description (default "Read recent nssmtpd sendlog or eventlog records from the current server's configured SMTP module. Defaults to eventlog, the last 60 minutes, and at most 20 newest matching records. Reads at most 1 MiB from the current file; does not scan rotated files or certify full-window coverage when earlier bytes remain unread. Reports malformed, oversized and unfinished lines separately. Filters use exact event/session/status matches; contains is a literal substring in the redacted record. Returns SMTP envelope addresses and diagnostic metadata, never message bodies. Peer addresses are masked unless includePeerAddresses is true and diagnostics.logs.peers.read is granted. Event records belonging to another virtual server are excluded; sendlog has no per-record server field, so its scope is the configured source. Does not send mail or change SMTP settings.") ] \
           [ -inputSchema (default "{} object {type string object properties object {
        log object {type string string enum array {0 string event 1 string send} default string event}
        module object {type string string default string nssmtpd description string {Configured nssmtpd module name in the current virtual server.}}
        lastMinutes object {type string integer minimum number 1 maximum number 1440 default number 60}
        limit object {type string integer minimum number 1 maximum number 100 default number 20}
        session object {type string string description string {Exact eventlog session identifier; not available in sendlog.}}
        event object {type string string description string {Exact eventlog event name.}}
        status object {type string string description string {Exact SMTP status code, for example 451 or 550.}}
        contains object {type string string description string {Literal substring in the redacted record.}}
        includePeerAddresses object {type string boolean default boolean false}
    } additionalProperties boolean false}") ] \
           [ -maxLineBytes:integer (default "16384") ] \
           [ -maxReadBytes:integer (default "1048576") ] \
           [ -name (default "smtp_logs") ] \
           [ -outputSchema (default "") ] \
           [ -peerRedactor:required peerRedactor:required ] \
           [ -permission (default "diagnostics.logs.read") ] \
           [ -redactor:required redactor:required ]

Defined in /usr/local/ns/tcl/nsmcp/lib/smtp-tools.tcl

Class Relations

• class: ::nx::Class
• superclass: ::nsmcp::Tool

---