mailproc-status

Home > Books > NetKernel API and Services Reference > Accessor Listing > SMTP Email Service > mailproc-status

Module

The mailproc-status accessor is exported by the urn:org:ten60:netkernel:mod:smtp module. Import this module to gain access to the accessor.

Syntax

URI

active:mailproc-status

Argument	Rules	Description
id	Mandatory	A URI to use to identify the mailprocessor

Example Usage

DPML

<instr>
  <type>mailproc-status</type>
  <id>urn:org:ten60:mail:mailprocessor:1</id>
</instr>

NetKernel Foundation API

req=context.createSubRequest("active:mailproc-status");
req.addArgument("id", [resource representation, aspect, or URI] );
result=context.issueSubRequest(req);

Purpose

The mailproc-status accessor retrieves the status of the identified mailprocessor from a MailTransport.

The MailTransport which receives the status request is located dynamically and is discovered from the first instance of ffcpl:/etc/MailTransportConfig.xml in the current module address space.

For more information on the operation of the MailTransport see the MailTransport guide.

Format

The status has the following format...

<mailProcessorStatus>
  <id>urn:org:ten60:mail:transport:1</id>
  <active>true</active>
  <processed>143</processed>
  <rejected>250</rejected>
  <mailProcessor>
      ...The current mailprocessor config for this mailprocessor - see mailproc-register...
    </mailProcessor>
</mailProcessorStatus>