mail_aliases

Table of Contents

1. Description
2. Setup - The basics of getting started with mail_aliases
   • What mail_aliases affects
   • Setup requirements
   • Beginning with mail_aliases
3. Usage - Configuration options and additional functionality
4. Limitations - OS compatibility, etc.
5. Development - Guide for contributing to the module

Description

The mail_aliases module manages mail aliases on the target systems using data stored in hiera. It is capable of both creating and removing aliases, with the default being to create them.

Setup

Setup Requirements

This will only work if sendmail or postfix is installed on the target system. Please ensure that one of those packages is installed, otherwise you're going to get failures.

Please ensure that the puppetlabs/mailalias_core module is installed in your Puppetfile.

Beginning with mail_aliases

Configure your hiera data however you would like, following the example below. Then update your Puppetfile to install stjeanp/mail_aliases and puppetlabs/mailalias_core modules.

Usage

 mail_aliases:
   root:
     recipient: 'someone@somewhere.else.com'
   user:
     recipient: 'their@real.address'
   olduser:
     recipient: 'not@work.anymore'
     ensure: absent

The default behavior is to create an alias, so if you need to remove one, make sure to include the 'ensure: absent' line.

include ::mail_aliases

Limitations

Due to testing VM availability, it only supports systems whose OS Family fact is RedHat, Debian, or SUSE.

Development

Issues, merge requests, and feedback are always welcome.