Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Full details for this configuration can be found in Email Account, but in this article we will cover some common examples.

Step-by-step guide

  1. Click on Admin → Manage In the full repository browser, open the section Email Accounts
  2. Add details for a new account - an account: see examples below for POP3 and IMAP; to make this an inbound account, don't tick the Outbound box
  3. Click Test Configuration to ensure the settings are correct
  4. Tick the Enabled box, then save any changes

...

With POP3 just the main Inbox is polled for messages Image Removed

Image Added

Example Settings using IMAP / Office 365

...

If you leave Folder blank, emails will be read directly from the Inbox.

 Image RemovedImage Added

Set up file collector to load email messages and/or attachments

...

FieldValue
Source TypeManaged File
File TypeThe type of the attached file, or for reading the email message itself (the body), probably CSV
File Location StrategyAll Files in Folder
Tag

If a tag is being set (see below), the tag name surrounded by double quotes. E.g.:

Code Block
"accdataemail"

If a tag is not being set:

Code Block
"default"


Input Directory Expr.


Code Block
"in"


Directory Pattern Expression


Code Block
".*"


File Pattern Expression

A pattern to match attached files, e.g. to find attached files with names like AccData-20170426.xlsx:

Code Block
"AccData.*xlsx"

or if you want to read in the email message (the body) this will be just:

Code Block
"body.txt"


Archive Directory Expression


Code Block
"archive"

...


Image Added

Setting a tag

You can set a tag for the emails by including

...

Info

You don't need to know this emails and attached files are stored on the PhixFlow server to complete the configuration of the file collector, but sometimes you might find it helpful to be able to find the files delivered by the email polling service.

In system configuration you will have, under the tab section System Directories, a setting File Upload Directory. For example:

Code Block
/opt/phixflow/data/upload

If you have not specified a tag in the subject line of your incoming emails, files will appear in directories:

Code Block
/opt/phixflow/data/upload/default/in/[date]/[long ID]

E.g.

Code Block
/opt/phixflow/data/upload/default/in/20170426/ab5dcb71868e47c484d6aa78430393d6

If you have specified a tag in the subject line of the emails, files will appear in directories:

Code Block
/opt/phixflow/data/upload/[tag]/in/[date]/[long ID]

E.g. with the tag "accdataemail"

Code Block
/opt/phixflow/data/upload/accdataemail/in/20170426/eebb98c20ce04246b0cee073a510ccde

Archiving

If you set an archive directory, your files will be moved once they have been read in by the file collector. This will be to:

Code Block
[file upload directory]/[tag]/[archive dir]/[date]/[long ID]

E.g. if you set the archive directory to "archive" (as in the examples above), your files will be moved to directories like:

Code Block
/opt/phixflow/data/upload/default/archive/20170426/6904c5192d5944bd919d4eee99bc0237

or, if you are using the tag "accdataemail":

Code Block
/opt/phixflow/data/upload/accdataemail/archive/20170426/6904c5192d5944bd919d4eee99bc0237


...

  1. Incorrect Password. As well as checking the password is correct, ensure no special characters are being used such as ampersand as - these seem to can sometimes cause this error.
  2. Incorrect Username. Double-check that the username is the actual mailbox name as setup on the mail server, and not the alias or email address, which may sometimes be different. 
  3. Cannot authenticate. In some cases, the details are correct but the server is refusing to allow authentication to take place, due to the authentication protocol being used. For example, this error is received when attempting to connect to Google Mail, because Google requires the username and password to be supplied in an OAuth token.

...

The error below typically appears after a delay of up to 1 minute, and normally indicates the port number being used is the wrong one for the type of operation.

...