Class Inx_Api_Rendering_BuildException

Description

An Inx_Api_Rendering_BuildException is thrown when the building of a mailing fails. illegal recipient address or a general building failure. Inx_Api_Rendering_RenderError associated with the exception.

An Inx_Api_Rendering_BuildException is thrown when the building of a mailing fails. This may be due to an illegal recipient address or a general building failure. For a deeper insight on the error, consult the Inx_Api_Rendering_RenderError associated with the exception.

Located in /Api/Rendering/BuildException.php (line 17)

Exception
   |
   --Inx_Api_Rendering_BuildException
Direct descendents
Class Description
Inx_Api_Mail_BuildException An Inx_Api_Mail_BuildException is thrown when the building of a mailing fails.
Inx_Api_TriggerMail_BuildException An Inx_Api_TriggerMail_BuildException is thrown when the building of a trigger mailing fails. to an illegal recipient address or a general building failure. Inx_Api_TriggerMail_RenderError associated with the exception.
Variable Summary
Method Summary
Inx_Api_Rendering_BuildException __construct (string $sEmailAddress, Inx_Api_Rendering_RenderError $error)
string getEmailAddress ()
Variables
string $emailAddress (line 22)
  • var: The email address of the recipient for which the mailing was built.
  • access: protected
  • var: Error associated with the exception, contains detailed information about its cause.
  • access: protected

Redefined in descendants as:

Inherited Variables

Inherited from Exception (Internal Class)

$code
$file
$line
$message
$previous
$string
$trace
Methods
Constructor __construct (line 36)

Creates an Inx_Api_Rendering_BuildException with the given recipient address and render error.

Creates an Inx_Api_Rendering_BuildException with the given recipient address and render error.

  • access: public
Inx_Api_Rendering_BuildException __construct (string $sEmailAddress, Inx_Api_Rendering_RenderError $error)
  • string $sEmailAddress: the email address of the recipient for which the mailing was built.
  • Inx_Api_Rendering_RenderError $error: the error associated with the exception.

Redefinition of:
Exception::constructor __construct ( [$message = ], [$code = ], [$previous = ] )

Redefined in descendants as:
getEmailAddress (line 58)

Returns the email address of the recipient for which the mailing was built.

Returns the email address of the recipient for which the mailing was built.

  • return: the email address of the recipient for which the mailing was built.
  • access: public
string getEmailAddress ()
getError (line 48)

Returns the error associated with the exception that contains detailed information about its cause.

Returns the error associated with the exception that contains detailed information about its cause.

  • return: returns the error associated with the exception.
  • access: public

Redefined in descendants as:

Inherited Methods

Inherited From Exception (Internal Class)

constructor __construct ( [$message = ], [$code = ], [$previous = ] )
getCode ( )
getFile ( )
getLine ( )
getMessage ( )
getPrevious ( )
getTrace ( )
getTraceAsString ( )
__clone ( )
__toString ( )

Documentation generated on Thu, 17 Sep 2015 14:27:22 +0200 by phpDocumentor 1.3.2