Class: EMail

Source Location: /communication/EMail.class.php

Class Overview

This class can be used to create emails of the type text or html. If you want you can add attachments.

Author(s):

Daniel PlÃ¼cken <daniel@debakel.net>

Version:

0.1.96

Copyright:

Copyright (C) 2005 Daniel PlÃ¼cken <daniel@debakel.net>
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Variables

Methods

Class Details

[line 43]
This class can be used to create emails of the type text or html. If you want you can add attachments.

Tags:

author:	Daniel PlÃ¼cken <daniel@debakel.net>
version:	0.1.96
copyright:	Copyright (C) 2005 Daniel PlÃ¼cken <daniel@debakel.net> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
license:	GNU Lesser General Public License

[ Top ]

Class Variables

$attachment_data_arr = array ()

[line 108]

Stores the content of the attachments.

Tags:

access:

public

Type:

array

[ Top ]

$attachment_filename_arr = array ()

[line 101]

Stores the filenames of attached files.

Tags:

access:

public

Type:

array

[ Top ]

$content = ""

[line 86]

Stores the content of the e-mail.

Tags:

access:

public

Type:

string

[ Top ]

$content_type = "text/plain"

[line 94]

Stores the type of content of the e-mail. Possible values are "text/plain" or "text/html" for plain text e-mail or html e-email.

Tags:

access:

private

Type:

string

[ Top ]

$reply_email = ""

[line 58]

Stores the e-mail address of the recipient on reply.

Tags:

access:

public

Type:

string

[ Top ]

$str_attachment_boundary = ""

[line 115]

Stores the boundary for attachments.

Tags:

access:

public

Type:

string

[ Top ]

$str_header_separator = "\n"

[line 124]

Stores the chars to seperate header information. It is immediatly adviced to let it the character "\n", because some email-provider can't handle header information separated by "\r\n" correctly!

Tags:

access:

public

Type:

string

[ Top ]

$subject = "Contact form"

[line 79]

Stores the subject of the e-mail.

Tags:

access:

public

Type:

string

[ Top ]

$target_email = ""

[line 51]

Stores the e-mail address of the recipient.

Tags:

access:

public

Type:

string

[ Top ]

$target_email_blindcopy_arr = array()

[line 72]

Stores the e-mail addresses of the recipients in blind carbon copy.

Tags:

access:

public

Type:

array

[ Top ]

$target_email_copy_arr = array()

[line 65]

Stores the e-mail addresses of the recipients in carbon copy.

Tags:

access:

public

Type:

array

[ Top ]

Class Methods

static method is_guilty [line 192]

static boolean is_guilty(
string
$string)

Returns whether the given email is valid.

The function name is a result of my bad english :P - sorry for that!

Tags:

author:	Daniel PlÃ¼cken <daniel@debakel.net>
version:	1.0
deprecated:
since:	0.1.2
access:	public

Parameters:

string

$string

The email to validate.

[ Top ]

static method is_valid [line 174]

static boolean is_valid(
string
$string)

Returns whether the given email is valid.

Tags:

author:	Daniel PlÃ¼cken <daniel@debakel.net>
version:	1.0
since:	0.1.9
access:	public

Parameters:

string

$string

The email to validate.

[ Top ]

constructor EMail [line 137]

EMail EMail(
string
$target_email)

Constructor

Tags:

author:	Daniel PlÃ¼cken <daniel@debakel.net>
version:	1.1
since:	0.1.0
access:	public

Parameters:

string

$target_email

[ Top ]

method addAttachment [line 222]

void addAttachment(
string
$filename, string
$data)

Adds an attachment to this email.

Tags:

author:	Daniel PlÃ¼cken <daniel@debakel.net>
version:	1.0
since:	0.1.2
access:	public

Parameters:

string	$filename
string	$data

[ Top ]

method addTargetEmailBlindCopy [line 304]

void addTargetEmailBlindCopy(
string
$string)

Adds an email to the array of emails where the message should be send in blind copy.

Tags:

author:	Daniel PlÃ¼cken <daniel@debakel.net>
version:	1.0
since:	0.1.2
access:	public

Parameters:

string

$string

[ Top ]

method addTargetEmailCopy [line 273]

void addTargetEmailCopy(
string
$string)

Adds an email to the array of emails where the message should be send in copy.

Tags:

author:	Daniel PlÃ¼cken <daniel@debakel.net>
version:	1.0
since:	0.1.2
access:	public

Parameters:

string

$string

[ Top ]

method getAttachmentContent [line 334]

string getAttachmentContent(
)

Returns the generated attachment data as header information in mime type.

Tags:

author:	Daniel PlÃ¼cken <daniel@debakel.net>
version:	1.0
since:	0.1.52
access:	public

[ Top ]

method getTargetEmail [line 206]

string getTargetEmail(
)

Returns the stored email.

Tags:

author:	Daniel PlÃ¼cken <daniel@debakel.net>
version:	1.0
since:	0.1.2
access:	public

[ Top ]

method send [line 370]

boolean send(
string
$sender_email, [string
$subject = ""], [string
$content = ""])

Sends the email with values of the form to the addressee stored in $this->target_email.

Tags:

author:	Daniel PlÃ¼cken <daniel@debakel.net>
version:	1.32
since:	0.1.2
access:	public

Parameters:

string	$sender_email
string	$subject
string	$content

[ Top ]

method setContentType [line 153]

void setContentType(
$type
$type)

Sets the type of content of the e-mail. Possible values are "text/plain" or "text/html" for plain text e-mail or html e-email.

Tags:

author:	Daniel PlÃ¼cken <daniel@debakel.net>
version:	1.0
since:	0.1.6
access:	public

Parameters:

$type

$type

[ Top ]

method setReplyEmail [line 257]

void setReplyEmail(
string
$string)

Stores the email where the message should be send on reply.

Tags:

author:	Daniel PlÃ¼cken <daniel@debakel.net>
version:	1.0
since:	0.1.8
access:	public

Parameters:

string

$string

[ Top ]

method setTargetEmail [line 242]

void setTargetEmail(
string
$string)

Stores the email where the message should be send.

Tags:

author:	Daniel PlÃ¼cken <daniel@debakel.net>
version:	1.1
since:	0.1.2
access:	public

Parameters:

string

$string

[ Top ]

method setTargetEmailBlindCopyArray [line 319]

void setTargetEmailBlindCopyArray(
array
$array)

Stores the emails where the message should be send in blind copy.

Tags:

author:	Daniel PlÃ¼cken <daniel@debakel.net>
version:	1.0
since:	0.1.2
access:	public

Parameters:

array

$array

[ Top ]

method setTargetEmailCopyArray [line 288]

void setTargetEmailCopyArray(
array
$array)

Stores the emails where the message should be send in copy.

Tags:

author:	Daniel PlÃ¼cken <daniel@debakel.net>
version:	1.0
since:	0.1.2
access:	public

Parameters:

array

$array

[ Top ]

Documentation generated on Thu, 05 Jun 2008 19:11:18 +0200 by phpDocumentor 1.4.1