Esmith::util::network

From SME Server
Revision as of 12:30, 31 December 2013 by Stephdl (talk | contribs) (Created page with "NAME esmith::util::network - miscellaneous network utilities SYNOPSIS use esmith::util::network qw(the functions you want); my $ip = cleanIP($orig...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

NAME

      esmith::util::network - miscellaneous network utilities

SYNOPSIS

      use esmith::util::network qw(the functions you want);
      my $ip       = cleanIP($orig_ip); my $is_valid = isValidIP($ip); my $is_valid = isValidPort($port);

DESCRIPTION

      This is a collection of generally useful functions for working with IP addresses.
      Functions are exported only on request.
      Functions
      cleanIP
          my $ip = cleanIP($orig_ip);
          If the $orig_ip is valid it will be cleaned up into a cannonical form, stripping any padding zeros and such.
      isValidIP
          my $is_valid = isValidIP($ip);
          Returns the IP given if $ip is a properly formatted IP address, undef otherwise.
      isValidPort
          my $is_valid = isValidPort($port);
          Returns true if $port is a properly formatted port, false otherwise.
      cmpIP
          Performs a cmp operation on two IP addresses.
      isValidHostname
          This function returns true if it is passed a valid RFC 921 hostname, false otherwise.
      isValidEmail
          This validation function validates an email address, using the Mail::RFC822::Address module. Additionally, by default, it permits a local address instead of a fully-qualified remote address,
          even checking the existence of said user in the accounts db.
          If you don't wish to permit local addresses, pass the permitlocal option as false.
          ie. esmith::util::isValidEmail($address, { permitlocal => 0 })

AUTHOR

      Mitel Networks Corp.