Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/horde/framework/Horde/Imap/Client/Data/Format/ -> String.php (source)

[Source view]

Copyright 2012-2017 Horde LLC (http://www.horde.org/) See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Copyright: 2012-2017 Horde LLC
License: http://www.horde.org/licenses/lgpl21 LGPL 2.1
File Size: 219 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Horde_Imap_Client_Data_Format_String:: (13 methods):
  __construct()
  _filterParams()
  __toString()
  escape()
  escapeStream()
  quoted()
  forceQuoted()
  literal()
  forceLiteral()
  binary()
  forceBinary()
  length()
  getStream()


Class: Horde_Imap_Client_Data_Format_String  - X-Ref

Object representation of an IMAP string (RFC 3501 [4.3]).

__construct($data, array $opts = array()   X-Ref

param: array $opts  Additional options:

_filterParams()   X-Ref
Return the base string filter parameters.

return: object  Filter parameters.

__toString()   X-Ref
No description

escape()   X-Ref
No description

escapeStream()   X-Ref
Return the escaped string as a stream.

return: resource  The IMAP escaped stream.

quoted()   X-Ref
Does this data item require quoted string output?

return: boolean  True if quoted output is required.

forceQuoted()   X-Ref
Force item to be output quoted.


literal()   X-Ref
Does this data item require literal string output?

return: boolean  True if literal output is required.

forceLiteral()   X-Ref
Force item to be output as a literal.


binary()   X-Ref
If literal output, is the data binary?

return: boolean  True if the literal output is binary.

forceBinary()   X-Ref
Force item to be output as a binary literal.


length()   X-Ref
Return the length of the data.

return: integer  Data length.

getStream()   X-Ref
Return the contents of the string as a stream object.

return: Horde_Stream  The stream object.