Zymba Documentation

Mail.Message

Text

object @Mail.Message(@Base) {
	clearHeaders(): $this {}
	countHeaders(): int {}
	create(): string {}
	getDisposition(): string {}
	getFilename(): string {}
	getHeader(string $name): string {}
	getTransferEncoding(): string {}
	getType(): string {}
	isAttachment(): bool {}
	listHeaderNames(): object {}
	listHeaders(): object {}
	removeHeader(string $name): $this {}
	removeHeaders(object $names): $this {}
	setHeader(string $name, mixed $value): $this {}
	setHeaders(object $headers, string $prefix): $this {}
	setDisposition(string $disposition, string $filename): $this {}
	setTransferEncoding(string $encoding): $this {}
	setType(string $type): $this {}
}

Abstract mail message prototype.

Prototype

Base

Methods

CODE

$this.clearHeaders(): this

Returns

Type	Value
$this

CODE

$this.countHeaders(): int

Returns

Type	Value
int

CODE

$this.create(): string

Returns

Type	Value
string

Gets the content disposition of this message.

CODE

$this.getDisposition(): string

Returns

Type	Value
string

Gets the filename of this message.

CODE

$this.getFilename(): string

Returns

Type	Value
string

CODE

$this.getHeader(string $name): string

Parameters

Name	Type	Value	Default
name	string		""

Returns

Type	Value
string
object	[value, ...]
null

Gets the content transfer encoding of this message.

CODE

$this.getTransferEncoding(): string

Returns

Type	Value
string

Gets the content type of this message.

CODE

$this.getType(): string

Returns

Type	Value
string

CODE

$this.isAttachment(): bool

Returns

Type	Value
bool

CODE

$this.listHeaderNames(): object

Returns

Type	Value
object	[name, ...]

CODE

$this.listHeaders(): object

Returns

Type	Value
object	[name: value, ...]

CODE

$this.removeHeader(string $name): this

Parameters

Name	Type	Value	Default
name	string		""

Returns

Type	Value
$this

CODE

$this.removeHeaders(object $names): this

Parameters

Name	Type	Value	Default
names	object	[name, ...]	[]

Returns

Type	Value
$this

Sets a mail header.

CODE

$this.setHeader(string $name, mixed $value): this

Parameters

Name	Type	Value	Default
name	string		""
value	mixed		null

Returns

Type	Value
$this

Sets multiple mail headers by treating slot names as header names, expanded by a specific prefix, and slot values as non-referential header values.

CODE

$this.setHeaders(object $headers, string $prefix): this

Parameters

Name	Type	Value	Default
headers	object	[name: value, ...]	[]
prefix	string		""

Returns

Type	Value
$this

Sets the content disposition of this message.

CODE

$this.setDisposition(string $disposition, string $filename): this

Parameters

Name	Type	Value	Default
disposition	string		""
filename	string		""

Returns

Type	Value
$this

Sets the content transfer encoding of this message.

CODE

$this.setTransferEncoding(string $encoding): this

Parameters

Name	Type	Value	Default
encoding	string		""

Returns

Type	Value
$this

Sets the content type of this message.

CODE

$this.setType(string $type): this

Parameters

Name	Type	Value	Default
type	string		""

Returns

Type	Value
$this