Documentation

Horde_Release_MailingList
in package

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.

Tags
category

Horde

author

Mike Hardy

author

Jan Schneider jan@horde.org

author

Gunnar Wrobel wrobel@pardus.de

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

link
http://www.horde.org/libraries/Horde_Release

Table of Contents

$_body  : mixed
The message body.
$_branch  : mixed
Branch name.
$_component  : mixed
Component name.
$_from  : mixed
Message sender.
$_list  : mixed
The mailing list to send to.
$_name  : mixed
Component release name.
$_security  : mixed
Security release?
$_version  : mixed
The version to be released.
__construct()  : mixed
Constructor.
append()  : null
Append text to the message body.
getBody()  : string
Return the complete message body.
getHeaders()  : array<string|int, mixed>
Retrieve the message headers for the announcement mail.
getMail()  : Horde_Mime_Mail
Return the Horde_Mime_Mail message.
_isLatest()  : bool
Check if this is a final release.

Properties

$_component

Component name.

private mixed $_component

$_list

The mailing list to send to.

private mixed $_list

$_security

Security release?

private mixed $_security

$_version

The version to be released.

private mixed $_version

Methods

__construct()

Constructor.

public __construct(string $component, string $name, string $branch, string $from, string $list, string $version, bool $security) : mixed
Parameters
$component : string

The component name.

$name : string

The component release name.

$branch : string

The component branch (H3, H4, ...).

$from : string

The mail address of the person sending the announcement.

$list : string

The mailing list the announcement should be sent to.

$version : string

The version to be released.

$security : bool

Whether it's a security release.

Return values
mixed —

append()

Append text to the message body.

public append(string $text) : null
Parameters
$text : string

The text to be appended.

Return values
null —

getBody()

Return the complete message body.

public getBody() : string
Return values
string —

The message body.

getHeaders()

Retrieve the message headers for the announcement mail.

public getHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed> —

A set of message headers.

getMail()

Return the Horde_Mime_Mail message.

public getMail() : Horde_Mime_Mail
Return values
Horde_Mime_Mail —

The message.

_isLatest()

Check if this is a final release.

private _isLatest() : bool
Return values
bool —

True if this is no prerelease version.

Search results