Class Inx_Apiimpl_RemoteSession

Description

The Inx_Api_Session is the entry point to the API.

The Inx_Api_Session is the entry point to the API. The createRemoteSession method may be used in following way to create a remote session:

 Inx_Api_Session::setProperty( "http.proxyHost", "192.168.1.142" );
 Inx_Api_Session::setProperty( "http.proxyPort", "8080" );
 Inx_Api_Session::setProperty( "http.nonProxyHosts", "localhost|127.0.0.1" );
 Inx_Api_Session::setProperty( "http.proxyUser", "test" );
 Inx_Api_Session::setProperty( "http.proxyPassword", "test" );

 $s = null;

 try
 {
 	  $s = Inx_Api_Session::createRemoteSession( "http://localhost:80/inxmail", "apiuser", "password" );
 	  ...
    $s->close(); //close the session
 }
 catch( LoginException x )
 {
 	  ...
 }
<P/> The createLocalSession method may be used in following way to create a local session:
 $s = null;

 try
 {
 	  $s = Inx_Api_Session::createLocalSession( "apiuser", "password" );
 	  ...
    $s->close(); //close the session
 }
 catch( LoginException x )
 {
 	  ...
 }
<p/> <strong>Note:</strong> An Inx_Api_Session object <strong>must</strong> be closed once it is not needed anymore to prevent memory leaks and other potentially harmful side effects.

  • version: $Revision: 9729 $ $Date: 2008-01-18 17:31:31 +0200 (Pn, 18 Sau 2008) $ $Author: aurimas $
  • abstract:

Located in /Apiimpl/RemoteSession.php (line 3)

Inx_Api_Session
   |
   --Inx_Apiimpl_AbstractSession
      |
      --Inx_Apiimpl_RemoteSession
Variables
Methods

Inherited Methods

Inherited From Inx_Apiimpl_AbstractSession

Inx_Apiimpl_AbstractSession::close()
Inx_Apiimpl_AbstractSession::createCxt()
Inx_Apiimpl_AbstractSession::createRecipientContext()
Inx_Apiimpl_AbstractSession::createRemoteRef()
Inx_Apiimpl_AbstractSession::createTestRecipientContext()
Inx_Apiimpl_AbstractSession::fetchReleasedRemoteRefs()
Inx_Apiimpl_AbstractSession::getActionManager()
Inx_Apiimpl_AbstractSession::getApprovalManager()
Inx_Apiimpl_AbstractSession::getAttributeManager()
Inx_Apiimpl_AbstractSession::getBlacklistManager()
Inx_Apiimpl_AbstractSession::getBounceManager()
Inx_Apiimpl_AbstractSession::getConnectionUrl()
Inx_Apiimpl_AbstractSession::getDataAccess()
Inx_Apiimpl_AbstractSession::getDesignCollectionManager()
Inx_Apiimpl_AbstractSession::getFilterManager()
Inx_Apiimpl_AbstractSession::getGeneralMailingManager()
Inx_Apiimpl_AbstractSession::getInboxManager()
Inx_Apiimpl_AbstractSession::getIntProperty()
Inx_Apiimpl_AbstractSession::getListContextManager()
Inx_Apiimpl_AbstractSession::getMailingManager()
Inx_Apiimpl_AbstractSession::getMailingTemplateManager()
Inx_Apiimpl_AbstractSession::getPluginStore()
Inx_Apiimpl_AbstractSession::getReportEngine()
Inx_Apiimpl_AbstractSession::getResourceManager()
Inx_Apiimpl_AbstractSession::getSendingHistoryManager()
Inx_Apiimpl_AbstractSession::getServerTime()
Inx_Apiimpl_AbstractSession::getSplitTestMailingManager()
Inx_Apiimpl_AbstractSession::getSplitTestManager()
Inx_Apiimpl_AbstractSession::getSubscriptionManager()
Inx_Apiimpl_AbstractSession::getTemporaryMailSender()
Inx_Apiimpl_AbstractSession::getTextmoduleManager()
Inx_Apiimpl_AbstractSession::getTransformationManager()
Inx_Apiimpl_AbstractSession::getTriggerMailingManager()
Inx_Apiimpl_AbstractSession::getUserContext()
Inx_Apiimpl_AbstractSession::getUtilities()
Inx_Apiimpl_AbstractSession::getWebpageManager()
Inx_Apiimpl_AbstractSession::notify()
Inx_Apiimpl_AbstractSession::releaseRemoteRef()
Inx_Apiimpl_AbstractSession::sessionClosed()
Inx_Apiimpl_AbstractSession::sessionId()
Inx_Apiimpl_AbstractSession::_heartbeat()
Inx_Apiimpl_AbstractSession::_login()
Inx_Apiimpl_AbstractSession::_login2()
Inx_Apiimpl_AbstractSession::_login3()

Inherited From Inx_Api_Session

Inx_Api_Session::close()
Inx_Api_Session::createLocalSession()
Inx_Api_Session::createPluginSession()
Inx_Api_Session::createPluginSession2()
Inx_Api_Session::createRecipientContext()
Inx_Api_Session::createRemoteSession()
Inx_Api_Session::createTestRecipientContext()
Inx_Api_Session::getActionManager()
Inx_Api_Session::getApprovalManager()
Inx_Api_Session::getAttributeManager()
Inx_Api_Session::getBlacklistManager()
Inx_Api_Session::getBounceManager()
Inx_Api_Session::getConnectionUrl()
Inx_Api_Session::getDataAccess()
Inx_Api_Session::getDesignCollectionManager()
Inx_Api_Session::getFilterManager()
Inx_Api_Session::getGeneralMailingManager()
Inx_Api_Session::getInboxManager()
Inx_Api_Session::getListContextManager()
Inx_Api_Session::getMailingManager()
Inx_Api_Session::getMailingTemplateManager()
Inx_Api_Session::getPluginStore()
Inx_Api_Session::getProperty()
Inx_Api_Session::getReportEngine()
Inx_Api_Session::getResourceManager()
Inx_Api_Session::getSendingHistoryManager()
Inx_Api_Session::getServerTime()
Inx_Api_Session::getSplitTestMailingManager()
Inx_Api_Session::getSplitTestManager()
Inx_Api_Session::getSubscriptionManager()
Inx_Api_Session::getTemporaryMailSender()
Inx_Api_Session::getTextmoduleManager()
Inx_Api_Session::getTransformationManager()
Inx_Api_Session::getTriggerMailingManager()
Inx_Api_Session::getUserContext()
Inx_Api_Session::getUtilities()
Inx_Api_Session::getWebpageManager()
Inx_Api_Session::sessionId()
Inx_Api_Session::setProperty()

Documentation generated on Thu, 17 Sep 2015 14:27:29 +0200 by phpDocumentor 1.3.2