Class Inx_Api_Session

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:
  • since: API 1.0

Located in /Api/Session.php (line 57)


	
			
Direct descendents
Class Description
Inx_Apiimpl_AbstractSession The Inx_Api_Session is the entry point to the API.
Variable Summary
static mixed $_aProperties
Method Summary
static void createLocalSession ()
static Inx_Api_Session createPluginSession (string $sApplicationUrl, string $sLoginToken)
static Inx_Api_Session createPluginSession2 (string $sApplicationUrl, string $pluginSecretId, string $username, string $password, bool $pwdEncrypted)
static Inx_Api_Session createRemoteSession (string $sApplicationUrl, string $sUsername, string $sPassword, [bool $blPwdEncrypted = false])
static string|int getProperty (string $sKey)
static void setProperty (string $sKey,  $mxValue, string|int $sValue)
void close ()
Inx_Api_Approval_ApprovalManager getApprovalManager ()
string getConnectionUrl ()
void getPluginStore ()
string sessionId ()
Variables
static mixed $_aProperties = array() (line 59)
  • access: protected
Methods
static method createLocalSession (line 172)

This feature is not available in the PHP API.

This feature is not available in the PHP API.

  • access: public
static void createLocalSession ()
static method createPluginSession (line 107)

Attempts to establish a session used for plug-ins.

Attempts to establish a session used for plug-ins.

  • return: a session to the given inxmail application.
  • throws: Inx_Api_ConnectException if the connection could not be established.
  • since: API 1.4.5
  • throws: Inx_Api_LoginException if the login failed.
  • access: public
static Inx_Api_Session createPluginSession (string $sApplicationUrl, string $sLoginToken)
  • string $sApplicationUrl: an application url of the form http://[host]:[port]/[webapps].
  • string $sLoginToken: the token used to login the plug-in.
static method createPluginSession2 (line 144)

Attempts to establish a session used for plug-ins.

Attempts to establish a session used for plug-ins.

  • return: a session to the given inxmail application.
  • throws: Inx_Api_ConnectException if the connection could not be established.
  • since: API 1.4.5
  • throws: Inx_Api_LoginException if the login failed.
  • access: public
static Inx_Api_Session createPluginSession2 (string $sApplicationUrl, string $pluginSecretId, string $username, string $password, bool $pwdEncrypted)
  • string $sApplicationUrl: an application url of the form http://[host]:[port]/[webapps].
  • string $pluginSecretId: the secret id of the Plugin.
  • string $username: the inxmail user on whose behalf the session is being created.
  • string $password: the user's password.
  • bool $pwdEncrypted: determines whether the password will be transfered in encrypted form.
static method createRemoteSession (line 73)

Attempts to establish a session to the given inxmail application.

Attempts to establish a session to the given inxmail application.

  • return: a session to the given inxmail application.
  • throws: Inx_Api_ConnectException if the connection could not be established.
  • since: API 1.0
  • throws: Inx_Api_LoginException if the login failed.
  • access: public
static Inx_Api_Session createRemoteSession (string $sApplicationUrl, string $sUsername, string $sPassword, [bool $blPwdEncrypted = false])
  • string $sApplicationUrl: an application url of the form http://[host]:[port]/[webapps].
  • string $sUsername: the inxmail user on whose behalf the session is being created.
  • string $sPassword: the user's password.
  • bool $blPwdEncrypted: determines whether the password will be transfered in encrypted form, may be omitted.
static method getProperty (line 522)

Returns the value of the session property specified by the given key.

Returns the value of the session property specified by the given key.

  • return: the property value.
  • access: public
static string|int getProperty (string $sKey)
  • string $sKey: the property name.
static method setProperty (line 503)

Sets the session property specified by the given key to the given value.

Sets the session property specified by the given key to the given value. This may be used to configure a proxy conenction.

  • access: public
static void setProperty (string $sKey,  $mxValue, string|int $sValue)
  • string $sKey: the property name. Possible values are:
    • http.proxyHost
    • http.proxyPort
    • http.proxyUser
    • http.proxyPassword
    • soap.connectionTimeout
  • string|int $sValue: the property value.
  • $mxValue
close (line 451)

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

Closes this session and releases any resources associated with the session. 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.

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

Redefined in descendants as:
createRecipientContext (line 185)

Creates a new Inx_Api_Recipient_RecipientContext that can be used to access and manipulate recipient data.

Creates a new Inx_Api_Recipient_RecipientContext that can be used to access and manipulate recipient data.

  • return: a new Inx_Api_Recipient_RecipientContext.
  • abstract:
  • since: API 1.0
  • access: public
Inx_Api_Recipient_RecipientContext createRecipientContext ()

Redefined in descendants as:
createTestRecipientContext (line 479)

Creates a new

  1. Inx_Api_Testprofiles_TestRecipientContext
that can be used to access and manipulate test recipient data.

Creates a new

  1. Inx_Api_Testprofiles_TestRecipientContext
