Class Swift_Signers_DomainKeySigner
Inheritance | Swift_Signers_DomainKeySigner |
---|---|
Implements | Swift_Signers_HeaderSigner |
DomainKey Signer used to apply DomainKeys Signature to a message.
Protected Properties
Public Methods
Method | Description | Defined By |
---|---|---|
__construct() | Constructor. | Swift_Signers_DomainKeySigner |
addSignature() | Add the signature to the given Headers. | Swift_Signers_DomainKeySigner |
bind() | Attach $is to this stream. | Swift_Signers_DomainKeySigner |
commit() | For any bytes that are currently buffered inside the stream, force them off the buffer. | Swift_Signers_DomainKeySigner |
endBody() | End Body. | Swift_Signers_DomainKeySigner |
flushBuffers() | Flush the contents of the stream (empty it) and set the internal pointer to the beginning. | Swift_Signers_DomainKeySigner |
getAlteredHeaders() | Returns the list of Headers Tampered by this plugin. | Swift_Signers_DomainKeySigner |
ignoreHeader() | Adds an ignored Header. | Swift_Signers_DomainKeySigner |
newInstance() | Instanciate DomainKeySigner. | Swift_Signers_DomainKeySigner |
reset() | Resets internal states. | Swift_Signers_DomainKeySigner |
setCanon() | Set the canonicalization algorithm. | Swift_Signers_DomainKeySigner |
setDebugHeaders() | Enable / disable the DebugHeaders. | Swift_Signers_DomainKeySigner |
setHashAlgorithm() | Set hash_algorithm, must be one of rsa-sha256 | rsa-sha1 defaults to rsa-sha256. | Swift_Signers_DomainKeySigner |
setHeaders() | Set the headers to sign. | Swift_Signers_DomainKeySigner |
setSignerIdentity() | Set the signer identity. | Swift_Signers_DomainKeySigner |
startBody() | Start Body. | Swift_Signers_DomainKeySigner |
unbind() | Remove an already bound stream. | Swift_Signers_DomainKeySigner |
write() | Writes $bytes to the end of the stream. | Swift_Signers_DomainKeySigner |
Protected Methods
Property Details
Method Details
Constructor.
public void __construct ( $privateKey, $domainName, $selector ) | ||
$privateKey | string | |
$domainName | string | |
$selector | string |
protected void _addHeader ( $header ) | ||
$header |
protected void _canonicalizeBody ( $string ) | ||
$string |
protected void _endOfBody ( ) |
protected void _endOfHeaders ( ) |
Add the signature to the given Headers.
public Swift_Signers_DomainKeySigner addSignature ( Swift_Mime_HeaderSet $headers ) | ||
$headers | Swift_Mime_HeaderSet |
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.
public \Swift_Signers_DomainKeysSigner bind ( Swift_InputByteStream $is ) | ||
$is | Swift_InputByteStream |
For any bytes that are currently buffered inside the stream, force them off the buffer.
public \Swift_Signers_DomainKeysSigner commit ( ) | ||
throws | Swift_IoException |
---|
End Body.
public void endBody ( ) |
Flush the contents of the stream (empty it) and set the internal pointer to the beginning.
public \Swift_Signers_DomainKeysSigner flushBuffers ( ) | ||
throws | Swift_IoException |
---|
Returns the list of Headers Tampered by this plugin.
public array getAlteredHeaders ( ) |
Adds an ignored Header.
public Swift_Signers_DomainKeySigner ignoreHeader ( $header_name ) | ||
$header_name | string |
Instanciate DomainKeySigner.
public static Swift_Signers_DomainKeySigner newInstance ( $privateKey, $domainName, $selector ) | ||
$privateKey | string | |
$domainName | string | |
$selector | string |
Resets internal states.
public \Swift_Signers_DomainKeysSigner reset ( ) |
Set the canonicalization algorithm.
public \Swift_Signers_DomainKeysSigner setCanon ( $canon ) | ||
$canon | string | Simple | nofws defaults to simple |
Enable / disable the DebugHeaders.
public Swift_Signers_DomainKeySigner setDebugHeaders ( $debug ) | ||
$debug | bool |
Set hash_algorithm, must be one of rsa-sha256 | rsa-sha1 defaults to rsa-sha256.
public \Swift_Signers_DomainKeysSigner setHashAlgorithm ( $hash ) | ||
$hash | string |
Set the headers to sign.
public Swift_Signers_DomainKeySigner setHeaders ( Swift_Mime_HeaderSet $headers ) | ||
$headers | Swift_Mime_HeaderSet |
Set the signer identity.
public Swift_Signers_DomainKeySigner setSignerIdentity ( $identity ) | ||
$identity | string |
Start Body.
public void startBody ( ) |
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.
public \Swift_Signers_DomainKeysSigner unbind ( Swift_InputByteStream $is ) | ||
$is | Swift_InputByteStream |
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).
public \Swift_Signers_DomainKeysSigner write ( $bytes ) | ||
$bytes | string | |
throws | Swift_IoException |
---|