PHP 클래스 IMP_Prefs_Identity, horde

저자: Jan Schneider ([email protected])
저자: Chuck Hagenbuch ([email protected])
상속: extends Horde_Core_Prefs_Identity
파일 보기 프로젝트 열기: horde/horde 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$_cached array Cached data.
$_impPrefs array Identity preferences added by IMP.

공개 메소드들

메소드 설명
__construct ( $params ) Reads all the user's identities from the prefs object or builds a new identity from the standard values given in prefs.php.
getAliasAddress ( integer $ident = null ) : Horde_Mail_Rfc822_List Returns all aliases based on the chosen identity.
getAllFromAddresses ( ) : Horde_Mail_Rfc822_List Returns all identities' From addresses.
getAllIdentityAddresses ( ) : Horde_Mail_Rfc822_List Returns a list of all e-mail addresses from all identities, including both from addresses and tie addreses.
getAllSentmail ( boolean $unique = true ) : array Returns an array with the sent-mail mailboxes from all identities.
getAllSignatures ( string $type = 'text' ) : array Returns an array with the signatures from all identities
getAllTieAddresses ( ) : Horde_Mail_Rfc822_List Get all 'tie to' address/identity pairs.
getBccAddresses ( integer $ident = null ) : Horde_Mail_Rfc822_List Returns the BCC addresses for a given identity.
getFromAddress ( integer $ident = null ) : Horde_Mail_Rfc822_Address Returns the from address based on the chosen identity. If no address can be found it is built from the current user name and the specified maildomain.
getFromAddresses ( integer $ident = null ) : Horde_Mail_Rfc822_List Returns all From addresses for one identity.
getFromLine ( integer $ident = null, string $from_address = '' ) : Horde_Mail_Rfc822_Address Returns a complete From: header based on all relevant factors (fullname, from address, input fields, locks etc.)
getFullname ( integer $ident = null ) : string Returns the user's full name.
getMatchingIdentity ( mixed $addresses, boolean $search_own = true ) : integer Returns the identity's id that matches the passed addresses.
getSelectList ( ) : array Returns an array with the necessary values for the identity select box in the IMP compose window.
getSignature ( string $type = 'text', integer $ident = null ) : string Returns the full signature based on the current settings for the signature itself, the dashes and the position.
getTieAddresses ( integer $ident = null ) : Horde_Mail_Rfc822_List Get tie-to addresses.
getValue ( $key, $identity = null ) Returns a property from one of the identities.
hasAddress ( mixed $address ) : boolean Returns true if the given address belongs to one of the identities.
hasSignature ( boolean $compose_page = false ) : boolean Does the user have any signatures (either text or HTML)?
save ( )
saveSentmail ( integer $ident = null ) : boolean Returns true if the mail should be saved and the user is allowed to.
setValue ( $key, $val, $identity = null ) Sets a property with a specified value.
verify ( integer $identity = null ) Verifies and sanitizes all identity properties.

보호된 메소드들

메소드 설명
_identitiesWithDefaultFirst ( ) : array Returns the list of identities with the default identity positioned first.

메소드 상세

__construct() 공개 메소드

Reads all the user's identities from the prefs object or builds a new identity from the standard values given in prefs.php.
또한 보기: __construct()
public __construct ( $params )

_identitiesWithDefaultFirst() 보호된 메소드

Returns the list of identities with the default identity positioned first.
protected _identitiesWithDefaultFirst ( ) : array
리턴 array The identity keys with the default identity first.

getAliasAddress() 공개 메소드

Returns all aliases based on the chosen identity.
public getAliasAddress ( integer $ident = null ) : Horde_Mail_Rfc822_List
$ident integer The identity to retrieve the aliases from.
리턴 Horde_Mail_Rfc822_List Aliases for the identity.

getAllFromAddresses() 공개 메소드

Returns all identities' From addresses.
public getAllFromAddresses ( ) : Horde_Mail_Rfc822_List
리턴 Horde_Mail_Rfc822_List Address list.

getAllIdentityAddresses() 공개 메소드

Returns a list of all e-mail addresses from all identities, including both from addresses and tie addreses.
public getAllIdentityAddresses ( ) : Horde_Mail_Rfc822_List
리턴 Horde_Mail_Rfc822_List A list of e-mail addresses.

getAllSentmail() 공개 메소드

Returns an array with the sent-mail mailboxes from all identities.
public getAllSentmail ( boolean $unique = true ) : array
$unique boolean If true, return the unique list of sent-mail mailboxes. If false, returns list of sent-mail mailboxes, with the key corresponding to the identity.
리턴 array The array with the sent-mail IMP_Mailbox objects.

