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

Class: Swift_Signers_DKIMSigner

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

Class Overview


DKIM Signer used to apply DKIM Signature to a message.


Author(s):

Implements interfaces:

Variables

Methods


Child classes:

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

Class Details

[line 16]
DKIM Signer used to apply DKIM Signature to a message.



Tags:

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


[ Top ]


Class Variables

$_bodyCanon =  'simple'

[line 51]

Body canon method.



Tags:

access:  protected

Type:   string


[ Top ]

$_bodyLen =  0

[line 79]

BodyLength.



Tags:

access:  protected

Type:   int


[ Top ]

$_debugHeaders =  false

[line 115]

Must we embed signed headers?



Tags:

access:  protected

Type:   bool


[ Top ]

$_dkimHeader =

[line 144]

Stores the signature header.



Tags:

access:  protected



[ Top ]

$_domainName =

[line 30]

DomainName.



Tags:

access:  protected

Type:   string


[ Top ]

$_hashAlgorithm =  'rsa-sha1'

[line 44]

Hash algorithm used.



Tags:

access:  protected

Type:   string


[ Top ]

$_headerCanon =  'simple'

[line 58]

Header canon method.



Tags:

access:  protected

Type:   string


[ Top ]

$_ignoredHeaders = array('return-path' => true)

[line 65]

Headers not being signed.



Tags:

access:  protected

Type:   array


[ Top ]

$_maxLen =  PHP_INT_MAX

[line 86]

Maximum signedLen.



Tags:

access:  protected

Type:   int


[ Top ]

$_privateKey =

[line 23]

PrivateKey.



Tags:

access:  protected

Type:   string


[ Top ]

$_selector =

[line 37]

Selector.



Tags:

access:  protected

Type:   string


[ Top ]

$_showLen =  false

[line 93]

Embbed bodyLen in signature.



Tags:

access:  protected

Type:   bool


[ Top ]

$_signatureExpiration =  false

[line 108]

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



Tags:

access:  protected

Type:   int


[ Top ]

$_signatureTimestamp =  true

[line 100]

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



Tags:

access:  protected

Type:   mixed


[ Top ]

$_signedHeaders = array()

[line 123]

Headers used to generate hash.



Tags:

access:  protected

Type:   array


[ Top ]

$_signerIdentity =

[line 72]

Signer identity.



Tags:

access:  protected

Type:   string


[ Top ]



Class Methods


static method newInstance [line 188]

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

Instanciate DKIMSigner.



Tags:

access:  public


Overridden in child classes as:

Swift_Signers_OpenDKIMSigner::newInstance()

Parameters:

string   $privateKey  
string   $domainName  
string   $selector  

[ Top ]

constructor __construct [line 171]

Swift_Signers_DKIMSigner __construct( string $privateKey, string $domainName, string $selector)

Constructor.



Tags:

access:  public


Overridden in child classes as:

Swift_Signers_OpenDKIMSigner::__construct()

Parameters:

string   $privateKey  
string   $domainName  
string   $selector  

[ Top ]

method addSignature [line 518]

Swift_Signers_DKIMSigner addSignature( Swift_Mime_HeaderSet $headers)

Add the signature to the given Headers.



Tags:

access:  public


Overridden in child classes as:

Swift_Signers_OpenDKIMSigner::addSignature()


Implementation of:
Swift_Signers_HeaderSigner::addSignature()
Add the header(s) to the headerSet.

Parameters:

Swift_Mime_HeaderSet   $headers  

[ Top ]

method bind [line 253]

void bind( Swift_InputByteStream $is)

Attach $is to this stream.

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




Tags:

access:  public


Parameters:

Swift_InputByteStream   $is  

[ Top ]

method commit [line 240]

void commit( )

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



Tags:

throws:  Swift_IoException
access:  public


[ Top ]

method endBody [line 448]

void endBody( )

End Body.



Tags:

access:  public


Overridden in child classes as:

Swift_Signers_OpenDKIMSigner::endBody()


Implementation of:
Swift_Signers_HeaderSigner::endBody()
Give the signal that the body has finished streaming.
[ Top ]

method flushBuffers [line 289]

void flushBuffers( )

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



Tags:

throws:  Swift_IoException
access:  public


[ Top ]

method getAlteredHeaders [line 458]

array getAlteredHeaders( )

Returns the list of Headers Tampered by this plugin.



Tags:

access:  public



Implementation of:
Swift_Signers_HeaderSigner::getAlteredHeaders()
Return the list of header a signer might tamper.
[ Top ]

method ignoreHeader [line 474]

Swift_Signers_DKIMSigner ignoreHeader( string $header_name)

