HumHub Documentation (unofficial)

Headers
in package

FinalYes

A collection of headers.

Tags
author

Fabien Potencier fabien@symfony.com

Table of Contents

Constants

HEADER_CLASS_MAP  = [ 'date' => \Symfony\Component\Mime\Header\DateHeader::class, 'from' => \Symfony\Component\Mime\Header\MailboxListHeader::class, 'sender' => \Symfony\Component\Mime\Header\MailboxHeader::class, 'reply-to' => \Symfony\Component\Mime\Header\MailboxListHeader::class, 'to' => \Symfony\Component\Mime\Header\MailboxListHeader::class, 'cc' => \Symfony\Component\Mime\Header\MailboxListHeader::class, 'bcc' => \Symfony\Component\Mime\Header\MailboxListHeader::class, 'message-id' => \Symfony\Component\Mime\Header\IdentificationHeader::class, 'in-reply-to' => \Symfony\Component\Mime\Header\UnstructuredHeader::class, // `In-Reply-To` and `References` are less strict than RFC 2822 (3.6.4) to allow users entering the original email's ... 'references' => \Symfony\Component\Mime\Header\UnstructuredHeader::class, // ... `Message-ID`, even if that is no valid `msg-id` 'return-path' => \Symfony\Component\Mime\Header\PathHeader::class, ]
UNIQUE_HEADERS  = ['date', 'from', 'sender', 'reply-to', 'to', 'cc', 'bcc', 'message-id', 'in-reply-to', 'references', 'subject']

Properties

$headers  : array<string|int, array<string|int, HeaderInterface>>
$lineLength  : mixed

Methods

__clone()  : mixed
__construct()  : mixed
add()  : $this
addDateHeader()  : $this
addHeader()  : $this
addIdHeader()  : $this
addMailboxHeader()  : $this
addMailboxListHeader()  : $this
addParameterizedHeader()  : $this
addPathHeader()  : $this
addTextHeader()  : $this
all()  : iterable<string|int, mixed>
checkHeaderClass()  : void
get()  : HeaderInterface|null
getHeaderParameter()  : string|null
getMaxLineLength()  : int
getNames()  : array<string|int, mixed>
has()  : bool
isUniqueHeader()  : bool
remove()  : void
setMaxLineLength()  : mixed
toArray()  : array<string|int, mixed>
toString()  : string

Constants

HEADER_CLASS_MAP

private mixed HEADER_CLASS_MAP = [ 'date' => \Symfony\Component\Mime\Header\DateHeader::class, 'from' => \Symfony\Component\Mime\Header\MailboxListHeader::class, 'sender' => \Symfony\Component\Mime\Header\MailboxHeader::class, 'reply-to' => \Symfony\Component\Mime\Header\MailboxListHeader::class, 'to' => \Symfony\Component\Mime\Header\MailboxListHeader::class, 'cc' => \Symfony\Component\Mime\Header\MailboxListHeader::class, 'bcc' => \Symfony\Component\Mime\Header\MailboxListHeader::class, 'message-id' => \Symfony\Component\Mime\Header\IdentificationHeader::class, 'in-reply-to' => \Symfony\Component\Mime\Header\UnstructuredHeader::class, // `In-Reply-To` and `References` are less strict than RFC 2822 (3.6.4) to allow users entering the original email's ... 'references' => \Symfony\Component\Mime\Header\UnstructuredHeader::class, // ... `Message-ID`, even if that is no valid `msg-id` 'return-path' => \Symfony\Component\Mime\Header\PathHeader::class, ]

UNIQUE_HEADERS

private mixed UNIQUE_HEADERS = ['date', 'from', 'sender', 'reply-to', 'to', 'cc', 'bcc', 'message-id', 'in-reply-to', 'references', 'subject']

Properties

$lineLength

private mixed $lineLength = 76

Methods

addDateHeader()

public addDateHeader(string $name, DateTimeInterface $dateTime) : $this
Parameters
$name : string
$dateTime : DateTimeInterface
Return values
$this

addHeader()

public addHeader(string $name, mixed $argument[, array<string|int, mixed> $more = [] ]) : $this
Parameters
$name : string
$argument : mixed
$more : array<string|int, mixed> = []
Return values
$this

addIdHeader()

public addIdHeader(string $name, string|array<string|int, mixed> $ids) : $this
Parameters
$name : string
$ids : string|array<string|int, mixed>
Return values
$this

addMailboxHeader()

public addMailboxHeader(string $name, Address|string $address) : $this
Parameters
$name : string
$address : Address|string
Return values
$this

addMailboxListHeader()

public addMailboxListHeader(string $name, array<string|int, Address|string> $addresses) : $this
Parameters
$name : string
$addresses : array<string|int, Address|string>
Return values
$this

addParameterizedHeader()

public addParameterizedHeader(string $name, string $value[, array<string|int, mixed> $params = [] ]) : $this
Parameters
$name : string
$value : string
$params : array<string|int, mixed> = []
Return values
$this

addPathHeader()

public addPathHeader(string $name, Address|string $path) : $this
Parameters
$name : string
$path : Address|string
Return values
$this

addTextHeader()

public addTextHeader(string $name, string $value) : $this
Parameters
$name : string
$value : string
Return values
$this

all()

public all([string|null $name = null ]) : iterable<string|int, mixed>
Parameters
$name : string|null = null
Return values
iterable<string|int, mixed>

getHeaderParameter()

public getHeaderParameter(string $name, string $parameter) : string|null
Parameters
$name : string
$parameter : string
Return values
string|null

getMaxLineLength()

public getMaxLineLength() : int
Return values
int

getNames()

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

has()

public has(string $name) : bool
Parameters
$name : string
Return values
bool

isUniqueHeader()

public static isUniqueHeader(string $name) : bool
Parameters
$name : string
Return values
bool

remove()

public remove(string $name) : void
Parameters
$name : string

setMaxLineLength()

public setMaxLineLength(int $lineLength) : mixed
Parameters
$lineLength : int

toArray()

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

toString()

public toString() : string
Return values
string 
Loading…
On this page

Search results