Puppet Function: validate_email_address

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

Overview

validate_email_address()Any

Examples:

*Usage*


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)

    Fail compilation if any value fails this check.



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
31
32
33
34
35
36
37
38
39
40
41
42
# File 'modules/stdlib/lib/puppet/parser/functions/validate_email_address.rb', line 5

newfunction(:validate_email_address, :doc => <<-DOC
  @summary
    Validate that all values passed are valid email addresses.
    Fail compilation if any value fails this check.

  @return
    Fail compilation if any value fails this check.

  @example **Usage**

    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)
  DOC
           ) 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