Forge Home

mailalias_core

pdk
Creates an email alias in the local alias database.

Puppet

puppetlabs

280,623 downloads

177,943 latest version

5.0 quality score

Version information

  • 1.0.6 (latest)
  • 1.0.5
  • 1.0.4
  • 1.0.3
  • 1.0.2
  • 1.0.0
released Feb 10th 2020
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
  • Puppet >= 4.10.0 < 7.0.0
  • CentOS
    ,
    OracleLinux
    ,
    RedHat
    ,
    Scientific
    ,
    Debian
    ,
    Ubuntu
    ,
    Fedora
    ,
    Darwin
    ,
    SLES
    ,
    Solaris

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'puppetlabs-mailalias_core', '1.0.6'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-mailalias_core
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-mailalias_core --version 1.0.6

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

puppetlabs/mailalias_core — version 1.0.6 Feb 10th 2020

mailalias

Table of Contents

  1. Description
  2. Usage - Configuration options and additional functionality
  3. Reference - An under-the-hood peek at what the module is doing and how
  4. Limitations - OS compatibility, etc.
  5. 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 REFERENCE.md for the reference documentation.

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.