mailproc-stopmailproc-stop
Stop a mailprocessor in a MailTransport
Home > Books > NetKernel API and Services Reference > Accessor Listing > SMTP Email Service > mailproc-stop

Rate this page:
Really useful
Satisfactory
Not helpful
Confusing
Incorrect
Unsure
Extra comments:


Module

urn:org:ten60:netkernel:mod:smtp

The mailproc-stop 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-stop

ArgumentRulesDescription
idMandatory A URI to use to identify the mailprocessor

Example Usage

DPML

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

NetKernel Foundation API

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

Purpose

The mailproc-stop accessor stops the identified mailprocessor in a MailTransport.

A mailprocessor which has been stopped will cease to poll a mailbox for new messages but remains in the MailTransport and may be restarted with mailproc-start.

The MailTransport which receives the notification to stop the named mailprocessor 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.

© 2003-2007, 1060 Research Limited. 1060 registered trademark, NetKernel trademark of 1060 Research Limited.