PHP 클래스 Swift_Signers_DomainKeySigner

저자: Xavier De Cock ([email protected])
상속: implements Swift_Signers_HeaderSigner
파일 보기 프로젝트 열기: swiftmailer/swiftmailer

보호된 프로퍼티들

프로퍼티 타입 설명
$canon string Canonisation method.
$debugHeaders boolean Must we embed signed headers?
$domainKeyHeader Swift_Mime_Headers_ParameterizedHeader Stores the signature header.
$domainName string DomainName.
$hashAlgorithm string Hash algorithm used.
$ignoredHeaders array Headers not being signed.
$privateKey string PrivateKey.
$selector string Selector.
$signerIdentity string Signer identity.

공개 메소드들

메소드 설명
__construct ( string $privateKey, string $domainName, string $selector ) Constructor.
addSignature ( Swift_Mime_HeaderSet $headers ) : Swift_Signers_DomainKeySigner Add the signature to the given Headers.
bind ( Swift_InputByteStream $is ) : Swift_Signers_DomainKeySigner Attach $is to this stream.
commit ( ) : Swift_Signers_DomainKeySigner For any bytes that are currently buffered inside the stream, force them off the buffer.
endBody ( ) End Body.
flushBuffers ( ) : Swift_Signers_DomainKeySigner Flush the contents of the stream (empty it) and set the internal pointer to the beginning.
getAlteredHeaders ( ) : array Returns the list of Headers Tampered by this plugin.
ignoreHeader ( string $header_name ) : Swift_Signers_DomainKeySigner Adds an ignored Header.
reset ( ) : Swift_Signers_DomainKeySigner Resets internal states.
setCanon ( string $canon ) : Swift_Signers_DomainKeySigner Set the canonicalization algorithm.
setDebugHeaders ( boolean $debug ) : Swift_Signers_DomainKeySigner Enable / disable the DebugHeaders.
setHashAlgorithm ( string $hash ) : Swift_Signers_DomainKeySigner Set hash_algorithm, must be one of rsa-sha256 | rsa-sha1 defaults to rsa-sha256.
setHeaders ( Swift_Mime_HeaderSet $headers ) : Swift_Signers_DomainKeySigner Set the headers to sign.
setSignerIdentity ( string $identity ) : Swift_Signers_DomainKeySigner Set the signer identity.
startBody ( ) Start Body.
unbind ( Swift_InputByteStream $is ) : Swift_Signers_DomainKeySigner Remove an already bound stream.
write ( string $bytes ) : Swift_Signers_DomainKeySigner Writes $bytes to the end of the stream.

보호된 메소드들

메소드 설명
addHeader ( $header ) * Private helpers
canonicalizeBody ( $string )
endOfBody ( )
endOfHeaders ( )

비공개 메소드들

메소드 설명
addToHash ( $string )
getEncryptedHash ( ) : string
startHash ( )

메소드 상세

__construct() 공개 메소드

Constructor.
public __construct ( string $privateKey, string $domainName, string $selector )
$privateKey string
$domainName string
$selector string

addHeader() 보호된 메소드

* Private helpers
protected addHeader ( $header )

addSignature() 공개 메소드

Add the signature to the given Headers.
public addSignature ( Swift_Mime_HeaderSet $headers ) : Swift_Signers_DomainKeySigner
$headers Swift_Mime_HeaderSet
리턴 Swift_Signers_DomainKeySigner

bind() 공개 메소드

The stream acts as an observer, receiving all data that is written. All {@link write()} and {@link flushBuffers()} operations will be mirrored.
public bind ( Swift_InputByteStream $is ) : Swift_Signers_DomainKeySigner
$is Swift_InputByteStream
리턴 Swift_Signers_DomainKeySigner

canonicalizeBody() 보호된 메소드

protected canonicalizeBody ( $string )

commit() 공개 메소드

For any bytes that are currently buffered inside the stream, force them off the buffer.
public commit ( ) : Swift_Signers_DomainKeySigner
리턴 Swift_Signers_DomainKeySigner

