Emails customizationΒΆ

New in version 0.8.0.

Emails can be customized (e.g. translated) by setting the option [notify] mail_cfg in the application configuration or in the job configuration to the filename of the customized email configuration. For this to work the option [global] mail_cfgs_dir must be set in the application configuration.

The name of the default email configuration is default. It can be used in a job configuration to overwrite an email customization set in the application configuration. It is also used as a fallback if the cusotmized email configuration cannot be found or has errors.

The default email configuration:

DATETIME_FORMAT: %Y-%m-%d %H:%M:%S
DURATION_FORMAT: %M:%02S.%03s

STAT_SUCCESS: Finished w/o errors
STAT_ERRORS: Finished with errors
STAT_FAILURE: Failure
STAT_CONFIG: Configuration error
STAT_TERMINATED: Terminated
STAT_OTHER: Another error

STATUS_OK: OK
STATUS_ERR: ERROR

SUBJECT: Job "$jobname" finished [$status]

MESSAGE:
Job "$jobname" (ID: $jobid):

Start: $starttime
End: $endtime
Duration: $duration

Info:
  $info

Source: $source
Target: $target

Logfile: $logfile

$statstr:
  $files_cnt files transferred, $src_error_cnt source error(s), $tgt_error_cnt target error(s)

Exception:
  $errormsg

Files: (= is transferred, > is source error, < is target error)
  $filelist

Except MESSAGE all entries must be on one line. MESSAGE must be the last entry. Entrynames are not case-sensitive.

The datetime format is explained here and the duration format here.

One of the STAT_* strings is substituted for $statstr and one of the STATUS_* strings for $status depending on the result status of the job.

Another placeholder is $stacktrace (not used in the default configuration). It prints the stack trace if an exception occured.

The values for substituting $files_cnt, $src_error_cnt, $tgt_error_cnt and $filelist are taken from the (possibly incomplete) job result.

The other template placeholders should be self explaining.

Changed in version 0.10.0: Removed: ERR_*, RESULT, $errstr, $result; Added: STAT_*, $statstr, $errormsg, $stacktrace