Class Inx_Apiimpl_AbstractSession

Description

Implements interfaces:

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/AbstractSession.php (line 3)

Inx_Api_Session
   |
   --Inx_Apiimpl_AbstractSession
Direct descendents
Class Description
Inx_Apiimpl_RemoteSession The Inx_Api_Session is the entry point to the API.
Inx_Apiimpl_SoapSession Created on 2007.
Variable Summary
Method Summary
void close ()
void createCxt ()
void createRemoteRef ( $sRemoteRefId)
the getDataAccess ()
void getIntProperty ( $sKey)
void getPluginStore ()
void getServerTime ()
void releaseRemoteRef ( $sRemoteRefId,  $blImmediate)
void sessionClosed ()
void sessionId ()
void _heartbeat ()
void _login ( $sUsername,  $sPassword, [ $blPwdEncrypted = false],  $sAppId)
void _login2 ( $sLoginToken,  $sAppId)
void _login3 ( $pluginSecretId,  $sUsername,  $sPassword, [ $blPwdEncrypted = false],  $sAppId)
Variables
static mixed $_aServiceDescriptors = array(
self::CORE2_SERVICE => 'http://core2.apiservice.xpro.inxmail.com',
self::RECIPIENT_SERVICE => 'http://recipient.apiservice.xpro.inxmail.com',
self::LIST_SERVICE => 'http://list.apiservice.xpro.inxmail.com',
self::MAILING7_SERVICE => 'http://mailing7.apiservice.xpro.inxmail.com',
self::TRIGGER_MAILING_SERVICE => 'http://triggermailing.apiservice.xpro.inxmail.com',
self::SENDING_SERVICE => 'http://sending.apiservcie.xpro.inxmail.com',
self::PROPERTY_SERVICE => 'http://property.apiservice.xpro.inxmail.com',
self::RESOURCE_SERVICE => 'http://resource.apiservice.xpro.inxmail.com',
self::BLACKLIST_SERVICE => 'http://blacklist.apiservice.xpro.inxmail.com',
self::FILTER_SERVICE => 'http://filter.apiservice.xpro.inxmail.com',
self::ACTION_SERVICE => 'http://action.apiservice.xpro.inxmail.com',
self::REPORTING_SERVICE => 'http://reporting.apiservice.xpro.inxmail.com',
self::TEXTMODULE_SERVICE => 'http://textmodule.apiservice.xpro.inxmail.com',
self::MAILING_TEMPLATE_SERVICE => 'http://mailingtemplate.apiservice.xpro.inxmail.com',
self::DESIGN_COLLECTION2_SERVICE => 'http://designtemplate2.apiservice.xpro.inxmail.com',
self::BOUNCE3_SERVICE => 'http://bounce3.apiservice.xpro.inxmail.com',
self::DATAACCESS3_SERVICE => 'http://dataaccess3.apiservice.xpro.inxmail.com',
self::APPROVER_SERVICE => 'http://approver.apiservice.xpro.inxmail.com',
self::TESTRECIPIENT_SERVICE => 'http://testrecipient.apiservice.xpro.inxmail.com',
self::UNSUBSCRIBER_SERVICE => 'http://unsubscriber.apiservice.xpro.inxmail.com',
self::PLUGIN_SERVICE => 'http://plugin.apiservice.xpro.inxmail.com',
self::INBOX_SERVICE => 'http://inbox.apiservice.xpro.inxmail.com',
self::WEBPAGE2_SERVICE => 'http://webpage2.apiservice.xpro.inxmail.com',
self::GENERAL_MAILING_SERVICE => 'http://generalmailing.apiservice.xpro.inxmail.com',
self::TRANSFORMATION_SERVICE => 'http://transformation.apiservice.xpro.inxmail.com',
self::SPLIT_TEST_MAILING_SERVICE => 'http://splittestmailing.apiservice.xpro.inxmail.com',
self::SPLIT_TEST_SERVICE => 'http://splittest.apiservice.xpro.inxmail.com'
)
(line 45)
  • access: protected
mixed $_aPropertyMap = array() (line 11)
  • access: protected
mixed $_aReleasedRemoteRefs = array() (line 32)
  • access: protected
