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

Inherits:
Base show all
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 collapse

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?

Returns sendgrid API key to use instead of username/password.

Returns:

  • (Object, nil) —

    sendgrid API key to use instead of username/password



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

attribute :api_key

#attachments ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :attachments

#bcc ⇒ Object?

Returns a list of email addresses to bcc.

Returns:

  • (Object, nil) —

    a list of email addresses to bcc



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

attribute :bcc

#cc ⇒ Object?

Returns a list of email addresses to cc.

Returns:

  • (Object, nil) —

    a list of email addresses to cc



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

attribute :cc

#from_address ⇒ String

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

Returns:

  • (String) —

    the address in the “from” field for the email



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

attribute :from_address

#from_name ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :from_name

#headers ⇒ Object?

Returns a dict to pass on as headers.

Returns:

  • (Object, nil) —

    a dict to pass on as headers



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

attribute :headers

#html_body ⇒ :yes, ...

Returns whether the body is html content that should be rendered.

Returns:

  • (:yes, :no, nil) —

    whether the body is html content that should be rendered



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

attribute :html_body

#password ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :password

#subject ⇒ String

Returns the desired subject for the email.

Returns:

  • (String) —

    the desired subject for the email



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

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



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

attribute :to_addresses

#username ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :username