Module to install and configure mutt email client.
Zan Loy

Zan Loy



11,783 latest version

4.6 quality score

Version information

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

Start using this module


zanloy/mutt — version 1.0.2 Jul 3rd 2019


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.