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

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

#to_h

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

attr_options, attribute, #initialize, #to_h, validates

Constructor Details

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

Instance Method Details

#attach ⇒ String^?

Returns A space-separated list of pathnames of files to attach to the message. Attached files will have their content-type set to C(application/octet-stream).

Returns:

• (String, nil) —

  A space-separated list of pathnames of files to attach to the message. Attached files will have their content-type set to C(application/octet-stream).

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

attribute :attach

#bcc ⇒ Object^?

Returns The email-address(es) the mail is being ‘blind’ copied to. This is a comma-separated list, which may contain address and phrase portions.

Returns:

• (Object, nil) —

  The email-address(es) the mail is being ‘blind’ copied to. This is a comma-separated list, which may contain address and phrase portions.

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

attribute :bcc

#body ⇒ String^?

Returns The body of the email being sent.

Returns:

• (String, nil) —

  The body of the email being sent.

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

attribute :body

#cc ⇒ String^?

Returns The email-address(es) the mail is being copied to. This is a comma-separated list, which may contain address and phrase portions.

Returns:

• (String, nil) —

  The email-address(es) the mail is being copied to. This is a comma-separated list, which may contain address and phrase portions.

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

attribute :cc

#charset ⇒ String^?

Returns The character set of email being sent.

Returns:

• (String, nil) —

  The character set of email being sent

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

attribute :charset

#from ⇒ String^?

Returns The email-address the mail is sent from. May contain address and phrase.

Returns:

• (String, nil) —

  The email-address the mail is sent from. May contain address and phrase.

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

attribute :from

#headers ⇒ String^?

Returns A vertical-bar-separated list of headers which should be added to the message. Each individual header is specified as C(header=value) (see example below).

Returns:

• (String, nil) —

  A vertical-bar-separated list of headers which should be added to the message. Each individual header is specified as C(header=value) (see example below).

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

attribute :headers

#host ⇒ String^?

Returns The mail server.

Returns:

• (String, nil) —

  The mail server

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

attribute :host

#password ⇒ String^?

Returns If SMTP requires password.

Returns:

• (String, nil) —

  If SMTP requires password

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

attribute :password

#port ⇒ String^?

Returns The mail server port.

Returns:

• (String, nil) —

  The mail server port

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

attribute :port

#subject ⇒ String

Returns The subject of the email being sent.

Returns:

• (String) —

  The subject of the email being sent.

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

attribute :subject

#subtype ⇒ String^?

Returns The minor mime type, can be either text or html. The major type is always text.

Returns:

• (String, nil) —

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

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

attribute :subtype

#to ⇒ String^?

Returns The email-address(es) the mail is being sent to. This is a comma-separated list, which may contain address and phrase portions.

Returns:

• (String, nil) —

  The email-address(es) the mail is being sent to. This is a comma-separated list, which may contain address and phrase portions.

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

attribute :to

#username ⇒ String^?

Returns If SMTP requires username.

Returns:

• (String, nil) —

  If SMTP requires username

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

attribute :username