endBody() 공개 메소드

End Body.
public endBody ( )

endOfBody() 보호된 메소드

protected endOfBody ( )

endOfHeaders() 보호된 메소드

protected endOfHeaders ( )

flushBuffers() 공개 메소드

Flush the contents of the stream (empty it) and set the internal pointer to the beginning.
public flushBuffers ( ) : Swift_Signers_DomainKeySigner
리턴 Swift_Signers_DomainKeySigner

getAlteredHeaders() 공개 메소드

Returns the list of Headers Tampered by this plugin.
public getAlteredHeaders ( ) : array
리턴 array

ignoreHeader() 공개 메소드

Adds an ignored Header.
public ignoreHeader ( string $header_name ) : Swift_Signers_DomainKeySigner
$header_name string
리턴 Swift_Signers_DomainKeySigner

reset() 공개 메소드

Resets internal states.
public reset ( ) : Swift_Signers_DomainKeySigner
리턴 Swift_Signers_DomainKeySigner

setCanon() 공개 메소드

Set the canonicalization algorithm.
public setCanon ( string $canon ) : Swift_Signers_DomainKeySigner
$canon string simple | nofws defaults to simple
리턴 Swift_Signers_DomainKeySigner

setDebugHeaders() 공개 메소드

Enable / disable the DebugHeaders.
public setDebugHeaders ( boolean $debug ) : Swift_Signers_DomainKeySigner
$debug boolean
리턴 Swift_Signers_DomainKeySigner

setHashAlgorithm() 공개 메소드

Set hash_algorithm, must be one of rsa-sha256 | rsa-sha1 defaults to rsa-sha256.
public setHashAlgorithm ( string $hash ) : Swift_Signers_DomainKeySigner
$hash string
리턴 Swift_Signers_DomainKeySigner

setHeaders() 공개 메소드

Set the headers to sign.
public setHeaders ( Swift_Mime_HeaderSet $headers ) : Swift_Signers_DomainKeySigner
$headers Swift_Mime_HeaderSet
리턴 Swift_Signers_DomainKeySigner

setSignerIdentity() 공개 메소드

Set the signer identity.
public setSignerIdentity ( string $identity ) : Swift_Signers_DomainKeySigner
$identity string
리턴 Swift_Signers_DomainKeySigner

startBody() 공개 메소드

Start Body.
public startBody ( )

unbind() 공개 메소드

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 unbind ( Swift_InputByteStream $is ) : Swift_Signers_DomainKeySigner
$is Swift_InputByteStream
리턴 Swift_Signers_DomainKeySigner

write() 공개 메소드

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 write ( string $bytes ) : Swift_Signers_DomainKeySigner
$bytes string
리턴 Swift_Signers_DomainKeySigner

프로퍼티 상세

$canon 보호되어 있는 프로퍼티

Canonisation method.
protected string $canon
리턴 string

$debugHeaders 보호되어 있는 프로퍼티

Must we embed signed headers?
protected bool $debugHeaders
리턴 boolean

$domainKeyHeader 보호되어 있는 프로퍼티

Stores the signature header.
protected Swift_Mime_Headers_ParameterizedHeader $domainKeyHeader
리턴 Swift_Mime_Headers_ParameterizedHeader

$domainName 보호되어 있는 프로퍼티

DomainName.
protected string $domainName
리턴 string

$hashAlgorithm 보호되어 있는 프로퍼티

Hash algorithm used.
protected string $hashAlgorithm
리턴 string

$ignoredHeaders 보호되어 있는 프로퍼티

Headers not being signed.
protected array $ignoredHeaders
리턴 array

$privateKey 보호되어 있는 프로퍼티

PrivateKey.
protected string $privateKey
리턴 string

$selector 보호되어 있는 프로퍼티

Selector.
protected string $selector
리턴 string

$signerIdentity 보호되어 있는 프로퍼티

Signer identity.
protected string $signerIdentity
리턴 string