Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

You can import email attachments from your mailbox into ABBYY Vantage, and optionally include the email body. The Input activity accesses a single email folder per skill.
Once the skill is published, Vantage checks the specified email folder once per minute.
Each new email is processed as follows:
  • If the email contains attachments, a new transaction is created for all attachments in the email.
  • If email-body import is enabled, the email body is converted to HTML and appended to the same transaction. Vantage also processes first-level embedded emails and their attachments.
Vantage imports at most 50 emails per check. If there are more than 50 new emails, Vantage imports the 50 oldest and picks up the rest on subsequent checks. If throughput becomes a bottleneck, split the work across two skills — each with its own mail folder — so two agents pick up emails in parallel.

​
Transaction registration parameters

The following data is saved to the transaction registration parameters:
Parameter nameDescription
EmailSubjectThe email subject.
EmailDateDate and time when the email was sent, including time zone. Format: MM/DD/YYYY HH:MM:SS +/-HH:MM.
EmailSender*The sender’s email address.
EmailAddressee*The addressees’ email addresses, separated by commas with no spaces.
EmailCopyAddressee*The copy addressees’ email addresses, separated by commas with no spaces.
* Only email addresses are stored — the sender’s and addressees’ names are not saved.
Vantage doesn’t create parameters with empty values. For example, if an email has no subject, the transaction won’t have an EmailSubject registration parameter.
The source type (MailImport) and source file name are saved to the SourceType and SourceFileName document registration parameters. You can access document and transaction registration parameters by adding the corresponding columns in the Transactions section of Skill Monitor. They’re also exported to the output JSON file (configurable in the Exported Data section of the Output activity), and the transaction registration parameters are available via the Vantage API. The following characters are not allowed in file names and are replaced with underscores upon upload: / : ? # [ ] @ ! $ & ' ( ) * + , ; = \. The original file names are saved to the document registration parameters — retrieve them using a Custom activity sample script.

​
Import results

If an attachment’s format is unsupported, the transaction fails and processing stops for all other documents in it. See the specific error in the Error log section of Skill Monitor. If an email has no attachments and body import is disabled, no transaction is created — but the email is still marked as processed. Processed emails are either permanently deleted or moved to a folder you specify when configuring the mailbox connection. Emails that can’t be imported are moved to a user-specified exceptions folder.
If an email imports successfully but the transaction fails, the email is placed in the Processed folder.
If Vantage can’t access the import folder, it generates an error you can view in the Error log section of Skill Monitor.

​
Set up email import

1

Open the Input activity

Click the Input activity block in your document processing flow. If one isn’t in the Skill Designer yet, add it from the Activities pane.
2

Select Email as an additional source

In the Actions pane, check Select additional source and choose Email.
Input activity Actions pane with the Email option selected
3

Open settings and choose account type

Click Settings. In the dialog, select an account type (Microsoft or other) and click Continue.
4

Log in to the account

Log in using one of the methods below — see Connect to a Microsoft account or Connect to other email accounts.
5

Specify import and exceptions folders

Specify the folder from which Vantage imports emails, plus a folder for emails that can’t be processed.
Don’t select the same import folder used by another Process skill in your tenant. If multiple skills share an import folder, you can’t control which skill processes a given email.
After you publish the skill, Vantage creates a VantageProcessing folder inside the specified import folder. Emails move to this service folder first, then are processed per your configuration.
6

Choose the action for processed emails

Processed emails can be permanently deleted (default) or moved to a folder. If you select Delete, specify a folder to store deleted emails.
Action-for-imported-emails section of the Input Settings: Email dialog
7

(Optional) Enable email body import

Enable email-body import if needed.
8

Save

Click Save to save the settings and close the dialog.
The email address connected to the activity appears in the Actions pane when the Input block is selected. Click Settings under the email address to view or change the current mail import settings — or to log out of the email account.
Logging out of the email account resets all settings. Changes to settings take effect only once the skill is published.

​
Connect to a Microsoft account

In the Microsoft account login dialog, select your current account (if already signed in) or use a different one. Once authentication succeeds, the login dialog closes. On first login with a Microsoft account, Vantage asks for permission to:
  • Sign in to the app using a work or school account.
  • Access the primary email address and basic user profile data.
  • Access and update user details, even when the user isn’t using the app.
  • Access, update, create, and delete (but not send) emails in the user’s mailboxes.
If you use an Exchange hybrid configuration, move the mailbox from on-premises to Exchange Online. See Microsoft’s mailbox migration guide.

​
Connect to other email accounts

Specify your email address and password, the IMAP server address, and the IMAP port (default: 993 — usually no change needed). Click Sign in. If Vantage can’t connect to the server, the account login dialog stays open and an error icon appears next to the input fields.
Input Settings: Email dialog showing connection error icons
If all details are correct, the connection error is likely caused by one of these:
  • The email server blocked a suspicious login attempt.
    Check your email. If you received a notice about a blocked login attempt, confirm that the attempt was yours.
  • For Google accounts without two-factor authentication: restricted access to less secure apps.
    Allow access for less secure applications and confirm the Vantage access attempt if prompted.
  • The server requires an application-specific password.
    Some services (Yahoo, Google with 2FA) require app-specific passwords for third-party applications. Generate one per the service’s instructions and use it in the Input activity settings.
Once authentication succeeds, the connected email address appears in the Input Settings: Email dialog.

​
Disable imports

Administrators can disable document import from Skill Monitor. Disabling email import does not affect document import via the API.

​
Cleanup on skill deletion

When a skill is deleted, Vantage stops checking the specified email folder.

Input activity

Overview of the Input activity and the source types it supports.

Import from a shared folder

Set up Vantage to pull documents from an SFTP-accessible shared folder.

Skill Monitor

Disable input sources per skill and inspect transaction results.

Supported file formats

Reference list of every file format Vantage can ingest.