Skip to main content

Zymba Documentation

Mail.MultipartMessage

object @Mail.MultipartMessage(@Mail.Message) {
construct() {}
addPart(@Mail.Message $message): $this {}
attach(string $string, string $filename, string $type): object {}
attachFile(string $path, ?string $filename, string $type): object {}
clearParts(): $this {}
countParts(): int {}
getBoundary(): string {}
listParts(): object {}
removePart(@Mail.Message $message): $this {}
setBoundary(string $boundary): $this {}
}

Multipart mail message prototype.

Prototype

Mail.Message

Methods

$this.construct(): void
$this.addPart(@Mail.Message $message): this
Parameters
NameTypeValueDefault
message@Mail.Messagenull
Returns
TypeValue
$this
$this.attach(string $string, string $filename, string $type): @Mail.SimpleMessage
Parameters
NameTypeValueDefault
stringstring""
filenamestring""
typestring"application/octet-stream"
Returns
TypeValue
@Mail.SimpleMessage
$this.attachFile(string $path, ?string $filename, string $type): @Mail.SimpleMessage
Parameters
NameTypeValueDefault
pathstring""
filename?stringderived from path
typestring"application/octet-stream"
Returns
TypeValue
@Mail.SimpleMessage
$this.clearParts(): this
Returns
TypeValue
$this
$this.countParts(): int
Returns
TypeValue
int

Gets the boundary delimiter of this message.

$this.getBoundary(): string
Returns
TypeValue
string
$this.listParts(): object
Returns
TypeValue
object[message, ...]
$this.removePart(@Mail.Message $message): this
Parameters
NameTypeValueDefault
message@Mail.Messagenull
Returns
TypeValue
$this

Sets the boundary delimiter of this message.

$this.setBoundary(string $boundary): this
Parameters
NameTypeValueDefault
boundarystring""
Returns
TypeValue
$this