Mail API

The Mail API can be used by end users and monitoring tools to submit requests by sending email to the email address of a service provider organization’s Xurrent account. The Mail API can also be used to add a note to an existing request, problem, task, etc. by including the ID of the record in the Subject field.

The Xurrent Email Addresses

Each Xurrent account has its own email address. In the production environment the email address of a Xurrent account is account_id@mail.4me.com, in QA this becomes account_id@mail.Xurrent.qa. You can find the id of your organization’s Xurrent account when you open the ‘Account Overview’ section in the Settings console.

The Mail API is available for each Xurrent demo instance. To tell the Mail API for which demo instance the inbound email is intended, the name of the demo instance needs to be included in the email address to which the email is sent. This is different from the QA and production environments of Xurrent where only the name of the Xurrent account needs to be included in the email address.

If the name of your demo instance is Instance1 and the Xurrent account in which you want to generate a new request is wdc, you can send the email to wdc+Instance1@mail.4me-demo.com.

In addition, each team that is registered in a Xurrent account can be given its own email address. An email address of a team looks like team-name.account_id@mail.4me.com, where team-name is the local part of the email address that is unique for the account. This local part can be defined by an administrator of the account.

The Xurrent Email Policy

It is important to verify that the Email Policy option ‘Allow inbound email to generate new requests’ is checked (see Settings console, option Email Policy). If it is not, an inbound email message will not cause a new request to be generated and the sender of an email will receive an email that is based on the email template ‘Email Rejected’.

Question

The Xurrent Email Parameters

When a request is created by an email you can set some request fields by specifying a parameter at the start of the email body. A parameter should start with a hashtag # and between the parameters a new line must be set.
Add a blank line between the parameters and the rest of the email body.

Note that:

• parameters cannot be used to update the field values of an existing request;
• the user specified in the From email address needs to have a person record that has the specialist role in the Xurrent acount;
• the requested_for parameter is processed only if the sender’s Person record has the Service Desk Analyst role.

For example with the following parameters in the email body the Requested for user, a Configuration Item, the Team and the Team Member are set to the new request :

Exercises

Finish