Swift_Signers_OpenDKIMSigner Class Reference

TYPO3 7.6

Inheritance diagram for Swift_Signers_OpenDKIMSigner:

Public Member Functions
	__construct ($privateKey, $domainName, $selector)

	addSignature (Swift_Mime_HeaderSet $headers)

	setHeaders (Swift_Mime_HeaderSet $headers)

	startBody ()

	endBody ()

	reset ()

	setSignatureTimestamp ($time)

	setSignatureExpiration ($time)

	setDebugHeaders ($debug)

Public Member Functions inherited from Swift_Signers_DKIMSigner
	__construct ($privateKey, $domainName, $selector)

	reset ()

	write ($bytes)

	commit ()

	bind (Swift_InputByteStream $is)

	unbind (Swift_InputByteStream $is)

	flushBuffers ()

	setHashAlgorithm ($hash)

	setBodyCanon ($canon)

	setHeaderCanon ($canon)

	setSignerIdentity ($identity)

	setBodySignedLen ($len)

	setSignatureTimestamp ($time)

	setSignatureExpiration ($time)

	setDebugHeaders ($debug)

	startBody ()

	endBody ()

	getAlteredHeaders ()

	ignoreHeader ($header_name)

	setHeaders (Swift_Mime_HeaderSet $headers)

	addSignature (Swift_Mime_HeaderSet $headers)

Static Public Member Functions
static	newInstance ($privateKey, $domainName, $selector)

Static Public Member Functions inherited from Swift_Signers_DKIMSigner
static	newInstance ($privateKey, $domainName, $selector)

Public Attributes
const	CANON_RELAXED = 1

const	CANON_SIMPLE = 2

const	SIG_RSA_SHA1 = 3

const	SIG_RSA_SHA256 = 4

Protected Member Functions
	_canonicalizeBody ($string)

Protected Member Functions inherited from Swift_Signers_DKIMSigner
	_addHeader ($header, $is_sig=false)

	_endOfHeaders ()

	_canonicalizeBody ($string)

	_endOfBody ()

Private Attributes
	$_peclLoaded = false

	$_dkimHandler = null

	$dropFirstLF = true

Additional Inherited Members
Protected Attributes inherited from Swift_Signers_DKIMSigner
	$_privateKey

	$_domainName

	$_selector

	$_hashAlgorithm = 'rsa-sha1'

	$_bodyCanon = 'simple'

	$_headerCanon = 'simple'

	$_ignoredHeaders = array()

	$_signerIdentity

	$_bodyLen = 0

	$_maxLen = PHP_INT_MAX

	$_showLen = false

	$_signatureTimestamp = true

	$_signatureExpiration = false

	$_debugHeaders = false

	$_signedHeaders = array()

	$_dkimHeader

Detailed Description

DKIM Signer used to apply DKIM Signature to a message Takes advantage of pecl extension.

Author: Xavier De Cock xdeco.nosp@m.ck@g.nosp@m.mail..nosp@m.com

Definition at line 17 of file OpenDKIMSigner.php.

Constructor & Destructor Documentation

__construct	(		$privateKey,
			$domainName,
			$selector
	)

Definition at line 30 of file OpenDKIMSigner.php.

Member Function Documentation

_canonicalizeBody ( $string )

protected

Definition at line 174 of file OpenDKIMSigner.php.

addSignature ( Swift_Mime_HeaderSet $headers )

Add the header(s) to the headerSet.

Parameters

Swift_Mime_HeaderSet $headers

Returns: Swift_Signers_HeaderSigner

Implements Swift_Signers_HeaderSigner.

Definition at line 45 of file OpenDKIMSigner.php.

References Swift_Mime_HeaderSet\set().

endBody ( )

Give the signal that the body has finished streaming.

Returns: Swift_Signers_HeaderSigner

Implements Swift_Signers_HeaderSigner.

Definition at line 112 of file OpenDKIMSigner.php.

static newInstance	(		$privateKey,
			$domainName,
			$selector
	)

static

Definition at line 40 of file OpenDKIMSigner.php.

reset ( )

Implements Swift_Signer.

Definition at line 122 of file OpenDKIMSigner.php.

setDebugHeaders ( $debug )

Enable / disable the DebugHeaders.

Parameters

bool $debug

Returns: Swift_Signers_DKIMSigner

Definition at line 165 of file OpenDKIMSigner.php.

setHeaders ( Swift_Mime_HeaderSet $headers )

Give the headers already given.

Parameters

Swift_Mime_SimpleHeaderSet $headers

Returns: Swift_Signers_HeaderSigner

Implements Swift_Signers_HeaderSigner.

Definition at line 58 of file OpenDKIMSigner.php.

References Swift_Signers_DKIMSigner\$_bodyLen, Swift_Mime_HeaderSet\getAll(), Swift_Mime_HeaderSet\has(), and Swift_Mime_HeaderSet\listAll().

setSignatureExpiration ( $time )

Set the signature expiration timestamp.

Parameters

timestamp $time

Returns: Swift_Signers_DKIMSigner

Definition at line 151 of file OpenDKIMSigner.php.

setSignatureTimestamp ( $time )

Set the signature timestamp.

Parameters

timestamp $time

Returns: Swift_Signers_DKIMSigner

Definition at line 137 of file OpenDKIMSigner.php.

startBody ( )

Prepare the Signer to get a new Body.

Returns: Swift_Signers_HeaderSigner

Implements Swift_Signers_HeaderSigner.

Definition at line 101 of file OpenDKIMSigner.php.

Member Data Documentation

$_dkimHandler = null

private

Definition at line 21 of file OpenDKIMSigner.php.

$_peclLoaded = false

private

Definition at line 19 of file OpenDKIMSigner.php.

$dropFirstLF = true

private

Definition at line 23 of file OpenDKIMSigner.php.

const CANON_RELAXED = 1

Definition at line 25 of file OpenDKIMSigner.php.

const CANON_SIMPLE = 2

Definition at line 26 of file OpenDKIMSigner.php.

const SIG_RSA_SHA1 = 3

Definition at line 27 of file OpenDKIMSigner.php.

const SIG_RSA_SHA256 = 4

Definition at line 28 of file OpenDKIMSigner.php.