API by Email and MSP Integration

From RangerMSP Wiki - PSA software for MSPs and IT services providers
Revision as of 14:47, 28 July 2009 by Yarden (talk | contribs)
Jump to navigation Jump to search

The Email Connector provides advanced processing options, such as using the Email Connector as an API (via XMl transactions), or using Automated Emails.

The Email Connector setup window is designed as a flow chart, which represents the lifecycle of the email as it is processed. Each step in the flow requires configuring settings to instruct the system how to handle that step.

File:Commit email connector setup scroll window.zoom70.png


Here you can define parameters for how the system should process the email. The Email Connector server pulls each email and performs the relevant action as defined in the settings. The basic implementation is the Email to Ticket.

In this section you will learn how to configure the following advanced options:

API by Email (XML Formatted Emails)

Setting up the API by Email section is optional and is required only when working with external system which send XML formatted emails (which contains API transactions) to the Email Connector.

When an email containing XML formatting is detected, the system analyzes the XML content of the email and performs the appropriate action. You may also send automatic replies in response to XML formatted email (see Setting Up Responses Parameters below).

File:Commit email connector setup processing api window.gif

The following settings should be defined here:

  • Activate API by Email - select this box if you wish to activate the XML formatting processor.
  • Password Protection - to avoid processing spam XML formatted emails which can modify your database, you may define a password in the Password field. When the Password is defined here. this means that incoming transactions must contains the password in the XML in order to be processed.

Setting up the Response parameters:
If an XML email requires a response, the following settings will be used:

  • Send Response - Select this box in order to send responses to the API system if requested in the XML. Note that the response will be sent to the email address specified in the XML text (if specified) and not to the sender of the XML email.
  • BCC each Response Email to (optional) – If you would like to store all automatic outgoing emails sent in response to processed XML messages, you can automatically BCC your own support team or any other email address where these messages can be stored (again, DO NOT send these automatic emails to the Email Connector Incoming Email Address which is being used for all XML support requests processed by the Email Connector).
Retrieved from "https://www.rangermsp.com/w/index.php?title=API_by_Email_and_MSP_Integration&oldid=440"