Puppet Function: validate_email_address

Defined in:
puppet/modules/stdlib/lib/puppet/parser/functions/validate_email_address.rb
Function type:
Ruby 3.x API

Overview

validate_email_address() ⇒ Any

Validate that all values passed are valid email addresses. Fail compilation if any value fails this check. The following values will pass: $my_email = “waldo@gmail.com” validate_email_address($my_email) validate_email_address(“bob@gmail.com”, “alice@gmail.com”, $my_email)

The following values will fail, causing compilation to abort: $some_array = [ 'bad_email@/d/efdf.com' ] validate_email_address($some_array)

Returns:

  • (Any) 


2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'puppet/modules/stdlib/lib/puppet/parser/functions/validate_email_address.rb', line 2

newfunction(:validate_email_address, :doc => <<-ENDHEREDOC
  Validate that all values passed are valid email addresses.
  Fail compilation if any value fails this check.
  The following values will pass:
  $my_email = "waldo@gmail.com"
  validate_email_address($my_email)
  validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email)

  The following values will fail, causing compilation to abort:
  $some_array = [ 'bad_email@/d/efdf.com' ]
  validate_email_address($some_array)
  ENDHEREDOC
           ) do |args|
  rescuable_exceptions = [ArgumentError]

  if args.empty?
    raise Puppet::ParseError, "validate_email_address(): wrong number of arguments (#{args.length}; must be > 0)"
  end

  args.each do |arg|
    raise Puppet::ParseError, "#{arg.inspect} is not a string." unless arg.is_a?(String)

    begin
      raise Puppet::ParseError, "#{arg.inspect} is not a valid email address" unless function_is_email_address([arg])
    rescue *rescuable_exceptions
      raise Puppet::ParseError, "#{arg.inspect} is not a valid email address"
    end
  end
end