Class: SPF::Query::Modifier

Inherits:

Object

• Object
• SPF::Query::Modifier

Defined in:

lib/spf/query/modifier.rb

Overview

Represents SPF record modifiers.

Direct Known Subclasses

UnknownModifier

Instance Attribute Summary

• #name ⇒ Symbol readonly

  Modifier name.

• #value ⇒ String, ... readonly

  Modifier value.

Instance Method Summary

• #initialize(name, value = nil) ⇒ Modifier constructor

  Initializes the modifier.

• #to_s ⇒ String

  Converts the modifier to a String.

Constructor Details

#initialize(name, value = nil) ⇒ Modifier

Initializes the modifier.

Parameters:

• name (Symbol) —

  Modifier name.

• value (String, nil) (defaults to: nil) —

  Modifier value.

# File 'lib/spf/query/modifier.rb', line 27

def initialize(name,value=nil)
  @name, @value = name, value
end

Instance Attribute Details

#name ⇒ Symbol (readonly)

Modifier name.

Returns:

• (Symbol)

# File 'lib/spf/query/modifier.rb', line 11

def name
  @name
end

#value ⇒ String, ... (readonly)

Modifier value.

Returns:

• (String, MacroString, IP, nil)

# File 'lib/spf/query/modifier.rb', line 16

def value
  @value
end

Instance Method Details

#to_s ⇒ String

Converts the modifier to a String.

Returns:

• (String)

# File 'lib/spf/query/modifier.rb', line 36

def to_s
  if @value then "#{@name}=#{@value}"
  else           "#{@name}"
  end
end