API Documentation
\

\Horde_Release_MailingList

Announce releases on the mailing lists.

Copyright 2011-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.

Summary

Methods
Properties
Constants
__construct()
getHeaders()
append()
getBody()
getMail()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
_isLatest()
$_component
$_name
$_branch
$_from
$_list
$_version
$_security
$_body
N/A

Properties

$_component

$_component :

Component name.

Type

$_name

$_name :

Component release name.

Type

$_branch

$_branch :

Branch name.

Type

$_from

$_from :

Message sender.

Type

$_list

$_list :

The mailing list to send to.

Type

$_version

$_version :

The version to be released.

Type

$_security

$_security :

Security release?

Type

$_body

$_body :

The message body.

Type

Methods

__construct()

__construct(string  $component, string  $name, string  $branch, string  $from, string  $list, string  $version, boolean  $security)

Constructor.

Parameters

string $component

The component name.
string $name

The component release name.
string $branch

The component branch (H3, H4, ...).
string $from

The mail address of the person sending the announcement.
string $list

The mailing list the announcement should be sent to.
string $version

The version to be released.
boolean $security

Whether it's a security release.

getHeaders()

getHeaders() : array

Retrieve the message headers for the announcement mail.

Returns

array —

A set of message headers.

append()

append(string  $text) : NULL

Append text to the message body.

Parameters

string $text

The text to be appended.

Returns

NULL

getBody()

getBody() : string

Return the complete message body.

Returns

string —

The message body.

getMail()

getMail() : \Horde_Mime_Mail

Return the Horde_Mime_Mail message.

Returns

\Horde_Mime_Mail —

The message.

_isLatest()

_isLatest() : boolean

Check if this is a final release.

Returns

boolean —

True if this is no prerelease version.