mixed $_aServiceMap = array() (line 7)
  • access: protected
mixed $_blSessionClosed = false (line 6)
  • access: protected
mixed $_maxReleasedRefs = null (line 33)
  • access: protected
mixed $_oActionManager = null (line 25)
  • access: protected
mixed $_oAttributeManager = null (line 14)
  • access: protected
mixed $_oBlacklistManager = null (line 22)
  • access: protected
mixed $_oBounceManager = null (line 23)
  • access: protected
mixed $_oFilterManager = null (line 24)
  • access: protected
mixed $_oGeneralMailingManager = null (line 15)
  • access: protected
mixed $_oInboxManager = null (line 27)
  • access: protected
mixed $_oListManager = null (line 13)
  • access: protected
mixed $_oMailingManager = null (line 16)
  • access: protected
mixed $_oReportEngine = null (line 21)
  • access: protected
mixed $_oResourceManager = null (line 20)
  • access: protected
mixed $_oSendingHistoryManager = null (line 18)
  • access: protected
mixed $_oSplitTestMailingManager = null (line 29)
  • access: protected
mixed $_oSplitTestManager = null (line 30)
  • access: protected
mixed $_oSubscriptionManager = null (line 19)
  • access: protected
mixed $_oTransformationManager = null (line 28)
  • access: protected
mixed $_oTriggerMailingManager = null (line 17)
  • access: protected
mixed $_oUserContext = null (line 26)
  • access: protected
mixed $_sApplicationUrl = null (line 8)
  • access: protected
mixed $_sConnectionUrl = null (line 9)
  • access: protected

Inherited Variables

Inherited from Inx_Api_Session

Inx_Api_Session::$_aProperties
Methods
close (line 551)

Closes this session and releases any resources associated with the session. is also automatically closed when it is garbage collected.

Closes this session and releases any resources associated with the session. A

  1. Session
object is also automatically closed when it is garbage collected.

  • since: API 1.0
  • access: public
void close ()

Redefinition of:
Inx_Api_Session::close()
Closes this session and releases any resources associated with the session.
createCxt (line 183)
  • access: public
void createCxt ()

Implementation of:
Inx_Apiimpl_SessionContext::createCxt()
createRecipientContext (line 213)

Create a new

.

Create a new

.

Inx_Api_Recipient_RecipientContext createRecipientContext ()

Redefinition of:
Inx_Api_Session::createRecipientContext()
Creates a new Inx_Api_Recipient_RecipientContext that can be used to access and manipulate recipient data.
createRemoteRef (line 196)
  • access: public
void createRemoteRef ( $sRemoteRefId)
  • $sRemoteRefId

Implementation of:
Inx_Apiimpl_SessionContext::createRemoteRef()
createTestRecipientContext (line 517)
  • access: public
void createTestRecipientContext ()

Redefinition of:
Inx_Api_Session::createTestRecipientContext()
Creates a new
  1. Inx_Api_Testprofiles_TestRecipientContext
that can be used to access and manipulate test recipient data.
fetchReleasedRemoteRefs (line 592)
  • access: public
void fetchReleasedRemoteRefs ()
getActionManager (line 335)

Returns the

  1. ActionManager
object that will used to manage actions.

Returns the

  1. ActionManager
object that will used to manage actions.

  • return: action manager
  • since: API 1.2.0
  • access: public
the getActionManager ()

Redefinition of:
Inx_Api_Session::getActionManager()
Returns the Inx_Api_Action_ActionManager object that will be used to manage actions.
getApprovalManager (line 511)
  • access: public
void getApprovalManager ()

Redefinition of:
Inx_Api_Session::getApprovalManager()
Returns the Inx_Api_Approval_ApprovalManager object that will be used to manage approvers.
getAttributeManager (line 249)

Returns the

object that will used to manage attributes.

Returns the

object that will used to manage attributes.

  • return: the attribute manager
  • since: API 1.0
  • access: public
Inx_Api_Recipient_AttributeManager getAttributeManager ()

Redefinition of:
Inx_Api_Session::getAttributeManager()
Returns the Inx_Api_Recipient_AttributeManager object that will be used to manage attributes (recipient columns).
getBlacklistManager (line 364)

