Skip to content

Commit

Permalink
Merge pull request #2881 from nickanderson/ENT-11569/3.21.x
Browse files Browse the repository at this point in the history
ENT-11569: Added documentation for mailto, mailfrom, smtpserver and maxmaillines (3.21)
  • Loading branch information
nickanderson authored Apr 29, 2024
2 parents efa29b7 + a457bfe commit a23cb76
Showing 1 changed file with 56 additions and 4 deletions.
60 changes: 56 additions & 4 deletions MPF.md
Original file line number Diff line number Diff line change
Expand Up @@ -732,19 +732,71 @@ allowed values (`LOG_USER`, `LOG_DAEMON`, `LOG_LOCAL0`, `LOG_LOCAL1`,

### mailto

The address that `cf-execd` should email agent output to.
The address that `cf-execd` should email agent output to. Defaults to `root@$(default:def.domain)`.

This setting can be customized via Augments, for example:

```json
{
"variables": {
"default:def.mailto": {
"value": "[email protected]",
"comment": "When output differs from the prior execution cf-execd will deliver the output to this Email address for review."
}
}
}
```

### mailfrom

The address that output mailed from `cf-execd` should come from.
The address that output mailed from `cf-execd` should come from. Defaults to `root@$(sys.uqhost).$(def.domain)`.

This setting can be customized via Augments, for example:

```json
{
"variables": {
"default:def.mailfrom": {
"value": "[email protected]",
"comment": "Email sent from cf-execd should come from this address."
}
}
}
```

### smtpserver

The SMTP server that `cf-execd` should use to send emails.
The SMTP server that `cf-execd` should use to send emails. Defaults to `localhost`.

This setting can be customized via Augments, for example:

```json
{
"variables": {
"default:def.smtpserver": {
"value": "smtp.example.com",
"comment": "The smtp server that should be used when sending email from cf-execd."
}
}
}
```

### mailmaxlines

The maximumm number of lines of output that `cf-execd` will email.
The maximum number of lines of output that `cf-execd` will email. Defaults to `30`.

This setting can be customized via Augments, for example:

```json
{
"variables": {
"default:def.mailmaxlines": {
"value": "50",
"comment": "The maximum number of lines cf-execd should email."
}
}
}
```

**History:**

Expand Down

0 comments on commit a23cb76

Please sign in to comment.