| Dir : /proc/self/root/opt/saltstack/salt/lib/python3.10/site-packages/salt/states/ |
| Server: Linux ngx353.inmotionhosting.com 4.18.0-553.22.1.lve.1.el8.x86_64 #1 SMP Tue Oct 8 15:52:54 UTC 2024 x86_64 IP: 209.182.202.254 |
| Dir : //proc/self/root/opt/saltstack/salt/lib/python3.10/site-packages/salt/states/smtp.py |
"""
Sending Messages via SMTP
==========================
.. versionadded:: 2014.7.0
This state is useful for firing messages during state runs, using the SMTP
protocol
.. code-block:: yaml
server-warning-message:
smtp.send_msg:
- name: 'This is a server warning message'
- profile: my-smtp-account
- recipient: admins@example.com
"""
def __virtual__():
"""
Only load if the SMTP module is available in __salt__
"""
if "smtp.send_msg" in __salt__:
return "smtp"
return (False, "smtp module could not be loaded")
def send_msg(
name,
recipient,
subject,
sender=None,
profile=None,
use_ssl="True",
attachments=None,
):
"""
Send a message via SMTP
.. code-block:: yaml
server-warning-message:
smtp.send_msg:
- name: 'This is a server warning message'
- profile: my-smtp-account
- subject: 'Message from Salt'
- recipient: admin@example.com
- sender: admin@example.com
- use_ssl: True
- attachments:
- /var/log/syslog
- /var/log/messages
name
The message to send via SMTP
"""
ret = {"name": name, "changes": {}, "result": None, "comment": ""}
if profile is None and sender is None:
ret["result"] = False
ret["comment"] = "Missing parameter sender or profile for state smtp.send_msg"
return ret
if __opts__["test"]:
ret["comment"] = "Need to send message to {}: {}".format(
recipient,
name,
)
return ret
command = __salt__["smtp.send_msg"](
message=name,
recipient=recipient,
profile=profile,
subject=subject,
sender=sender,
use_ssl=use_ssl,
attachments=attachments,
)
if command:
ret["result"] = True
if attachments:
atts = ", ".join(attachments)
ret["comment"] = "Sent message to {0} with attachments ({2}): {1}".format(
recipient, name, atts
)
else:
ret["comment"] = f"Sent message to {recipient}: {name}"
else:
ret["result"] = False
ret["comment"] = f"Unable to send message to {recipient}: {name}"
return ret