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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/notification/sendgrid.rb

Overview

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

Instance Method Summary collapse

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

#from_address ⇒ String

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

Returns:

  • (String) —

    the address in the “from” field for the email



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

attribute :from_address

#password ⇒ String

Returns password that corresponds to the username.

Returns:

  • (String) —

    password that corresponds to the username



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

attribute :password

#subject ⇒ String

Returns the desired subject for the email.

Returns:

  • (String) —

    the desired subject for the email



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

attribute :subject

#to_addresses ⇒ Array<String>, String

Returns a list with one or more recipient email addresses.

Returns:

  • (Array<String>, String) —

    a list with one or more recipient email addresses



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

attribute :to_addresses

#username ⇒ String

Returns username for logging into the SendGrid account.

Returns:

  • (String) —

    username for logging into the SendGrid account



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

attribute :username