class Sendgrid::Web::ParseWebhookSettings

Public Instance Methods

delete(hostname: nil) click to toggle source

Delete the existing settings for parsing incoming emails.

@param hostname [String] The hostname (domain or subdomain) for

which you would like to configure a Parse Webhook callback URL.

@return [Sendgrid::Web::Response] The sendgrid response @note hostname is a required parameter.

# File lib/sendgrid/web/parse_webhook_settings.rb, line 67
def delete(hostname: nil)
  if hostname.nil?
    raise ArgumentError.new('Missing required `hostname` option')
  end
  res = connection.post(
    '/api/parse.delete.json',
    default_params(hostname: hostname))
  craft_response(res)
end
edit(hostname: nil, url: nil, spam_check: nil) click to toggle source

Edit your existing settings for parsing incoming emails.

@param hostname [String] The hostname (domain or subdomain) for

which you would like to configure a Parse Webhook callback URL.

@param url [String] The callback URL to which Parse Webhook

payloads will be POSTed.

@param spam_check [Integer] If spam check is enabled, messages

that look like spam will not be POSTed.

@return [Sendgrid::Web::Response] The sendgrid response @note hostname and url are required parameters.

# File lib/sendgrid/web/parse_webhook_settings.rb, line 46
def edit(hostname: nil, url: nil, spam_check: nil)
  if hostname.nil?
    raise ArgumentError.new('Missing required `hostname` option')
  elsif url.nil?
    raise ArgumentError.new('Missing required `url` option')
  end
  res = connection.post(
    '/api/parse.edit.json',
    default_params(
      hostname: hostname,
      url: url,
      spam_check: spam_check))
  craft_response(res)
end
get() click to toggle source

Retrieve settings already configured for parsing incoming email.

@return [Sendgrid::Web::Response] The sendgrid response

# File lib/sendgrid/web/parse_webhook_settings.rb, line 6
def get
  res = connection.post('/api/parse.get.json', default_params)
  craft_response(res)
end
set(hostname: nil, url: nil, spam_check: nil) click to toggle source

Specify the hostname and url for parsing incoming emails.

@param hostname [String] The hostname (domain or subdomain) for

which you would like to configure a Parse Webhook callback URL.

@param url [String] The callback URL to which Parse Webhook

payloads will be POSTed.

@param spam_check [Integer] If spam check is enabled, messages

that look like spam will not be POSTed.

@return [Sendgrid::Web::Response] The sendgrid response @note hostname and url are required parameters.

# File lib/sendgrid/web/parse_webhook_settings.rb, line 21
def set(hostname: nil, url: nil, spam_check: nil)
  if hostname.nil?
    raise ArgumentError.new('Missing required `hostname` option')
  elsif url.nil?
    raise ArgumentError.new('Missing required `url` option')
  end
  res = connection.post(
    '/api/parse.set.json',
    default_params(
      hostname: hostname,
      url: url,
      spam_check: spam_check))
  craft_response(res)
end