getAllSignatures() 공개 메소드

Returns an array with the signatures from all identities
public getAllSignatures ( string $type = 'text' ) : array
$type string Either 'text' or 'html'.
리턴 array The array with all the signatures.

getAllTieAddresses() 공개 메소드

Get all 'tie to' address/identity pairs.
public getAllTieAddresses ( ) : Horde_Mail_Rfc822_List
리턴 Horde_Mail_Rfc822_List A list of e-mail addresses.

getBccAddresses() 공개 메소드

Returns the BCC addresses for a given identity.
public getBccAddresses ( integer $ident = null ) : Horde_Mail_Rfc822_List
$ident integer The identity to retrieve the Bcc addresses from.
리턴 Horde_Mail_Rfc822_List BCC addresses.

getFromAddress() 공개 메소드

Returns the from address based on the chosen identity. If no address can be found it is built from the current user name and the specified maildomain.
public getFromAddress ( integer $ident = null ) : Horde_Mail_Rfc822_Address
$ident integer The identity to retrieve the address from.
리턴 Horde_Mail_Rfc822_Address A valid from address.

getFromAddresses() 공개 메소드

Returns all From addresses for one identity.
public getFromAddresses ( integer $ident = null ) : Horde_Mail_Rfc822_List
$ident integer The identity to retrieve the from addresses from.
리턴 Horde_Mail_Rfc822_List Address list.

getFromLine() 공개 메소드

Returns a complete From: header based on all relevant factors (fullname, from address, input fields, locks etc.)
public getFromLine ( integer $ident = null, string $from_address = '' ) : Horde_Mail_Rfc822_Address
$ident integer The identity to retrieve the values from.
$from_address string A default from address to use if no identity is selected and the from_addr preference is locked.
리턴 Horde_Mail_Rfc822_Address The address to use for From header.

getFullname() 공개 메소드

Returns the user's full name.
public getFullname ( integer $ident = null ) : string
$ident integer The identity to retrieve the name from.
리턴 string The user's full name.

getMatchingIdentity() 공개 메소드

Returns the identity's id that matches the passed addresses.
public getMatchingIdentity ( mixed $addresses, boolean $search_own = true ) : integer
$addresses mixed Either an array or a single string or a comma-separated list of email addresses.
$search_own boolean Search for a matching identity in own addresses also?
리턴 integer The id of the first identity that from or alias addresses match (one of) the passed addresses or null if none matches.

getSelectList() 공개 메소드

Returns an array with the necessary values for the identity select box in the IMP compose window.
public getSelectList ( ) : array
리턴 array The array with the necessary strings

getSignature() 공개 메소드

Returns the full signature based on the current settings for the signature itself, the dashes and the position.
public getSignature ( string $type = 'text', integer $ident = null ) : string
$type string Either 'text' or 'html'.
$ident integer The identity to retrieve the signature from.
리턴 string The full signature.

getTieAddresses() 공개 메소드

Get tie-to addresses.
public getTieAddresses ( integer $ident = null ) : Horde_Mail_Rfc822_List
$ident integer The identity to retrieve the tie-to addresses from.
리턴 Horde_Mail_Rfc822_List A list of tie-to e-mail addresses.

getValue() 공개 메소드

Returns a property from one of the identities.
또한 보기: getValue()
public getValue ( $key, $identity = null )

hasAddress() 공개 메소드

This function will search aliases for an identity automatically.
public hasAddress ( mixed $address ) : boolean
$address mixed The address(es) to search for in the identities.
리턴 boolean True if the address was found.

hasSignature() 공개 메소드

Does the user have any signatures (either text or HTML)?
public hasSignature ( boolean $compose_page = false ) : boolean
$compose_page boolean If true, checks for signatures as used on the compose pages.
리턴 boolean True if the user has at least one signature.

save() 공개 메소드

public save ( )

saveSentmail() 공개 메소드

Returns true if the mail should be saved and the user is allowed to.
public saveSentmail ( integer $ident = null ) : boolean
$ident integer The identity to retrieve the setting from.
리턴 boolean True if the sent mail should be saved.

setValue() 공개 메소드

Sets a property with a specified value.
또한 보기: setValue()
public setValue ( $key, $val, $identity = null )

verify() 공개 메소드

Verifies and sanitizes all identity properties.
public verify ( integer $identity = null )
$identity integer The identity to verify.

프로퍼티 상세

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

Cached data.
protected array $_cached
리턴 array

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

Identity preferences added by IMP.
protected array $_impPrefs
리턴 array