Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Swift_Signers_OpenDKIMSigner

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Signers/OpenDKIMSigner.php

Class Overview

Swift_Signers_DKIMSigner
   |
   --Swift_Signers_OpenDKIMSigner

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


Author(s):

Constants

Methods


Inherited Variables

Inherited Methods

Class: Swift_Signers_DKIMSigner

Swift_Signers_DKIMSigner::__construct()
Constructor.
Swift_Signers_DKIMSigner::addSignature()
Add the signature to the given Headers.
Swift_Signers_DKIMSigner::bind()
Attach $is to this stream.
Swift_Signers_DKIMSigner::commit()
For any bytes that are currently buffered inside the stream, force them off the buffer.
Swift_Signers_DKIMSigner::endBody()
End Body.
Swift_Signers_DKIMSigner::flushBuffers()
Flush the contents of the stream (empty it) and set the internal pointer to the beginning.
Swift_Signers_DKIMSigner::getAlteredHeaders()
Returns the list of Headers Tampered by this plugin.
Swift_Signers_DKIMSigner::ignoreHeader()
Adds an ignored Header.
Swift_Signers_DKIMSigner::newInstance()
Instanciate DKIMSigner.
Swift_Signers_DKIMSigner::reset()
Reset the Signer.
Swift_Signers_DKIMSigner::setBodyCanon()
Set the body canonicalization algorithm.
Swift_Signers_DKIMSigner::setBodySignedLen()
Set the length of the body to sign.
Swift_Signers_DKIMSigner::setDebugHeaders()
Enable / disable the DebugHeaders.
Swift_Signers_DKIMSigner::setHashAlgorithm()
Set hash_algorithm, must be one of rsa-sha256 | rsa-sha1 defaults to rsa-sha256.
Swift_Signers_DKIMSigner::setHeaderCanon()
Set the header canonicalization algorithm.
Swift_Signers_DKIMSigner::setHeaders()
Set the headers to sign.
Swift_Signers_DKIMSigner::setSignatureExpiration()
Set the signature expiration timestamp.
Swift_Signers_DKIMSigner::setSignatureTimestamp()
Set the signature timestamp.
Swift_Signers_DKIMSigner::setSignerIdentity()
Set the signer identity.
Swift_Signers_DKIMSigner::startBody()
Start Body.
Swift_Signers_DKIMSigner::unbind()
Remove an already bound stream.
Swift_Signers_DKIMSigner::write()
Writes $bytes to the end of the stream.
Swift_Signers_DKIMSigner::_addHeader()
Swift_Signers_DKIMSigner::_canonicalizeBody()
Swift_Signers_DKIMSigner::_endOfBody()
Swift_Signers_DKIMSigner::_endOfHeaders()

Class Details

[line 17]
DKIM Signer used to apply DKIM Signature to a message Takes advantage of pecl extension.



Tags:

author:  Xavier De Cock <xdecock@gmail.com>


[ Top ]


Class Methods


static method newInstance [line 41]

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



Tags:

access:  public


Overrides Swift_Signers_DKIMSigner::newInstance() (Instanciate DKIMSigner.)

Parameters:

   $privateKey  
   $domainName  
   $selector  

[ Top ]

constructor __construct [line 30]

Swift_Signers_OpenDKIMSigner __construct( $privateKey, $domainName, $selector)



Tags:

access:  public


Overrides Swift_Signers_DKIMSigner::__construct() (Constructor.)

Parameters:

   $privateKey  
   $domainName  
   $selector  

[ Top ]

method addSignature [line 46]

void addSignature( Swift_Mime_HeaderSet $headers)



Tags:

access:  public


Overrides Swift_Signers_DKIMSigner::addSignature() (Add the signature to the given Headers.)

Parameters:

Swift_Mime_HeaderSet   $headers  

[ Top ]

method endBody [line 113]

void endBody( )



Tags:

access:  public


Overrides Swift_Signers_DKIMSigner::endBody() (End Body.)

[ Top ]

method reset [line 123]

void reset( )



Tags:

access:  public


Overrides Swift_Signers_DKIMSigner::reset() (Reset the Signer.)

[ Top ]

method setDebugHeaders [line 166]

Swift_Signers_DKIMSigner setDebugHeaders( bool $debug)

Enable / disable the DebugHeaders.



Tags:

access:  public


Overrides Swift_Signers_DKIMSigner::setDebugHeaders() (Enable / disable the DebugHeaders.)

Parameters:

bool   $debug  

[ Top ]

method setHeaders [line 59]

void setHeaders( Swift_Mime_HeaderSet $headers)



Tags:

access:  public


Overrides Swift_Signers_DKIMSigner::setHeaders() (Set the headers to sign.)

Parameters:

Swift_Mime_HeaderSet   $headers  

[ Top ]

method setSignatureExpiration [line 152]

Swift_Signers_DKIMSigner setSignatureExpiration( int $time)

Set the signature expiration timestamp.



Tags:

access:  public


Overrides Swift_Signers_DKIMSigner::setSignatureExpiration() (Set the signature expiration timestamp.)

Parameters:

int   $time  

[ Top ]

method setSignatureTimestamp [line 138]

Swift_Signers_DKIMSigner setSignatureTimestamp( int $time)

Set the signature timestamp.



Tags:

access:  public


Overrides Swift_Signers_DKIMSigner::setSignatureTimestamp() (Set the signature timestamp.)

Parameters:

int   $time  

[ Top ]

method startBody [line 102]

void startBody( )



Tags:

access:  public


Overrides Swift_Signers_DKIMSigner::startBody() (Start Body.)

[ Top ]

method _canonicalizeBody [line 175]

void _canonicalizeBody( $string)



Tags:

access:  protected


Overrides Swift_Signers_DKIMSigner::_canonicalizeBody() (parent method not documented)

Parameters:

   $string  

[ Top ]


Class Constants

CANON_RELAXED =  1

[line 25]


[ Top ]

CANON_SIMPLE =  2

[line 26]


[ Top ]

SIG_RSA_SHA1 =  3

[line 27]


[ Top ]

SIG_RSA_SHA256 =  4

[line 28]


[ Top ]



Documentation generated on Sun, 02 Oct 2016 07:53:06 +0000 by phpDocumentor 1.4.3