Adds an ignored Header.



Tags:

access:  public



Implementation of:
Swift_Signers_HeaderSigner::ignoreHeader()
Exclude an header from the signed headers.

Parameters:

string   $header_name  

[ Top ]

method reset [line 198]

void reset( )

Reset the Signer.



Tags:

see:  Swift_Signer::reset()
access:  public


Overridden in child classes as:

Swift_Signers_OpenDKIMSigner::reset()


Implementation of:
Swift_Signer::reset()
[ Top ]

method setBodyCanon [line 320]

Swift_Signers_DKIMSigner setBodyCanon( string $canon)

Set the body canonicalization algorithm.



Tags:

access:  public


Parameters:

string   $canon  

[ Top ]

method setBodySignedLen [line 370]

Swift_Signers_DKIMSigner setBodySignedLen( mixed $len)

Set the length of the body to sign.



Tags:

access:  public


Parameters:

mixed   $len   (bool or int)

[ Top ]

method setDebugHeaders [line 421]

Swift_Signers_DKIMSigner setDebugHeaders( bool $debug)

Enable / disable the DebugHeaders.



Tags:

access:  public


Overridden in child classes as:

Swift_Signers_OpenDKIMSigner::setDebugHeaders()
Enable / disable the DebugHeaders.

Parameters:

bool   $debug  

[ Top ]

method setHashAlgorithm [line 301]

Swift_Signers_DKIMSigner setHashAlgorithm( string $hash)

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



Tags:

access:  public


Parameters:

string   $hash  

[ Top ]

method setHeaderCanon [line 338]

Swift_Signers_DKIMSigner setHeaderCanon( string $canon)

Set the header canonicalization algorithm.



Tags:

access:  public


Parameters:

string   $canon  

[ Top ]

method setHeaders [line 488]

Swift_Signers_DKIMSigner setHeaders( Swift_Mime_HeaderSet $headers)

Set the headers to sign.



Tags:

access:  public


Overridden in child classes as:

Swift_Signers_OpenDKIMSigner::setHeaders()


Implementation of:
Swift_Signers_HeaderSigner::setHeaders()
Give the headers already given.

Parameters:

Swift_Mime_HeaderSet   $headers  

[ Top ]

method setSignatureExpiration [line 407]

Swift_Signers_DKIMSigner setSignatureExpiration( int $time)

Set the signature expiration timestamp.



Tags:

access:  public


Overridden in child classes as:

Swift_Signers_OpenDKIMSigner::setSignatureExpiration()
Set the signature expiration timestamp.

Parameters:

int   $time   A timestamp

[ Top ]

method setSignatureTimestamp [line 393]

Swift_Signers_DKIMSigner setSignatureTimestamp( int $time)

Set the signature timestamp.



Tags:

access:  public


Overridden in child classes as:

Swift_Signers_OpenDKIMSigner::setSignatureTimestamp()
Set the signature timestamp.

Parameters:

int   $time   A timestamp

[ Top ]

method setSignerIdentity [line 356]

Swift_Signers_DKIMSigner setSignerIdentity( string $identity)

Set the signer identity.



Tags:

access:  public


Parameters:

string   $identity  

[ Top ]

method startBody [line 431]

void startBody( )

Start Body.



Tags:

access:  public


Overridden in child classes as:

Swift_Signers_OpenDKIMSigner::startBody()


Implementation of:
Swift_Signers_HeaderSigner::startBody()
Prepare the Signer to get a new Body.
[ Top ]

method unbind [line 269]

void unbind( Swift_InputByteStream $is)

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.




Tags:

access:  public


Parameters:

Swift_InputByteStream   $is  

[ Top ]

method write [line 226]

int write( string $bytes)

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 commit() after calling write().

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




Tags:

throws:  Swift_IoException
access:  public


Parameters:

string   $bytes  

[ Top ]

method _addHeader [line 567]

void _addHeader( $header, [ $is_sig = false])



Tags:

access:  protected


Parameters:

   $header  
   $is_sig  

[ Top ]

method _canonicalizeBody [line 592]

void _canonicalizeBody( $string)



Tags:

access:  protected


Overridden in child classes as:

Swift_Signers_OpenDKIMSigner::_canonicalizeBody()

Parameters:

   $string  

[ Top ]

method _endOfBody [line 645]

void _endOfBody( )



Tags:

access:  protected


[ Top ]

method _endOfHeaders [line 588]

void _endOfHeaders( )



Tags:

deprecated:  This method is currently useless in this class but it must be kept for BC reasons due to its "protected" scope. This method might be overriden by custom client code.
access:  protected


[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:47:41 +0000 by phpDocumentor 1.4.3