22.16.189. salt.modules.smtp

Module for Sending Messages via SMTP

New in version 2014.7.0.

depends:
  • smtplib python module
configuration:

This module can be used by either passing a jid and password directly to send_message, or by specifying the name of a configuration profile in the minion config, minion pillar, or master config.

For example:

my-smtp-login:
    smtp.server: smtp.domain.com
    smtp.sender: admin@domain.com
    smtp.username: myuser
    smtp.password: verybadpass

The resourcename refers to the resource that is using this account. It is user-definable, and optional. The following configurations are both valid:

my-smtp-login:
    smtp.server: smtp.domain.com
    smtp.sender: admin@domain.com
    smtp.username: myuser
    smtp.password: verybadpass

another-smtp-login:
    smtp.server: smtp.domain.com
    smtp.sender: admin@domain.com
    smtp.username: myuser
    smtp.password: verybadpass
salt.modules.smtp.send_msg(recipient, message, subject='Message from Salt', sender=None, server=None, use_ssl='True', username=None, password=None, profile=None)

Send a message to an SMTP recipient. Designed for use in states.

CLI Examples:

smtp.send_msg 'admin@example.com' 'This is a salt module test'             profile='my-smtp-account'
smtp.send_msg 'admin@example.com' 'This is a salt module test'             username='myuser' password='verybadpass' sender="admin@example.com'             server='smtp.domain.com'

Docs for previous releases are available on salt.rtfd.org.

Latest Salt release: 2014.1.13

Try the shiny new release candidate of Salt, v2014.7.0rc6! More info here.

Previous topic

22.16.188. salt.modules.smf

Next topic

22.16.190. salt.modules.softwareupdate

SaltStack News

Upcoming SaltStack events, webinars and local meet ups and user groups.