How to unset mail events in Cylc 8.5

In Cylc 8.5, workflow and task handler events and mail events names are now validated. Some people may have been doing something like:

mail events = None

in order to override and unset the global config value. This will now fail validation as technically it did the job but was never valid. The solution is to set it to empty:

mail events =
1 Like

Hi, is there a list of valid keywords now? Currently having issues with a workflow with a suite.rc file that that contains the lines:
{% set TASK_MAIL_EVENTS_COMMAND = “retry, submission retry, failed, submission failed, submission timeout, timeout” %}
mail events = {{TASK_MAIL_EVENTS_COMMAND}}
Apparently timeout is no longer valid but we wondered if the others are valid?

Yes:

I’m not sure what the timeout task event did, though a couple of workflows seem to contain it. I can’t find any evidence of it in Cylc 8 or 7, I think it dates back to Cylc 6?! There is an execution timeout event for use with the [events]execution timeout?

Either way, this event doesn’t appear to have existed for a long time so you can probably remove it safely.

I have managed to track down the task timeout event (not to be mistaken for the workflow timeout event) as it has appeared in a couple of workflows.

Support for this was removed in Cylc 4.2.0 (2012) in favour of execution timeout and submission timeout which work with the [events]execution timeout and [events]submission timeout configurations respectively (still supported, but seldom needed).

If your workflow does not use these timeouts, you can safely discard the timeout entry from your mail events, it hasn’t been doing anything.

Note, it is often unnecessary to specify mail events from within a workflow as sites should generally configure sensible defaults, you can use these commands to inspect your institution’s defaults:

# task events
$ cylc config -i '[task events]mail events' --default

# scheduler events
$ cylc config -i '[scheduler][events]mail events' --default

2012? That’s a long time ago! Thanks for this!