Version information
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x
- Puppet >= 6.21.0 < 8.0.0
- , ,
Start using this module
Add this module to your Puppetfile:
mod 'attachmentgenie-mailhog', '4.0.1'Learn more about managing modules with a PuppetfileDocumentation
attachmentgenie-mailhog
Deploy and configure mailhog on a node.
Description
MailHog is an email testing tool for developers:
- Configure your application to use MailHog for SMTP delivery
- View messages in the web UI, or retrieve them with the JSON API
Usage
All options and configuration can be done through interacting with the parameters on the main mailhog class. These are now documented via Puppet Strings
You can view example usage in REFERENCE.
Reference
See REFERENCE.
Limitations
This is where you list OS compatibility, version compatibility, etc.
Development
Running tests
This project contains tests for both rspec-puppet and litmus to verify functionality. For detailed information on using these tools, please see their respective documentation.
Testing quickstart:
pdk bundle install
pdk bundle exec rake 'litmus:provision_list[puppet6]'
pdk bundle exec rake 'litmus:install_agent[puppet6]'
pdk bundle exec rake litmus:install_module
pdk bundle exec rake litmus:acceptance:parallel
pdk bundle exec rake litmus:tear_down
Reference
Table of Contents
Classes
Public Classes
mailhog: Class to install and configure mailhog. Use this module to install and configure mailhog.
Private Classes
mailhog::config: Class to configure mailhog.mailhog::install: Class to install mailhog.mailhog::service: Class to manage the mailhog service.
Classes
mailhog
Class to install and configure mailhog.
Use this module to install and configure mailhog.
Examples
Declaring the class
class { '::mailhog':
install_method => 'archive',
archive_source => 'https://github.com/mailhog/MailHog/releases/download/v1.0.1/MailHog_linux_amd64',
}
Parameters
The following parameters are available in the mailhog class:
configconfig_fileinstall_dirinstall_methodmanage_servicepackage_namepackage_versionservice_nameservice_providerservice_ensurearchive_source
config
Data type: String[1]
Mailhog config.
config_file
Data type: Stdlib::Absolutepath
Mailhog config file.
install_dir
Data type: Stdlib::Absolutepath
Location of mailhog binary release.
install_method
Data type: Enum['package','archive']
How to install mailhog.
manage_service
Data type: Boolean
Manage the mailhog service.
package_name
Data type: String[1]
Name of package to install.
package_version
Data type: String[1]
Version of mailhog to install.
service_name
Data type: String[1]
Name of service to manage.
service_provider
Data type: String[1]
Init system that is used.
service_ensure
Data type: Enum['running','stopped']
The state of the service.
archive_source
Data type: Optional[Stdlib::HTTPUrl]
Location of mailhog binary release.
Default value: undef
2.0.0
- moving to puppet4/5 syntax
Dependencies
- puppet/archive (>= 4.2.0 < 7.0.0)
- puppetlabs/stdlib (>= 4.25.0 < 9.0.0)
- puppet/systemd (>= 1.1.1 < 4.0.0)
Copyright (C) 2017 by Bram Vogelaar <bram@attachmentgenie.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.