Returns the

  1. BlacklistManager
object that will used to manage blacklist entries.

Returns the

  1. BlacklistManager
object that will used to manage blacklist entries.

  • return: the blacklist manager
  • since: API 1.1.0
  • access: public
Inx_Api_Blacklist_BlacklistManager getBlacklistManager ()

Redefinition of:
Inx_Api_Session::getBlacklistManager()
Returns the Inx_Api_Blacklist_BlacklistManager object that will be used to manage blacklist entries.
getBounceManager (line 378)

Returns the

  1. BounceManager
object that will used to get bounce mails.

Returns the

  1. BounceManager
object that will used to get bounce mails.

  • return: the bounce manager
  • since: API 1.4.3
  • access: public
Inx_Api_Bounce_BounceManager getBounceManager ()

Redefinition of:
Inx_Api_Session::getBounceManager()
Returns the Inx_Api_Bounce_BounceManager object that will be used to retrieve bounce notifications.
getConnectionUrl (line 534)
  • access: public
void getConnectionUrl ()

Redefinition of:
Inx_Api_Session::getConnectionUrl()
Returns the URL of the peer of this session, which is the URL of the Inxmail Professional server.
getDataAccess (line 506)

Returns the

  1. DataAccess
object that will used to get click and link data.

Returns the

  1. DataAccess
object that will used to get click and link data.

  • return: user context
  • since: API 1.4
  • access: public
the getDataAccess ()

Redefinition of:
Inx_Api_Session::getDataAccess()
Returns the Inx_Api_DataAccess_DataAccess object that will be used to get click and link data.
getDesignCollectionManager (line 427)

Returns the

object that will used to manage design collections.

Returns the

object that will used to manage design collections.

  • return: design collection manager
  • since: API 1.4.0
  • access: public
the getDesignCollectionManager ()

Redefinition of:
Inx_Api_Session::getDesignCollectionManager()
Returns the Inx_Api_DesignTemplate_DesignCollectionManager object that will be used to import design collections.
getFilterManager (line 391)

Returns the

  1. FilterManager
object that will used to manage filters.

Returns the

  1. FilterManager
object that will used to manage filters.

  • return: the filter manager
  • since: API 1.1.0
  • access: public

Redefinition of:
Inx_Api_Session::getFilterManager()
Returns the Inx_Api_Filter_FilterManager object that will be used to manage filters.
getGeneralMailingManager (line 264)

Returns the

object that will be used to access mailings regardless of their type.

Returns the

object that will be used to access mailings regardless of their type.

  • return: the general mailing manager
  • since: API 1.11.10
  • access: public

Redefinition of:
Inx_Api_Session::getGeneralMailingManager()
Returns the Inx_Api_GeneralMailing_GeneralMailingManager object that will be used to access mailings regardless of their type.
getInboxManager (line 492)

Returns the InboxManager object that will be used to retrieve inbox messages.

Returns the InboxManager object that will be used to retrieve inbox messages.

  • return: the inbox manager
  • since: API 1.9.0
  • access: public
Inx_Api_Inbox_InboxManager getInboxManager ()

Redefinition of:
Inx_Api_Session::getInboxManager()
Returns the Inx_Api_Inbox_InboxManager object that will be used to retrieve inbox messages.
getIntProperty (line 202)
  • access: public
void getIntProperty ( $sKey)
  • $sKey

Implementation of:
Inx_Apiimpl_SessionContext::getIntProperty()
getListContextManager (line 234)

Returns the

object that will used to manage lists.

Returns the

object that will used to manage lists.

  • return: the list manager
  • since: API 1.0
  • access: public
Inx_Api_List_ListContextManager getListContextManager ()

Redefinition of:
Inx_Api_Session::getListContextManager()
Returns the Inx_Api_List_ListContextManager object that will be used to manage lists.
getMailingManager (line 278)

Returns the

object that will be used to manage mailings and creating mail views.

Returns the

object that will be used to manage mailings and creating mail views.

  • return: the mailing manager
  • since: API 1.0
  • access: public

