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.
Located in /Api/Session.php (line 57)
Class | Description |
---|---|
Inx_Apiimpl_AbstractSession | The Inx_Api_Session is the entry point to the API. |
This feature is not available in the PHP API.
This feature is not available in the PHP API.
Attempts to establish a session used for plug-ins.
Attempts to establish a session used for plug-ins.
Attempts to establish a session used for plug-ins.
Attempts to establish a session used for plug-ins.
Attempts to establish a session to the given inxmail application.
Attempts to establish a session to the given inxmail application.
Returns the value of the session property specified by the given key.
Returns the value of the session property specified by the given key.
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.
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.
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.
Creates a new
Creates a new
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.
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.
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).
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.
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.
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.
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.
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.
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
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.
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.
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.
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.
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.
Returns the
Returns the
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.
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.
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.
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 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 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.
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.
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.
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.
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.
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.
Returns the Inx_Api_UserContext object associated with this
Returns the Inx_Api_UserContext object associated with this
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.
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.
Returns the unique id of this session.
Returns the unique id of this session.
Documentation generated on Thu, 17 Sep 2015 14:27:30 +0200 by phpDocumentor 1.3.2