Class Inx_Api_TriggerMail_BuildException

Description

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.

An Inx_Api_TriggerMail_BuildException is thrown when the building of a trigger 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_TriggerMail_RenderError associated with the exception.

  • author: chge, 09.07.2012
  • see: com.inxmail.xpro.api.triggermail.RenderError
  • see: build(int, int)
  • see: build(int)
  • deprecated: As of 1.11.10, Inx_Api_TriggerMail_TriggerMailingRenderer has been replaced with Inx_Api_Rendering_GeneralMailingRenderer
  • since: API 1.10.0

Located in /Api/TriggerMail/BuildException.php (line 20)

Exception
   |
   --Inx_Api_Rendering_BuildException
      |
      --Inx_Api_TriggerMail_BuildException
Variable Summary
mixed $error
Method Summary
Inx_Api_TriggerMail_BuildException __construct (emailAddress $sEmailAddress, Inx_Api_TriggerMail_RenderError $error)
detail getError ()
Variables
mixed $error (line 23)

Contains detail information about the error.

Contains detail information about the error.

  • access: protected

Redefinition of:
Inx_Api_Rendering_BuildException::$error

Inherited Variables

Inherited from Inx_Api_Rendering_BuildException

Inx_Api_Rendering_BuildException::$emailAddress
Methods
Constructor __construct (line 31)

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

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

  • access: public
Inx_Api_TriggerMail_BuildException __construct (emailAddress $sEmailAddress, Inx_Api_TriggerMail_RenderError $error)
  • emailAddress $sEmailAddress: the email address of the recipient for which the trigger mailing was built.
  • error $error: contains detail information about the error.

Redefinition of:
Inx_Api_Rendering_BuildException::__construct()
Creates an Inx_Api_Rendering_BuildException with the given recipient address and render error.
getError (line 42)

Returns detail information about the error.

Returns detail information about the error.

  • return: information about the error.
  • access: public
detail getError ()

Redefinition of:
Inx_Api_Rendering_BuildException::getError()
Returns the error associated with the exception that contains detailed information about its cause.

Inherited Methods

Inherited From Inx_Api_Rendering_BuildException

Inx_Api_Rendering_BuildException::__construct()
Inx_Api_Rendering_BuildException::getEmailAddress()
Inx_Api_Rendering_BuildException::getError()

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