Interface Swift_Signers_HeaderSigner
| Extends | Swift_InputByteStream, Swift_Signer |
|---|---|
| Implemented by | Swift_Signers_DKIMSigner, Swift_Signers_DomainKeySigner, Swift_Signers_OpenDKIMSigner |
Header Signer Interface used to apply Header-Based Signature to a message.
Public Methods
| Method | Description | Defined By |
|---|---|---|
| addSignature() | Add the header(s) to the headerSet. | Swift_Signers_HeaderSigner |
| bind() | Attach $is to this stream. | Swift_InputByteStream |
| commit() | For any bytes that are currently buffered inside the stream, force them off the buffer. | Swift_InputByteStream |
| endBody() | Give the signal that the body has finished streaming. | Swift_Signers_HeaderSigner |
| flushBuffers() | Flush the contents of the stream (empty it) and set the internal pointer to the beginning. | Swift_InputByteStream |
| getAlteredHeaders() | Return the list of header a signer might tamper. | Swift_Signers_HeaderSigner |
| ignoreHeader() | Exclude an header from the signed headers. | Swift_Signers_HeaderSigner |
| reset() | Swift_Signer | |
| setHeaders() | Give the headers already given. | Swift_Signers_HeaderSigner |
| startBody() | Prepare the Signer to get a new Body. | Swift_Signers_HeaderSigner |
| unbind() | Remove an already bound stream. | Swift_InputByteStream |
| write() | Writes $bytes to the end of the stream. | Swift_InputByteStream |
Method Details
Add the header(s) to the headerSet.
| public abstract Swift_Signers_HeaderSigner addSignature ( Swift_Mime_HeaderSet $headers ) | ||
| $headers | Swift_Mime_HeaderSet | |
Give the signal that the body has finished streaming.
| public abstract Swift_Signers_HeaderSigner endBody ( ) |
Return the list of header a signer might tamper.
| public abstract array getAlteredHeaders ( ) |
Exclude an header from the signed headers.
| public abstract Swift_Signers_HeaderSigner ignoreHeader ( $header_name ) | ||
| $header_name | string | |
Give the headers already given.
| public abstract Swift_Signers_HeaderSigner setHeaders ( Swift_Mime_HeaderSet $headers ) | ||
| $headers | Swift_Mime_SimpleHeaderSet | |
Prepare the Signer to get a new Body.
| public abstract Swift_Signers_HeaderSigner startBody ( ) |