Terraform module to send transactional emails via an SMTP server (e.g. mailgun)
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
examples/simple
.gitignore
.travis.yml
LICENSE
Makefile
README.md
README.yaml
main.tf
outputs.tf
variables.tf

README.md

Cloud Posse

terraform-null-smtp-mail Build Status Latest Release Slack Community

Terraform Module to send emails using an SMTP server by calling an external email command.


This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

Introduction

This terraform module uses an external command using the local-exec provisioner to send emails. It's ideally suited for sending transactional emails related to the apply phase. For example, notifying a user of their IAM user account getting created or the deployment of a new ECS application.

NOTE: The null refers to the primary Terraform provider used in this module.

Dependencies

First install the latest release of the email cli tool here: https://github.com/wrouesnel/emailcli/releases

Make sure it exists in your PATH (E.g. /usr/local/bin)

We distribute an Alpine Linux package (emailcli) as part of our toolchain.

curl -sSL https://apk.cloudposse.com/install.sh | sudo bash
apk add emailcli@cloudposse

Usage

module "welcome" {
  source     = "git::https://github.com/cloudposse/terraform-null-smtp-mail.git?ref=master"
  host       = "smtp.mailgun.org"
  port       = "587"
  username   = "postmaster@ourdomain.com"
  password   = "changeme"
  from       = "admin@yourdomain.com"
  to         = ["example@yourdomain.com"]
  subject    = "Welcome $${first_name}"
  body       = "Your account has been created. Login here: $${homepage}"

  vars = {
    first_name = "Example"
    homepage   = "https://cloudposse.com"
  }
}

NOTE: Use the file(...) interpolation function to use a template file.

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Inputs

Name Description Type Default Required
body Email body template string - yes
enabled Flag to enable or disable the sending of emails string true no
from From address for email string - yes
host SMTP Host string smtp.mailgun.org no
mail_command Command to execute string email no
password Password to authenticate with the SMTP server string - yes
port SMTP Port string 587 no
subject Email subject template string - yes
to Email recipients list - yes
username Username to authenticate with the SMTP server string - yes
vars Parameters to pass to the body template string <map> no

Outputs

Name Description
body Rendered body of the email
subject Rendered subject of the email

Related Projects

Check out these related projects.

  • emailcli - 12-factor compatible command line tool for sending emails that is written in Go.

Help

Got a question?

File a GitHub issue, send us an email or join our Slack Community.

Commercial Support

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

E-Mail

  • Questions. We'll use a Shared Slack channel between your team and ours.
  • Troubleshooting. We'll help you triage why things aren't working.
  • Code Reviews. We'll review your Pull Requests and provide constructive feedback.
  • Bug Fixes. We'll rapidly work to fix any bugs in our projects.
  • Build New Terraform Modules. We'll develop original modules to provision infrastructure.
  • Cloud Architecture. We'll assist with your cloud strategy and design.
  • Implementation. We'll provide hands-on support to implement our reference architectures.

Community Forum

Get access to our Open Source Community Forum on Slack. It's FREE to join for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build sweet infrastructure.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyright

Copyright © 2017-2018 Cloud Posse, LLC

License

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know at hello@cloudposse.com

Cloud Posse

We're a DevOps Professional Services company based in Los Angeles, CA. We love Open Source Software!

We offer paid support on all of our projects.

Check out our other projects, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Erik Osterman
Erik Osterman
Igor Rodionov
Igor Rodionov
Andriy Knysh
Andriy Knysh