[ Index ]

MailPress 7.2

[ Index ]     [ Classes ]     [ Functions ]     [ Variables ]     [ Constants ]     [ Statistics ]    

title

Body

[close]

/mp-includes/composer/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Signers/ -> DKIMSigner.php (summary)

(no description)

File Size: 682 lines (17 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Swift_Signers_DKIMSigner:: (27 methods):
  __construct()
  reset()
  write()
  commit()
  bind()
  unbind()
  flushBuffers()
  setHashAlgorithm()
  setBodyCanon()
  setHeaderCanon()
  setSignerIdentity()
  setBodySignedLen()
  setSignatureTimestamp()
  setSignatureExpiration()
  setDebugHeaders()
  startBody()
  endBody()
  getAlteredHeaders()
  ignoreHeader()
  setHeaders()
  addSignature()
  addHeader()
  canonicalizeBody()
  endOfBody()
  addToBodyHash()
  addToHeaderHash()
  getEncryptedHash()


Class: Swift_Signers_DKIMSigner  - X-Ref

DKIM Signer used to apply DKIM Signature to a message.

__construct($privateKey, $domainName, $selector, $passphrase = '')   X-Ref
Constructor.

param: string $privateKey
param: string $domainName
param: string $selector
param: string $passphrase

reset()   X-Ref
Reset the Signer.


write($bytes)   X-Ref
Writes $bytes to the end of the stream.

Writing may not happen immediately if the stream chooses to buffer.  If
you want to write these bytes with immediate effect, call {@link commit()}
after calling write().

This method returns the sequence ID of the write (i.e. 1 for first, 2 for
second, etc etc).

param: string $bytes
return: int

commit()   X-Ref
For any bytes that are currently buffered inside the stream, force them
off the buffer.


bind(Swift_InputByteStream $is)   X-Ref
Attach $is to this stream.

The stream acts as an observer, receiving all data that is written.
All {@link write()} and {@link flushBuffers()} operations will be mirrored.

unbind(Swift_InputByteStream $is)   X-Ref
Remove an already bound stream.

If $is is not bound, no errors will be raised.
If the stream currently has any buffered data it will be written to $is
before unbinding occurs.

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


setHashAlgorithm($hash)   X-Ref
Set hash_algorithm, must be one of rsa-sha256 | rsa-sha1.

param: string $hash 'rsa-sha1' or 'rsa-sha256'
return: $this

setBodyCanon($canon)   X-Ref
Set the body canonicalization algorithm.

param: string $canon
return: $this

setHeaderCanon($canon)   X-Ref
Set the header canonicalization algorithm.

param: string $canon
return: $this

setSignerIdentity($identity)   X-Ref
Set the signer identity.

param: string $identity
return: $this

setBodySignedLen($len)   X-Ref
Set the length of the body to sign.

param: mixed $len (bool or int)
return: $this

setSignatureTimestamp($time)   X-Ref
Set the signature timestamp.

param: int $time A timestamp
return: $this

setSignatureExpiration($time)   X-Ref
Set the signature expiration timestamp.

param: int $time A timestamp
return: $this

setDebugHeaders($debug)   X-Ref
Enable / disable the DebugHeaders.

param: bool $debug
return: Swift_Signers_DKIMSigner

startBody()   X-Ref
Start Body.


endBody()   X-Ref
End Body.


getAlteredHeaders()   X-Ref
Returns the list of Headers Tampered by this plugin.

return: array

ignoreHeader($header_name)   X-Ref
Adds an ignored Header.

param: string $header_name
return: Swift_Signers_DKIMSigner

setHeaders(Swift_Mime_SimpleHeaderSet $headers)   X-Ref
Set the headers to sign.

return: Swift_Signers_DKIMSigner

addSignature(Swift_Mime_SimpleHeaderSet $headers)   X-Ref
Add the signature to the given Headers.

return: Swift_Signers_DKIMSigner

addHeader($header, $is_sig = false)   X-Ref
No description

canonicalizeBody($string)   X-Ref
No description

endOfBody()   X-Ref
No description

addToBodyHash($string)   X-Ref
No description

addToHeaderHash($header)   X-Ref
No description

getEncryptedHash()   X-Ref

return: string



Generated: Tue May 19 15:55:14 2020 Cross-referenced by PHPXref 0.7.1