Forge Home


Module to install and configure mutt email client.


12,977 latest version

4.6 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 1.0.2 (latest)
  • 1.0.1
  • 1.0.0
  • 0.1.2
  • 0.1.1
  • 0.1.0
released Sep 3rd 2015
This version is compatible with:
  • ArchLinux, CentOS, Debian, RedHat, Ubuntu

Start using this module

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

Add this module to your Puppetfile:

mod 'zanloy-mutt', '1.0.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add zanloy-mutt
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install zanloy-mutt --version 1.0.2

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.



zanloy/mutt — version 1.0.2 Sep 3rd 2015


Build Status

Table of Contents

  1. Overview
  2. Usage
  3. Parameters
  4. Reference
  5. Limitations


This module installs and configure mutt email client.


Simple installation with default options:

include ::mutt

Using maildir in ~/.maildir

class { 'mutt':
  folder => '~/.maildir',
  mbox_type => 'maildir',

Using system CA files for signature verification:

class { 'mutt':
  certificate_file => '/etc/certs'


  • alias_file

    • String. Location of your alias file.
    • Default: '~/.mutt/muttrc'
  • certificate_file

    • String. Location of your ca certificates file.
    • Default: '~/.mutt/certificates'
  • config_file

    • String. Location of your global mutt config file.
    • Note: Do not change this unless mutt has been compiled to look for the config file elsewhere. Otherwise it just will not read the config file at all.
    • Default: '/etc/Muttrc'
  • date_format

    • String. Date format to use. Takes standard printf style arguments.
    • Default: If undef then we use the package defaults.
  • delete

    • String. What mutt will do when deleting files on exit.
    • Default: 'ask-yes'
    • Valid Options: 'no', 'yes', 'ask-yes'
  • folder

    • String. The location of your mbox (or maildir) folder. Should be in home.
    • Default: '~/mail'
  • history_file

    • String. The location of your history file.
    • Default: '~/.mutt/history'
  • hostname

    • String. The hostname to use in From: in emails sent with mutt.
    • Default: If undef then mutt uses your hostname (not fqdn).
  • index_format

    • String. The printf style format for displaying email information in the mailbox view.
    • Default: If undef then we use mutt default.
  • mbox

    • String. The location of your mbox.
    • Note: This should be the same as your $folder in 90% of cases.
    • Default: $folder
  • mbox_type

  • package

    • String. The name of the mutt package to install.
    • Default: mutt


Defines only two resources: Package['mutt'] and File['/etc/Muttrc'].


This has been tested on RHEL 6.5 and Ubuntu 14.04 and has been found to work.