Module: SendGrid
- Defined in:
- lib/sendgrid.rb
Defined Under Namespace
Modules: ClassMethods
Constant Summary collapse
- VALID_OPTIONS =
[ :opentrack, :clicktrack, :ganalytics, :gravatar, :subscriptiontrack, :footer, :spamcheck, :bypass_list_management ]
Class Method Summary collapse
Instance Method Summary collapse
-
#create!(method_name, *parameters) ⇒ Object
Sets the custom X-SMTPAPI header after creating the email but before delivery NOTE: This override is used for Rails 2 ActionMailer classes.
-
#sendgrid_category(category) ⇒ Object
Call within mailer method to override the default value.
-
#sendgrid_disable(*options) ⇒ Object
Call within mailer method to remove one of the defaults.
-
#sendgrid_enable(*options) ⇒ Object
Call within mailer method to add an option not in the defaults.
-
#sendgrid_footer_text(texts) ⇒ Object
Call within mailer method to override the default value.
-
#sendgrid_recipients(emails) ⇒ Object
Call within mailer method to add an array of recipients.
-
#sendgrid_spamcheck_maxscore(score) ⇒ Object
Call within mailer method to override the default value.
-
#sendgrid_subscriptiontrack_text(texts) ⇒ Object
Call within mailer method to override the default value.
-
#sendgrid_substitute(placeholder, subs) ⇒ Object
Call within mailer method to add an array of substitions NOTE: you must ensure that the length of the substitions equals the length of the sendgrid_recipients.
Class Method Details
.included(base) ⇒ Object
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
# File 'lib/sendgrid.rb', line 16 def self.included(base) base.class_eval do class << self attr_accessor :default_sg_category, :default_sg_options, :default_subscriptiontrack_text, :default_footer_text, :default_spamcheck_score end attr_accessor :sg_category, :sg_options, :sg_disabled_options, :sg_recipients, :sg_substitutions, :subscriptiontrack_text, :footer_text, :spamcheck_score end # NOTE: This commented-out approach may be a "safer" option for Rails 3, but it # would cause the headers to get set during delivery, and not when the message is initialized. # If base supports register_interceptor (i.e., Rails 3 ActionMailer), use it... # if base.respond_to?(:register_interceptor) # base.register_interceptor(SendgridInterceptor) # end base.extend(ClassMethods) end |
Instance Method Details
#create!(method_name, *parameters) ⇒ Object
Sets the custom X-SMTPAPI header after creating the email but before delivery NOTE: This override is used for Rails 2 ActionMailer classes.
133 134 135 136 137 138 139 140 141 142 |
# File 'lib/sendgrid.rb', line 133 def create!(method_name, *parameters) super if @sg_substitutions && !@sg_substitutions.empty? @sg_substitutions.each do |find, replace| raise ArgumentError.new("Array for #{find} is not the same size as the recipient array") if replace.size != @sg_recipients.size end end puts "SendGrid X-SMTPAPI: #{sendgrid_json_headers(mail)}" if Object.const_defined?("SENDGRID_DEBUG_OUTPUT") && SENDGRID_DEBUG_OUTPUT @mail['X-SMTPAPI'] = sendgrid_json_headers(mail) end |
#sendgrid_category(category) ⇒ Object
Call within mailer method to override the default value.
86 87 88 |
# File 'lib/sendgrid.rb', line 86 def sendgrid_category(category) @sg_category = category end |
#sendgrid_disable(*options) ⇒ Object
Call within mailer method to remove one of the defaults.
97 98 99 100 |
# File 'lib/sendgrid.rb', line 97 def sendgrid_disable(*) @sg_disabled_options = Array.new unless @sg_disabled_options .each { |option| @sg_disabled_options << option if VALID_OPTIONS.include?(option) } end |
#sendgrid_enable(*options) ⇒ Object
Call within mailer method to add an option not in the defaults.
91 92 93 94 |
# File 'lib/sendgrid.rb', line 91 def sendgrid_enable(*) @sg_options = Array.new unless @sg_options .each { |option| @sg_options << option if VALID_OPTIONS.include?(option) } end |
#sendgrid_footer_text(texts) ⇒ Object
Call within mailer method to override the default value.
122 123 124 |
# File 'lib/sendgrid.rb', line 122 def (texts) @footer_text = texts end |
#sendgrid_recipients(emails) ⇒ Object
Call within mailer method to add an array of recipients
103 104 105 106 |
# File 'lib/sendgrid.rb', line 103 def sendgrid_recipients(emails) @sg_recipients = Array.new unless @sg_recipients @sg_recipients = emails end |
#sendgrid_spamcheck_maxscore(score) ⇒ Object
Call within mailer method to override the default value.
127 128 129 |
# File 'lib/sendgrid.rb', line 127 def sendgrid_spamcheck_maxscore(score) @spamcheck_score = score end |
#sendgrid_subscriptiontrack_text(texts) ⇒ Object
Call within mailer method to override the default value.
117 118 119 |
# File 'lib/sendgrid.rb', line 117 def sendgrid_subscriptiontrack_text(texts) @subscriptiontrack_text = texts end |
#sendgrid_substitute(placeholder, subs) ⇒ Object
Call within mailer method to add an array of substitions NOTE: you must ensure that the length of the substitions equals the
length of the sendgrid_recipients.
111 112 113 114 |
# File 'lib/sendgrid.rb', line 111 def sendgrid_substitute(placeholder, subs) @sg_substitutions = Hash.new unless @sg_substitutions @sg_substitutions[placeholder] = subs end |