Puppet Function: is_email_address

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

Overview

is_email_address()Boolean

> *Note: *Deprecated* Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).

Returns:

  • (Boolean)

    Returns `true` or `false`



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# File 'modules/stdlib/lib/puppet/parser/functions/is_email_address.rb', line 5

newfunction(:is_email_address, :type => :rvalue, :doc => <<-DOC
  @summary
    **Deprecated:** Returns true if the string passed to this function is a valid email address.

  @return [Boolean]
    Returns `true` or `false`

  > **Note:* **Deprecated** Will be removed in a future version of stdlib. See
  [`validate_legacy`](#validate_legacy).
  DOC
           ) do |arguments|
  if arguments.size != 1
    raise(Puppet::ParseError, "is_email_address(): Wrong number of arguments given #{arguments.size} for 1")
  end

  # Taken from http://emailregex.com/ (simpler regex)
  valid_email_regex = %r{\A([\w+\-].?)+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z}
  return (arguments[0] =~ valid_email_regex) == 0 # rubocop:disable Style/NumericPredicate : Changing to '.zero?' breaks the code
end