Skip to content
Help Center
Submit a request Sign in

Parse structured inbound email with route forms

Route forms map labelled lines in an inbound message into case, customer and activity fields. They are useful for predictable application-generated mail, where a stable format can reduce manual entry.

Applies to: Supportbench Core. Location: Settings → Email configuration → Route forms. Editing requires Administer email routes.

Before you begin

  • Use a representative original message from the sending system and identify its stable labels, separator and sender/subject filters.
  • Decide whether automatic Contact or Company creation is appropriate. Enable it only when the incoming identity fields are dependable.

Configure and verify

  1. Open Settings → Email configuration → Route forms and choose New Form.
  2. Enter the definition and exact sender/subject filters, then choose the delimiter used by incoming labeled lines.
  3. Review Create contact when not found and Create company when not found. These options can create real customer records.
  4. Choose Add mapping. Enter Incoming label and select Map to for the intended Case, customer, custom-field or Activity destination. Repeat for each supported incoming field.
  5. Choose Save Changes. Then open the intended inbound route, select this form under Email forms, and save that route separately.
  6. Send an approved original-format test email through the route. Verify both the resulting Case fields and customer identity; inspect any created records.
  7. When replacing or deleting a form, update and re-save every affected route. Deleting a form leaves its ID selected on existing routes, and processing skips that missing form.

Settings reference

Matching and creation

SettingWhat it controlsHow to choose
NameInternal name for the parsing form.Describe the source application and message format.
Match sender addressOptional exact sender match.Use the actual sending address when the form should apply only to one source.
Match subject textOptional text that must appear in the subject.Choose a stable distinguishing phrase.
Line delimiterSeparates the incoming label from its value. Each mapped line must contain exactly one delimiter.Choose a delimiter that will not also appear inside the values; options include colon, semicolon, comma, caret, slashes, hyphen, underscore and question mark.
Create contact when not foundAllows parsed name, email and phone values to create a missing contact.Enable only when the source supplies reliable identity information.
Create company when not foundAllows the parsed company name to create a missing company.Review naming consistency to avoid duplicate companies.

Line mapping

SettingWhat it controlsHow to choose
Incoming labelText before the delimiter. Mapping order is retained.Match the source message’s label consistently.
Map toDestination selected from case/customer, Case custom fields or activity fields.Choose the intended entity and field, not merely a similar display name.
Case and customer destinationsCompany name; contact full/first/last name, email and phone; Division, Subject, Summary, Priority, Issue, Asset, Queue and Agent owner.Use full name or email for Agent owner according to the displayed option.
Activity destinationsActivity type and Activity content.Keep customer-facing content separate from operational metadata.
Add / Remove mappingChanges which incoming lines are mapped.Review the entire mapping before saving.

Recommended use

  • Use route forms for predictable labelled lines. Free-form prose may not parse reliably.
  • A value containing the selected delimiter can stop that line from matching; test realistic samples.

Worked example

  1. A trusted equipment-monitoring system sends labeled lines such as Subject: Login help. Use a colon delimiter only if that is the actual message format.
  2. Map the incoming Subject label to the Case subject and add other supported mappings from the field reference.
  3. Save the form and separately select it on a controlled inbound route.
  4. Test a complete original-format message, a controlled unmatched test sender and a message with a missing label. Use approved test identities and Companies, or leave automatic creation off during that test. Review the resulting Case and customer identity before enabling record creation broadly.

Troubleshooting

ProblemWhat to check
None of the mappings runCheck sender/subject filters, exact delimiter and whether the form is selected on the inbound route.
One field is empty or wrongCompare its Incoming label and Map to destination with the original email; verify the target custom field and message format.
Unexpected Contacts or Companies were createdReview the creation switches and source identity fields. Correct the source/mapping before another test.
Parsing stopped after deleting a formUpdate and save the route’s Email forms selection; a deleted form still referenced by ID is skipped.
Saving the form did not change a routeForm definition and route selection are separate saves.
  • Email configuration → Configure inbound email routes
  • Configuration → Configure custom fields and dropdown choices

Was this article helpful?