Class: Ansible::Ruby::Modules::Sendgrid

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/notification/sendgrid.rb

Overview

Sends an email with a SendGrid account through their API, not through the SMTP service.

Instance Method Summary

• #api_key ⇒ Object^?

  Sendgrid API key to use instead of username/password.

• #attachments ⇒ Object^?

  A list of relative or explicit paths of files you want to attach (7MB limit as per SendGrid docs).

• #bcc ⇒ Object^?

  A list of email addresses to bcc.

• #cc ⇒ Object^?

  A list of email addresses to cc.

• #from_address ⇒ String

  The address in the “from” field for the email.

• #from_name ⇒ Object^?

  The name you want to appear in the from field, i.e ‘John Doe’.

• #headers ⇒ Object^?

  A dict to pass on as headers.

• #html_body ⇒ :yes, ...

  Whether the body is html content that should be rendered.

• #password ⇒ String^?

  Password that corresponds to the username,Since 2.2 it is only required if api_key is not supplied.

• #subject ⇒ String

  The desired subject for the email.

• #to_addresses ⇒ Array<String>, String

  A list with one or more recipient email addresses.

• #username ⇒ String^?

  Username for logging into the SendGrid account.,Since 2.2 it is only required if api_key is not supplied.

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#api_key ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/notification/sendgrid.rb', line 32

attribute :api_key

#attachments ⇒ Object^?

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

attribute :attachments

#bcc ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/notification/sendgrid.rb', line 38

attribute :bcc

#cc ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/notification/sendgrid.rb', line 35

attribute :cc

#from_address ⇒ String

# File 'lib/ansible/ruby/modules/generated/notification/sendgrid.rb', line 20

attribute :from_address

#from_name ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/notification/sendgrid.rb', line 44

attribute :from_name

#headers ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/notification/sendgrid.rb', line 51

attribute :headers

#html_body ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/notification/sendgrid.rb', line 47

attribute :html_body

#password ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/notification/sendgrid.rb', line 16

attribute :password

#subject ⇒ String

# File 'lib/ansible/ruby/modules/generated/notification/sendgrid.rb', line 28

attribute :subject

#to_addresses ⇒ Array<String>, String

# File 'lib/ansible/ruby/modules/generated/notification/sendgrid.rb', line 24

attribute :to_addresses

#username ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/notification/sendgrid.rb', line 12

attribute :username