Version information
This version is compatible with:
- Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 4.7.0 < 6.0.0
- , , , , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-mailalias_core', '1.0.2'
Learn more about managing modules with a PuppetfileDocumentation
mailalias
Table of Contents
- Description
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
The mailalias module is used to manage entries in the local alias database.
Beginning with mailalias
To manage a mail alias, add the mailalias type to a class:
mailalias { 'ftp':
ensure => present,
recipient => 'root',
}
This example will redirect mail for the ftp account to root's mailbox.
Usage
The mailalias module is used to manage entries in /etc/aliases
, which creates an email alias in the local alias database.
For details on usage, please see the puppet docs.
file
A file containing the alias’s contents. The file and the recipient entries are mutually exclusive.
mailalias { 'usenet':
ensure => present,
file => '/tmp/foo/usenet-alias',
}
This will result in an entry such as usenet: :include: /tmp/foo/usenet-alias
recipient
Where email should be sent. Multiple values should be specified as an array. The file and the recipient entries are mutually exclusive.
mailalias { 'ftp':
ensure => present,
recipient => 'root',
}
This will result in an entry such as ftp: root
target
The file in which to store the aliases. Only used by those providers that write to disk.
mailalias { 'ftp':
ensure => present,
recipient => 'root',
target => `/etc/mail/aliases`
}
This will ensure the entry exists in the file specified, such as:
$ cat /etc/mail/aliases
ftp: root
Reference
This module is documented using Puppet Strings.
For a quick primer on how Strings works, please see this blog post or the README.md for Puppet Strings.
To generate documentation locally, run
bundle install
bundle exec puppet strings generate ./lib/**/*.rb
This command will create a browsable \_index.html
file in the doc
directory. The references available here are all generated from YARD-style comments embedded in the code base. When any development happens on this module, the impacted documentation should also be updated.
Limitations
This module is only supported on platforms that have sendmail
available.
Development
Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.
We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
For more information, see our module contribution guide.
Types in this module release
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
1.0.2 - 2018-04-30
Added
- Gem dependency on puppet-blacksmith, which is required to ship to the module to forge.puppet.com
Changed
- The Gemfile and spec/spec_helper.rb are managed by pdk. Any additional content for these files should be defined in .syn.yml and spec/spec_helper_local.rb respectively
1.0.1 - 2018-04-30
Summary
This is an empty release to test the release pipeline
1.0.0 - 2018-04-27
Summary
This is the initial release of the extracted mailalias module