GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SYMPA::TOOLS::TEXT (3)

.ds Aq ’

NAME

Sympa::Tools::Text - Text-related functions

CONTENTS

DESCRIPTION

This package provides some text-related functions.

    Functions

addrencode ( $addr, [ $phrase, [ $charset, [ $comment ] ] ] ) Returns formatted (and encoded) name-addr as RFC5322 3.4.
canonic_email ( $email ) Function. Returns canonical form of e-mail address.

Leading and trailing whilte spaces are removed. Latin letters without accents are lower-cased.

For malformed inputs returns undef.

canonic_message_id ( $message_id ) Returns canonical form of message ID without trailing or leading whitespaces or <, >.
wrap_text ( $text, [ $init_tab, [ $subsequent_tab, [ $cols ] ] ] ) Function. Returns line-wrapped text.

Parameters:
$text The text to be folded.
$init_tab Indentation prepended to the first line of paragraph. Default is , no indentation.
$subsequent_tab Indentation prepended to each subsequent line of folded paragraph. Default is , no indentation.
$cols Max number of columns of folded text. Default is 78.

decode_html ( $str ) Function. Decodes HTML entities in a string encoded by UTF-8 or a Unicode string.

Parameter:
$str String to be decoded.

Returns:

Decoded string, stripped utf8 flag if any.

decode_filesystem_safe ( $str ) Function. Decodes a string encoded by encode_filesystem_safe().

Parameter:
$str String to be decoded.

Returns:

Decoded string, stripped utf8 flag if any.

encode_html ( $str ) Function. Encodes characters in a string $str to HTML entities. <, >, & and " are encoded.

Parameter:
$str String to be encoded.

Returns:

Encoded string, not stripping utf8 flag if any.

encode_filesystem_safe ( $str ) Function. Encodes a string $str to be suitable for filesystem.

Parameter:
$str String to be encoded.

Returns:

Encoded string, stripped utf8 flag if any. All bytes except -, +, ., @ and alphanumeric characters are encoded to sequences _ followed by two hexdigits.

Note that / will also be encoded.

encode_uri ( $str, [ omit => $chars ] ) TBD

Parameters:
$str String to be encoded.
omit => $chars By default, all characters except those defined as unreserved in RFC 3986 are encoded, that is, [^-A-Za-z0-9._~]. If this parameter is given, it will prevent encoding additional characters.

Returns:

Encoded string, stripped utf8 flag if any.

escape_chars ( $str ) Escape weird characters.

ToDo: This should be obsoleted in the future release: Would be better to use encode_filesystem_safe.

escape_url ( $str ) DEPRECATED. Would be better to use encode_uri or mailtourl.
foldcase ( $str ) Function. Returns fold-case string suitable for case-insensitive match. For example, a code below looks for a needle in haystack not regarding case, even if they are non-ASCII UTF-8 strings.



  $haystack = Sympa::Tools::Text::foldcase($HayStack);
  $needle   = Sympa::Tools::Text::foldcase($NeedLe);
  if (index $haystack, $needle >= 0) {
      ...
  }



Parameter:
$str A string.

mailtourl ( $email, [ decode_html => 1 ], [ query => {key => val, ...} ] ) Constructs a mailto: URL for given e-mail.

Parameters:
$email E-mail address.
decode_html => 1 If set, arguments are assumed to include HTML entities.
query => {key => val, ...} Optional query.

Returns:

Constructed URL.

qdecode_filename ( $filename ) Q-Decodes web file name.

ToDo: This should be obsoleted in the future release: Would be better to use decode_filesystem_safe.

qencode_filename ( $filename ) Q-Encodes web file name.

ToDo: This should be obsoleted in the future release: Would be better to use encode_filesystem_safe.

unescape_chars ( $str ) Unescape weird characters.

ToDo: This should be obsoleted in the future release: Would be better to use decode_filesystem_safe.

valid_email ( $string ) Basic check of an email address.

HISTORY

Sympa::Tools::Text appeared on Sympa 6.2a.41.

decode_filesystem_safe() and encode_filesystem_safe() were added on Sympa 6.2.10.

decode_html(), encode_html(), encode_uri() and mailtourl() were added on Sympa 6.2.14, and escape_url() was deprecated.

Search for    or go to Top of page |  Section 3 |  Main Index


6.2.14 SYMPA::TOOLS::TEXT (3Sympa) 2016-02-26

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.