Apache Zeta Components Manual :: File Source for mail_address.php
Source for file mail_address.php
Documentation is available at mail_address.php
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
* @version //autogentag//
* A container to store a mail address in RFC822 format.
* The class ezcMailTools contains methods for transformation between several
* @version //autogentag//
* The name of the recipient (optional).
* The email address of the recipient.
* The character set used in the $name property.
* The characterset defaults to us-ascii.
* Constructs a new ezcMailAddress with the mail address $email and the optional name $name.
public function __construct( $email, $name =
'', $charset =
'us-ascii' )
* Returns a new instance of this class with the data specified by $array.
* $array contains all the data members of this class in the form:
* array('member_name'=>value).
* __set_state makes this class exportable with var_export.
* var_export() generates code, that calls this method when it
* @param array(string=>mixed) $array
return new ezcMailAddress( $array['email'], $array['name'] );
* Returns string representation of email address on string cast.
* Builds a representation in format "Name <email@example.com>", if name
* is present, else only "<email@example.com>", if name is not present. You
* can simply do echo with an object of type ezcMailAddress or (since PHP
* 5.2) explicitly cast it to string using (string) $object.
* @return string String representation of the email address.
return ( !empty( $this->name ) ?
"{
$this->name} " :
"" ) .
"<{$this->email}>
";