Class: Ansible::Ruby::Modules::Mail

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Mail

Defined in:

lib/ansible/ruby/modules/generated/extras/notification/mail.rb

Overview

This module is useful for sending emails from playbooks. One may wonder why automate sending emails? In complex environments there are from time to time processes that cannot be automated, either because you lack the authority to make it so, or because not everyone agrees to a common approach. If you cannot automate a specific step, but the step is non-blocking, sending out an email to the responsible party to make him perform his part of the bargain is an elegant way to put the responsibility in someone else’s lap. Of course sending out a mail can be equally useful as a way to notify one or more people in a team that a specific action has been (successfully) taken.

Instance Method Summary

• #attach ⇒ String^?

  A space-separated list of pathnames of files to attach to the message.

• #bcc ⇒ Object^?

  The email-address(es) the mail is being ‘blind’ copied to.

• #body ⇒ String^?

  The body of the email being sent.

• #cc ⇒ String^?

  The email-address(es) the mail is being copied to.

• #charset ⇒ String^?

  The character set of email being sent.

• #from ⇒ String^?

  The email-address the mail is sent from.

• #headers ⇒ String^?

  A vertical-bar-separated list of headers which should be added to the message.

• #host ⇒ String^?

  The mail server.

• #password ⇒ String^?

  If SMTP requires password.

• #port ⇒ String^?

  The mail server port.

• #subject ⇒ String

  The subject of the email being sent.

• #subtype ⇒ String^?

  The minor mime type, can be either text or html.

• #to ⇒ String^?

  The email-address(es) the mail is being sent to.

• #username ⇒ String^?

  If SMTP requires username.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#attach ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/extras/notification/mail.rb', line 53

attribute :attach

#bcc ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/extras/notification/mail.rb', line 26

attribute :bcc

#body ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/extras/notification/mail.rb', line 33

attribute :body

#cc ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/extras/notification/mail.rb', line 22

attribute :cc

#charset ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/extras/notification/mail.rb', line 61

attribute :charset

#from ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/extras/notification/mail.rb', line 14

attribute :from

#headers ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/extras/notification/mail.rb', line 57

attribute :headers

#host ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/extras/notification/mail.rb', line 45

attribute :host

#password ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/extras/notification/mail.rb', line 41

attribute :password

#port ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/extras/notification/mail.rb', line 49

attribute :port

#subject ⇒ String

# File 'lib/ansible/ruby/modules/generated/extras/notification/mail.rb', line 29

attribute :subject

#subtype ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/extras/notification/mail.rb', line 65

attribute :subtype

#to ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/extras/notification/mail.rb', line 18

attribute :to

#username ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/extras/notification/mail.rb', line 37

attribute :username