that can be used to access and manipulate test recipient data. Test recipients are used to create a preview of a mailing.

  • return: new
    1. TestRecipientContext
    .
  • abstract:
  • since: API 1.6.0
  • access: public
a createTestRecipientContext ()

Redefined in descendants as:
getActionManager (line 273)

Returns the Inx_Api_Action_ActionManager object that will be used to manage actions.

Returns the Inx_Api_Action_ActionManager object that will be used to manage actions. An Inx_Api_Action_Action can manipulate or send a mail to a recipient for whom an event has occurred.

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

Redefined in descendants as:
getApprovalManager (line 406)

Returns the Inx_Api_Approval_ApprovalManager object that will be used to manage approvers.

Returns the Inx_Api_Approval_ApprovalManager object that will be used to manage approvers. An approver is responsible for approving mails before they can be sent.

  • return: the approval manager.
  • abstract:
  • since: API 1.6
  • access: public
Inx_Api_Approval_ApprovalManager getApprovalManager ()

Redefined in descendants as:
getAttributeManager (line 204)

Returns the Inx_Api_Recipient_AttributeManager object that will be used to manage attributes (recipient columns).

Returns the Inx_Api_Recipient_AttributeManager object that will be used to manage attributes (recipient columns).

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

Redefined in descendants as:
getBlacklistManager (line 291)

Returns the Inx_Api_Blacklist_BlacklistManager object that will be used to manage blacklist entries.

Returns the Inx_Api_Blacklist_BlacklistManager object that will be used to manage blacklist entries.

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

Redefined in descendants as:
getBounceManager (line 302)

Returns the Inx_Api_Bounce_BounceManager object that will be used to retrieve bounce notifications.

Returns the Inx_Api_Bounce_BounceManager object that will be used to retrieve bounce notifications. A bounce notification is a mail received by a mail server that indicates that a mailing could not be sent to a specific recipient (bounced). This may be due due to an unknown recipient at the destination mail server.

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

Redefined in descendants as:
getConnectionUrl (line 487)

Returns the URL of the peer of this session, which is the URL of the Inxmail Professional server.

Returns the URL of the peer of this session, which is the URL of the Inxmail Professional server.

  • return: the URL of the peer of this session.
  • abstract:
  • since: API 1.11.1
  • access: public
string getConnectionUrl ()

Redefined in descendants as:
getDataAccess (line 397)

Returns the Inx_Api_DataAccess_DataAccess object that will be used to get click and link data.

Returns the Inx_Api_DataAccess_DataAccess object that will be used to get click and link data.

  • return: the data access object.
  • abstract:
  • since: API 1.4
  • access: public

Redefined in descendants as:
getDesignCollectionManager (line 342)

Returns the Inx_Api_DesignTemplate_DesignCollectionManager object that will be used to import design collections.

Returns the Inx_Api_DesignTemplate_DesignCollectionManager object that will be used to import design collections. Design collections may contain multiple design templates which can be used to create complex multipart mailings.

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

Redefined in descendants as:
getFilterManager (line 312)

Returns the Inx_Api_Filter_FilterManager object that will be used to manage filters.

Returns the Inx_Api_Filter_FilterManager object that will be used to manage filters. A

  1. Filter
is used to define target groups of recipients that share a common property. For example: All recipients born after 1970.

  • return: the filter manager.
  • abstract:
  • since: API 1.1.0
  • access: public
Inx_Api_Filter_FilterManager getFilterManager ()

Redefined in descendants as:
getGeneralMailingManager (line 214)

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

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

  • return: the general mailing manager.
  • abstract:
  • since: API 1.11.10
  • access: public
Inx_Api_GeneralMailing_GeneralMailingManager getGeneralMailingManager ()

Redefined in descendants as:
getInboxManager (line 388)

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

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

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

Redefined in descendants as:
getListContextManager (line 194)

Returns the Inx_Api_List_ListContextManager object that will be used to manage lists.

Returns the Inx_Api_List_ListContextManager object that will be used to manage lists.

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

Redefined in descendants as:
getMailingManager (line 224)

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.

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.

  • return: the mailing manager.
  • abstract:
  • since: API 1.0
  • access: public
Inx_Api_Mailing_MailingManager getMailingManager ()

Redefined in descendants as:
getMailingTemplateManager (line 333)

Returns the Inx_Api_MailingTemplate_MailingTemplateManager object that will be used to manage mailing templates.

Returns the Inx_Api_MailingTemplate_MailingTemplateManager object that will be used to manage mailing templates. Mailing templates are reusable mailing contents that can be used as a basis for new mailings. These templates are far less powerful than the templates provided by design collections.

  • return: the template manager.
  • abstract:
  • since: API 1.4.0
  • access: public
Inx_Api_MailingTemplate_MailingTemplateManager getMailingTemplateManager ()

Redefined in descendants as:
getPluginStore (line 469)

Returns the

  1. PluginStore
object that will be used to manage stored informations.

Returns the

  1. PluginStore
object that will be used to manage stored informations. The
  1. PluginStore
