WSHMailError Class Reference

Collaboration diagram for WSHMailError:

Public Member Functions
	__construct (\Action &$action, $msg)
	reset (\Action &$action, $msg)
	expand ($str)
	autosend ()
	prefixize ($prefix, $msg)
	send ($from, $mailto, $subject, $htmlBody, $altTextBody= '', $attachments=array())
	addExpand ($expand=array())

Data Fields
	$expand = array()
	$action = null
	$msg = ''
	$from = ''
	$mailto = ''
	$subject = ''
	$prefix = false

Detailed Description

Definition at line 4 of file Class.Dcp_WSHMailError.php.

Constructor & Destructor Documentation

__construct	(	\Action &	$action,
			$msg
	)

WSHError constructor.

Parameters

\Action	$action
	$msg

Definition at line 21 of file Class.Dcp_WSHMailError.php.

Member Function Documentation

addExpand

(

$expand = array()

)

Parameters

string[]

$expand

Definition at line 172 of file Class.Dcp_WSHMailError.php.

autosend

(

)

Returns

string

Definition at line 76 of file Class.Dcp_WSHMailError.php.

Here is the call graph for this function:

expand

(

$str

)

Parameters

$str

Returns

string

Definition at line 46 of file Class.Dcp_WSHMailError.php.

prefixize	(		$prefix,
			$msg
	)

Add a prefix at beginning of each lines

Parameters

string	$prefix
string	$msg

Returns

string

Definition at line 114 of file Class.Dcp_WSHMailError.php.

reset	(	\Action &	$action,
			$msg
	)

Parameters

\Action	$action
	$msg

Definition at line 29 of file Class.Dcp_WSHMailError.php.

Here is the call graph for this function:

send	(		$from,
			$mailto,
			$subject,
			$htmlBody,
			$altTextBody = '',
			$attachments = array()
	)

Parameters

string	$from	Sender's email address (e.g. 'john..nosp@m.doe@.nosp@m.examp.nosp@m.le.n.nosp@m.et')
	string|string[]	$mailto Recipient(s) address(es) as a comma-separated list of mail addresses, or and array og mail addresses
string	$subject	Subject
string	$htmlBody	The main body in HTML format
string	$altTextBody	Optional text variant of the main HTML body
	array[]	$attachments Optional attachments (e.g. array( array('file' => '/path/to/att.dat', 'name' => 'icon.png', 'mime' => 'image/png' [, 'cid' => 'CIDidentifier'] ), [...] )))

Returns

string Non-empty string with error message on failure, or empty string on success

Definition at line 127 of file Class.Dcp_WSHMailError.php.

Field Documentation

$action = null

Definition at line 10 of file Class.Dcp_WSHMailError.php.

$expand = array()

Definition at line 6 of file Class.Dcp_WSHMailError.php.

$from = ''

Definition at line 12 of file Class.Dcp_WSHMailError.php.

$mailto = ''

Definition at line 13 of file Class.Dcp_WSHMailError.php.

$msg = ''

Definition at line 11 of file Class.Dcp_WSHMailError.php.

$prefix = false

Definition at line 15 of file Class.Dcp_WSHMailError.php.

$subject = ''

Definition at line 14 of file Class.Dcp_WSHMailError.php.

---

The documentation for this class was generated from the following file:

• Class.Dcp_WSHMailError.php