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.

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]

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

Copyright: 2012-2017 Horde LLC
License: http://www.horde.org/licenses/bsd New BSD License
File Size: 539 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Horde_Mail_Rfc822_List:: (28 methods):
  __construct()
  __get()
  add()
  remove()
  unique()
  groupCount()
  setIteratorFilter()
  _writeAddress()
  match()
  contains()
  first()
  _normalize()
  offsetExists()
  offsetGet()
  offsetSet()
  offsetUnset()
  count()
  current()
  key()
  next()
  rewind()
  valid()
  seek()
  _iteratorFilter()
  serialize()
  unserialize()
  __serialize()
  __unserialize()


Class: Horde_Mail_Rfc822_List  - X-Ref

Container object for a collection of RFC 822 elements.

__construct($obs = null)   X-Ref
Constructor.

param: mixed $obs  Address data to store in this object.

__get($name)   X-Ref
No description

add($obs)   X-Ref
Add objects to the container.

param: mixed $obs  Address data to store in this object.

remove($obs)   X-Ref
Remove addresses from the container. This method ignores Group objects.

param: mixed $obs  Addresses to remove.

unique()   X-Ref
Removes duplicate addresses from list. This method ignores Group
objects.


groupCount()   X-Ref
Group count.

return: integer  The number of groups in the list.

setIteratorFilter($mask = 0, $filter = null)   X-Ref
Set the Iterator filter.

param: integer $mask  Filter masks.
param: mixed $filter  An e-mail, or as list of e-mails, to filter by.

_writeAddress($opts)   X-Ref
No description

match($ob)   X-Ref
No description

contains($address)   X-Ref
Does this list contain the given e-mail address?

param: mixed $address  An e-mail address.
return: boolean  True if the e-mail address is contained in the list.

first()   X-Ref
Convenience method to return the first element in a list.

Useful since it allows chaining; older PHP versions did not allow array
access dereferencing from the results of a function call.

return: Horde_Mail_Rfc822_Object  Rfc822 object, or null if no object.

_normalize($obs)   X-Ref
Normalize objects to add to list.

param: mixed $obs  Address data to store in this object.
return: array  Entries to add.

offsetExists($offset)   X-Ref
No description

offsetGet($offset)   X-Ref
No description

offsetSet($offset, $value)   X-Ref
No description

offsetUnset($offset)   X-Ref
No description

count()   X-Ref
Address count.

return: integer  The number of addresses.

current()   X-Ref
No description

key()   X-Ref
No description

next()   X-Ref
No description

rewind()   X-Ref
No description

valid()   X-Ref
No description

seek($position)   X-Ref
No description

_iteratorFilter($ob)   X-Ref
No description

serialize()   X-Ref
No description

unserialize($data)   X-Ref
No description

__serialize()   X-Ref
No description

__unserialize(array $data)   X-Ref
No description