github.com/cloudposse/terraform-null-smtp-mail
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.
We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!
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.
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
Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.
| Benchmark | Description |
|---|---|
| Infrastructure Security Compliance | |
| Center for Internet Security, KUBERNETES Compliance | |
| Center for Internet Security, AWS Compliance | |
| Center for Internet Security, AZURE Compliance | |
| Payment Card Industry Data Security Standards Compliance | |
| National Institute of Standards and Technology Compliance | |
| Information Security Management System, ISO/IEC 27001 Compliance | |
| Service Organization Control 2 Compliance | |
| Center for Internet Security, GCP Compliance | |
| Health Insurance Portability and Accountability Compliance |
IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.
Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.
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.
Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
No requirements.
| Name | Version |
|---|---|
| null | n/a |
| template | n/a |
No modules.
| Name | Type |
|---|---|
| null_resource.default | resource |
| template_file.body | data source |
| template_file.subject | data source |
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| body | Email body template | any | n/a | yes |
| enabled | Flag to enable or disable the sending of emails | string | "true" | no |
| from | From address for email | any | n/a | 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 | n/a | yes |
| port | SMTP Port | string | "587" | no |
| subject | Email subject template | any | n/a | yes |
| to | Email recipients | list(string) | n/a | yes |
| username | Username to authenticate with the SMTP server | string | n/a | yes |
| vars | Parameters to pass to the body template | map | {} | no |
| Name | Description |
|---|---|
| body | Rendered body of the email |
| subject | Rendered subject of the email |
Like this project? Please give it a ★ on our GitHub! (it helps us a lot)
Are you using this project or any of our other projects? Consider leaving a testimonial. =)
Check out these related projects.
Got a question? We got answers.
File a GitHub issue, send us an email or join our Slack Community.
We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
Join our Open Source Community on Slack. It's FREE 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 totally sweet infrastructure.
Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.
Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!
Please use the issue tracker to report any bugs or file feature requests.
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.
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
Copyright © 2017-2023 Cloud Posse, LLC
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.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!
We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.
We offer paid support on all of our projects.
Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.
 Erik Osterman |  Igor Rodionov |  Andriy Knysh |
|---|
FAQs
Unknown package
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.