Redefinition of:
Inx_Api_Session::getMailingManager()
Returns the Inx_Api_Mailing_MailingManager object that will be used to manage mailings and produce the mailing output (HTML and/or plain text) for a single recipient.
getMailingTemplateManager (line 416)

Returns the

  1. Inx_Apiimpl_MailingTemplate_MailingTemplateManager
object that will used to manage mailing templates.

Returns the

  1. Inx_Apiimpl_MailingTemplate_MailingTemplateManager
object that will used to manage mailing templates.

  • return: the template manager
  • since: API 1.4.0
  • access: public

Redefinition of:
Inx_Api_Session::getMailingTemplateManager()
Returns the Inx_Api_MailingTemplate_MailingTemplateManager object that will be used to manage mailing templates.
getPluginStore (line 539)
  • access: public
void getPluginStore ()

Redefinition of:
Inx_Api_Session::getPluginStore()
Returns the
  1. PluginStore
object that will be used to manage stored informations.
getReportEngine (line 349)

Returns the

  1. ReportEngine
object that will used to generate reports.

Returns the

  1. ReportEngine
object that will used to generate reports.

  • return: the report engine
  • since: API 1.3.0
  • access: public
Inx_Api_Reporting_ReportEngine getReportEngine ()

Redefinition of:
Inx_Api_Session::getReportEngine()
Returns the Inx_Api_Reporting_ReportEngine object that will be used to generate reports.
getResourceManager (line 649)

Returns the

object that will used to manage resources.

Returns the

object that will used to manage resources.

  • return: the resource manager
  • since: API 1.0
  • access: public
Inx_Api_Resource_ResourceManager getResourceManager ()

Redefinition of:
Inx_Api_Session::getResourceManager()
Returns the Inx_Api_Resource_ResourceManager object that will be used to manage resources like attachments and embedded images stored on the server.
getSendingHistoryManager (line 306)

Returns the Inx_Api_Sending_SendingHistoryManager object that will be used to retrieve sending information.

Returns the Inx_Api_Sending_SendingHistoryManager object that will be used to retrieve sending information.

  • return: the sending history manager.
  • since: API 1.11.1
  • access: public
Inx_Api_Sending_SendingHistoryManager getSendingHistoryManager ()

Redefinition of:
Inx_Api_Session::getSendingHistoryManager()
Returns the Inx_Api_Sending_SendingHistoryManager object that will be used to retrieve sending information.
getServerTime (line 570)
  • access: public
void getServerTime ()

Redefinition of:
Inx_Api_Session::getServerTime()
Returns the server time as Inx_Api_ServerTime object.
getSplitTestMailingManager (line 663)
  • access: public
void getSplitTestMailingManager ()

Redefinition of:
Inx_Api_Session::getSplitTestMailingManager()
Return the Inx_Api_SplitTestMailing_SplitTestMailingManager object that gives read only access to all split test mailings in the system.
getSplitTestManager (line 670)
  • access: public
void getSplitTestManager ()

Redefinition of:
Inx_Api_Session::getSplitTestManager()
Return the Inx_Api_SplitTest_SplitTestManager object that gives read only access to all split tests in the system.
getSubscriptionManager (line 321)

Returns the

  1. SubscriptionManager
object that will used to subscribe an unsubscribe recipients.

Returns the

  1. SubscriptionManager
object that will used to subscribe an unsubscribe recipients.

  • return: subscription manager
  • since: API 1.0
  • access: public
the getSubscriptionManager ()

Redefinition of:
Inx_Api_Session::getSubscriptionManager()
Returns the Inx_Api_Subscription_SubscriptionManager object that will be used to subscribe and unsubscribe recipients.
getTemporaryMailSender (line 438)

Returns the

  1. getTemporaryMailSender
object that will used to send temporary mails.

Returns the

object that will used to send temporary mails.

  • return: mail sender
  • since: API 1.0
  • access: public
the getTemporaryMailSender ()

Redefinition of:
Inx_Api_Session::getTemporaryMailSender()
Returns the Inx_Api_Util_TemporaryMailSender object that will be used to send temporary mails.
getTextmoduleManager (line 405)

Returns the

  1. TextmoduleManager
object that will used to manage textmodules.

Returns the

  1. TextmoduleManager
