Ethel Docs

Email runners

This runner is not currently included in ethel even though it has been used in production migrations. It will be added back in soon...

These runners handle emails and pst files.

PSTLoader

Production

This runner loads emails into a personal storage file (PST).

It has the following configuration options:

  • addHash boolean whether to add the extractHash lookup. Defaults to true
  • dllPath string path to the Aspose email dll, if not supplied it assumed to be added to the GAC
  • emailPath string the message attribute with the path to the email. Defaults to emailPath
  • pstMaxSize number the maximum size for a pst file. Defaults to 20 gb
  • pstPath string defaults to pstPath
    • if pstPathInMessage is true, the message attribute containing the path to the file
    • if pstPathInMessage is false, mandatory the path to the file
  • pstPathInMessage boolean if the pstPath is in the message object. Defaults to false

Message attributes:

  • emailPath mandatory string or staged document details path to the email to add to the pst
  • pstPath string the path to the file to update, mandatory if pstPathInMessage is true

Message attribute names can be changed in the configuration options.

For each row it will raise the next task with the following message elements:

  • pstPath the path of the pst
  • PSTLoaderComplete the date and time the runner completed