is used as isolated storage for plug-ins. This is only useful for plug-in usage of the api.

  • abstract:
  • since: API 1.7.0
  • access: public
void getPluginStore ()

Redefined in descendants as:
getReportEngine (line 282)

Returns the Inx_Api_Reporting_ReportEngine object that will be used to generate reports.

Returns the Inx_Api_Reporting_ReportEngine object that will be used to generate reports.

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

Redefined in descendants as:
getResourceManager (line 263)

Returns the Inx_Api_Resource_ResourceManager object that will be used to manage resources like attachments and embedded images stored on the server.

Returns the Inx_Api_Resource_ResourceManager object that will be used to manage resources like attachments and embedded images stored on the server.

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

Redefined in descendants as:
getSendingHistoryManager (line 243)

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.
  • abstract:
  • since: API 1.11.1
  • access: public
Inx_Api_Sending_SendingHistoryManager getSendingHistoryManager ()

Redefined in descendants as:
getServerTime (line 460)

Returns the server time as Inx_Api_ServerTime object.

Returns the server time as Inx_Api_ServerTime object. With this object, you are able to translate the date from your time zone to the time zone of the server.

  • return: the server time.
  • abstract:
  • since: API 1.4.4
  • access: public
Inx_Api_ServerTime getServerTime ()

Redefined in descendants as:
getSplitTestMailingManager (line 424)

Return the Inx_Api_SplitTestMailing_SplitTestMailingManager object that gives read only access to all split test mailings in the system.

Return the Inx_Api_SplitTestMailing_SplitTestMailingManager object that gives read only access to all split test mailings in the system.

  • return: the split test mailing manager.
  • abstract:
  • since: API 1.13.1
  • access: public
Inx_Api_SplitTestMailing_SplitTestMailingManager getSplitTestMailingManager ()

Redefined in descendants as:
getSplitTestManager (line 433)

Return the Inx_Api_SplitTest_SplitTestManager object that gives read only access to all split tests in the system.

Return the Inx_Api_SplitTest_SplitTestManager object that gives read only access to all split tests in the system.

  • return: the split test manager.
  • abstract:
  • since: API 1.13.1
  • access: public
Inx_Api_SplitTest_SplitTestManager getSplitTestManager ()

Redefined in descendants as:
getSubscriptionManager (line 253)

Returns the Inx_Api_Subscription_SubscriptionManager object that will be used to subscribe and unsubscribe recipients.

Returns the Inx_Api_Subscription_SubscriptionManager object that will be used to subscribe and unsubscribe recipients.

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

Redefined in descendants as:
getTemporaryMailSender (line 351)

Returns the Inx_Api_Util_TemporaryMailSender object that will be used to send temporary mails.

Returns the Inx_Api_Util_TemporaryMailSender object that will be used to send temporary mails. Temporary mails are not written to the database, thus not retrievable once they are sent.

  • return: the temporary mail sender.
  • abstract:
  • since: API 1.0
  • access: public
Inx_Api_Util_TemporaryMailSender getTemporaryMailSender ()

Redefined in descendants as:
getTextmoduleManager (line 323)

Returns the Inx_Api_TextModule_TextModuleManager object that will be used to manage text modules.

Returns the Inx_Api_TextModule_TextModuleManager object that will be used to manage text modules. Text modules are reusable text snippets that can be used inside mailings in the same list (or all lists if the text module is defined in the system list). A common text module is a custom salutation.

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

Redefined in descendants as:
getTransformationManager (line 415)

Returns the Inx_Api_Transformation_TransformationManager object that will be used to manage transformations.

Returns the Inx_Api_Transformation_TransformationManager object that will be used to manage transformations. A transformation converts datasource content to another format and allows another presentation of the datasource.

  • return: the transformation Manager.
  • abstract:
  • since: API 1.13.1
  • access: public
Inx_Api_Transformation_TransformationManager getTransformationManager ()

Redefined in descendants as:
getTriggerMailingManager (line 234)

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.
  • abstract:
  • since: API 1.10.0
  • access: public
Inx_Api_TriggerMailing_TriggerMailingManager getTriggerMailingManager ()

Redefined in descendants as:
getUserContext (line 379)

Returns the Inx_Api_UserContext object associated with this

  1. Session
object.

Returns the Inx_Api_UserContext object associated with this

  1. Session
object. The
  1. UserContext
may be used to check the rights of the session user.

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

Redefined in descendants as:
getUtilities (line 360)

Returns the Inx_Api_Util_Utilities object that can be used for special activities like the tell a friend feature.

Returns the Inx_Api_Util_Utilities object that can be used for special activities like the tell a friend feature.

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

Redefined in descendants as:
getWebpageManager (line 369)

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.
  • abstract:
  • since: API 1.9.0
  • access: public
Inx_Api_Webpage_WebpageManager getWebpageManager ()

Redefined in descendants as:
sessionId (line 441)

Returns the unique id of this session.

Returns the unique id of this session.

  • return: the id of this session.
  • abstract:
  • since: API 1.0
  • access: public
string sessionId ()

Redefined in descendants as:

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