Zum Hauptinhalt springen

Zymba Documentation

Mail.Message

object @Mail.Message(@Base) {
clearHeaders(): $this {}
create(): string {}
getDisposition(): string {}
getFilename(): string {}
getHeader(string $name): string {}
getTransferEncoding(): string {}
getType(): string {}
isAttachment(): bool {}
listHeaders(): object {}
removeHeader(string $name): $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

$this.clearHeaders(): this
Returns
TypeValue
$this
$this.create(): string
Returns
TypeValue
string

Gets the content disposition of this message.

$this.getDisposition(): string
Returns
TypeValue
string

Gets the filename of this message.

$this.getFilename(): string
Returns
TypeValue
string
$this.getHeader(string $name): string
Parameters
NameTypeValueDefault
namestring""
Returns
TypeValue
string
object[value, ...]
null

Gets the content transfer encoding of this message.

$this.getTransferEncoding(): string
Returns
TypeValue
string

Gets the content type of this message.

$this.getType(): string
Returns
TypeValue
string
$this.isAttachment(): bool
Returns
TypeValue
bool
$this.listHeaders(): object
Returns
TypeValue
object[name: value, ...]
$this.removeHeader(string $name): this
Parameters
NameTypeValueDefault
namestring""
Returns
TypeValue
$this

Sets a mail header.

$this.setHeader(string $name, mixed $value): this
Parameters
NameTypeValueDefault
namestring""
valuemixednull
Returns
TypeValue
$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.

$this.setHeaders(object $headers, string $prefix): this
Parameters
NameTypeValueDefault
headersobject[name: value, ...][]
prefixstring""
Returns
TypeValue
$this

Sets the content disposition of this message.

$this.setDisposition(string $disposition, string $filename): this
Parameters
NameTypeValueDefault
dispositionstring""
filenamestring""
Returns
TypeValue
$this

Sets the content transfer encoding of this message.

$this.setTransferEncoding(string $encoding): this
Parameters
NameTypeValueDefault
encodingstring""
Returns
TypeValue
$this

Sets the content type of this message.

$this.setType(string $type): this
Parameters
NameTypeValueDefault
typestring""
Returns
TypeValue
$this