Documentation

Swift_Signers_OpenDKIMSigner extends Swift_Signers_DKIMSigner

in package

• Application

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

Tags

author

Xavier De Cock xdecock@gmail.com

deprecated

since SwiftMailer 6.1.0; use Swift_Signers_DKIMSigner instead.

Table of Contents

CANON_RELAXED  = 1

CANON_SIMPLE  = 2

SIG_RSA_SHA1  = 3

SIG_RSA_SHA256  = 4

$bodyCanon  : string

Body canon method.

$bodyLen  : int

BodyLength.

$debugHeaders  : bool

Must we embed signed headers?

$dkimHeader  : Swift_Mime_Headers_ParameterizedHeader

Stores the signature header.

$domainName  : string

DomainName.

$hashAlgorithm  : string

Hash algorithm used.

$headerCanon  : string

Header canon method.

$ignoredHeaders  : array<string|int, mixed>

Headers not being signed.

$maxLen  : int

Maximum signedLen.

$privateKey  : string

PrivateKey.

$selector  : string

Selector.

$showLen  : bool

Embbed bodyLen in signature.

$signatureExpiration  : int

When will the signature expires false means not embedded, if sigTimestamp is auto Expiration is relative, otherwise it's absolute.

$signatureTimestamp  : mixed

When the signature has been applied (true means time()), false means not embedded.

$signedHeaders  : array<string|int, mixed>

Headers used to generate hash.

$signerIdentity  : string

Signer identity.

$bodyCanonEmptyCounter  : mixed

$bodyCanonIgnoreStart  : mixed

$bodyCanonLastChar  : mixed

$bodyCanonLine  : mixed

$bodyCanonSpace  : mixed

$bodyHash  : string

Stores the bodyHash.

$bodyHashHandler  : mixed

$bound  : mixed

$debugHeadersData  : array<string|int, string>

If debugHeaders is set store debugData here.

$dkimHandler  : mixed

$dropFirstLF  : mixed

$headerCanonData  : mixed

$headerHash  : mixed

$passphrase  : mixed

$peclLoaded  : mixed

__construct()  : mixed

Constructor.

addSignature()  : Swift_Signers_DKIMSigner

Add the signature to the given Headers.

bind()  : mixed

Attach $is to this stream.

commit()  : mixed

For any bytes that are currently buffered inside the stream, force them off the buffer.

endBody()  : self

End Body.

flushBuffers()  : mixed

Flush the contents of the stream (empty it) and set the internal pointer to the beginning.

getAlteredHeaders()  : array<string|int, mixed>

Returns the list of Headers Tampered by this plugin.

ignoreHeader()  : Swift_Signers_DKIMSigner

Adds an ignored Header.

reset()  : mixed

Reset the Signer.

setBodyCanon()  : $this

Set the body canonicalization algorithm.

setBodySignedLen()  : $this

Set the length of the body to sign.

setDebugHeaders()  : $this

Enable / disable the DebugHeaders.

setHashAlgorithm()  : $this

Set hash_algorithm, must be one of rsa-sha256 | rsa-sha1.

setHeaderCanon()  : $this

Set the header canonicalization algorithm.

setHeaders()  : Swift_Signers_DKIMSigner

Set the headers to sign.

setSignatureExpiration()  : $this

Set the signature expiration timestamp.

setSignatureTimestamp()  : $this

Set the signature timestamp.

setSignerIdentity()  : $this

Set the signer identity.

startBody()  : self

Start Body.

unbind()  : mixed

Remove an already bound stream.

write()  : int

Writes $bytes to the end of the stream.

addHeader()  : mixed

canonicalizeBody()  : mixed

endOfBody()  : mixed

addToBodyHash()  : mixed

addToHeaderHash()  : mixed

getEncryptedHash()  : string