object that will used to manage textmodules.

  • return: textmodule manager
  • since: API 1.4.0
  • access: public
the getTextmoduleManager ()

Redefinition of:
Inx_Api_Session::getTextmoduleManager()
Returns the Inx_Api_TextModule_TextModuleManager object that will be used to manage text modules.
getTransformationManager (line 656)
  • access: public
void getTransformationManager ()

Redefinition of:
Inx_Api_Session::getTransformationManager()
Returns the Inx_Api_Transformation_TransformationManager object that will be used to manage transformations.
getTriggerMailingManager (line 292)

Returns the Inx_Api_TriggerMailing_TriggerMailingManager object that will be used to manage trigger mailings and produce the trigger mailing output (HTML and/or plain test) for a single recipient.

Returns the Inx_Api_TriggerMailing_TriggerMailingManager object that will be used to manage trigger mailings and produce the trigger mailing output (HTML and/or plain test) for a single recipient.

  • return: the trigger mailing manager.
  • since: API 1.10.0
  • access: public
Inx_Api_TriggerMailing_TriggerMailingManager getTriggerMailingManager ()

Redefinition of:
Inx_Api_Session::getTriggerMailingManager()
Returns the Inx_Api_TriggerMailing_TriggerMailingManager object that will be used to manage trigger mailings and produce the trigger mailing output (HTML and/or plain test) for a single recipient.
getUserContext (line 477)

Returns the

  1. UserContext
object associated with this
  1. Session
object.

Returns the

  1. UserContext
object associated with this
  1. Session
object.

  • return: user context
  • since: API 1.0
  • access: public
the getUserContext ()

Redefinition of:
Inx_Api_Session::getUserContext()
Returns the Inx_Api_UserContext object associated with this
  1. Session
object.
getUtilities (line 453)

Returns the

object that can be used for special activities.

Returns the

object that can be used for special activities.

  • return: the utilities
  • since: API 1.1.0
  • access: public
Inx_Api_Util_Utilities getUtilities ()

Redefinition of:
Inx_Api_Session::getUtilities()
Returns the Inx_Api_Util_Utilities object that can be used for special activities like the tell a friend feature.
getWebpageManager (line 466)

Returns the Inx_Api_Webpage_WebpageManager used to access data of web pages (HTML files and JSPs) like type and URL.

Returns the Inx_Api_Webpage_WebpageManager used to access data of web pages (HTML files and JSPs) like type and URL.

  • return: the web page manager.
  • since: API 1.9.0
  • access: public
Inx_Api_Webpage_WebpageManager getWebpageManager ()

Redefinition of:
Inx_Api_Session::getWebpageManager()
Returns the Inx_Api_Webpage_WebpageManager used to access data of web pages (HTML files and JSPs) like type and URL.
notify (line 78)
  • access: public
void notify (Inx_Api_RemoteException $e)

Implementation of:
Inx_Apiimpl_SessionContext::notify()
releaseRemoteRef (line 606)
  • access: public
void releaseRemoteRef ( $sRemoteRefId,  $blImmediate)
  • $sRemoteRefId
  • $blImmediate
sessionClosed (line 587)
  • access: public
void sessionClosed ()
sessionId (line 35)
  • access: public
void sessionId ()

Redefinition of:
Inx_Api_Session::sessionId()
Returns the unique id of this session.
_heartbeat (line 621)
  • access: public
void _heartbeat ()
_login (line 110)
  • access: protected
void _login ( $sUsername,  $sPassword, [ $blPwdEncrypted = false],  $sAppId)
  • $sUsername
  • $sPassword
  • $blPwdEncrypted
  • $sAppId
_login2 (line 137)
  • access: protected
void _login2 ( $sLoginToken,  $sAppId)
  • $sLoginToken
  • $sAppId
_login3 (line 156)
  • access: protected
void _login3 ( $pluginSecretId,  $sUsername,  $sPassword, [ $blPwdEncrypted = false],  $sAppId)
  • $pluginSecretId
  • $sUsername
  • $sPassword
  • $blPwdEncrypted
  • $sAppId

Inherited Methods

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:19 +0200 by phpDocumentor 1.3.2