[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

/inc/ -> mail.php (summary)

Mail functions

Author: Andreas Gohr
License: GPL 2 (http://www.gnu.org/licenses/gpl.html)
File Size: 351 lines (12 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 7 functions

  mail_setup()
  mail_send()
  _mail_send_action()
  mail_encode_address()
  mail_isvalid()
  mail_quotedprintable_encode()
  mail_quotedprintable_encode_callback()

Functions
Functions that are not part of a class:

mail_setup()   X-Ref
Prepare mailfrom replacement patterns

Also prepares a mailfromnobody config that contains an autoconstructed address
if the mailfrom one is userdependent and this might not be wanted (subscriptions)

author: Andreas Gohr <andi@splitbrain.org>

mail_send($to, $subject, $body, $from='', $cc='', $bcc='', $headers=null, $params=null)   X-Ref
UTF-8 autoencoding replacement for PHPs mail function

Email address fields (To, From, Cc, Bcc can contain a textpart and an address
like this: 'Andreas Gohr <andi@splitbrain.org>' - the text part is encoded
automatically. You can seperate receivers by commas.

author: Andreas Gohr <andi@splitbrain.org>
param: string $to      Receiver of the mail (multiple seperated by commas)
param: string $subject Mailsubject
param: string $body    Messagebody
param: string $from    Sender address
param: string $cc      CarbonCopy receiver (multiple seperated by commas)
param: string $bcc     BlindCarbonCopy receiver (multiple seperated by commas)
param: string $headers Additional Headers (seperated by MAILHEADER_EOL
param: string $params  Additonal Sendmail params (passed to mail())
see: mail()

_mail_send_action($data)   X-Ref

return: bool
param: $data

mail_encode_address($string,$header='',$names=true)   X-Ref
Encodes an email address header

Unicode characters will be deaccented and encoded
quoted_printable for headers.
Addresses may not contain Non-ASCII data!

Example:
mail_encode_address("föö <foo@bar.com>, me@somewhere.com","TBcc");

param: string  $string Multiple adresses separated by commas
param: string  $header Name of the header (To,Bcc,Cc,...)
param: boolean $names  Allow named Recipients?

mail_isvalid($email)   X-Ref
Check if a given mail address is valid

return: bool          true if address is valid
param: string $email the address to check

mail_quotedprintable_encode($sText,$maxlen=74,$bEmulate_imap_8bit=true)   X-Ref
Quoted printable encoding

author: umu <umuAThrz.tu-chemnitz.de>
return: string
param: string $sText
param: int $maxlen
param: bool $bEmulate_imap_8bit
link: http://php.net/manual/en/function.imap-8bit.php#61216

mail_quotedprintable_encode_callback($matches)   X-Ref
No description