Class Inx_Api_Mail_BuildException

Description

An Inx_Api_Mail_BuildException is thrown when the building of a mailing fails.

An Inx_Api_Mail_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_Mail_RenderError associated with the exception.

  • version: $Revision: 9479 $ $Date: 2007-12-18 15:43:23 +0200 (An, 18 Grd 2007) $ $Author: aurimas $
  • see: Inx_Api_Mail_MailingRenderer::build($iRecipientId, $iPreferredMailType=null)
  • see: Inx_Api_Mail_RenderError
  • deprecated: As of 1.11.10, Inx_Api_Mail_MailingRenderer has been replaced with Inx_Api_Rendering_GeneralMailingRenderer

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

Exception
   |
   --Inx_Api_Rendering_BuildException
      |
      --Inx_Api_Mail_BuildException
Variable Summary
Method Summary
Inx_Api_Mail_BuildException __construct (string $sEmailAddress, Inx_Api_Mail_RenderError $oError)
Variables
Inx_Api_Mail_RenderError $oError (line 26)

Contains detail information about the error.

Contains detail information about the error.

  • access: protected

Inherited Variables

Inherited from Inx_Api_Rendering_BuildException

Inx_Api_Rendering_BuildException::$emailAddress
Inx_Api_Rendering_BuildException::$error
Methods
Constructor __construct (line 34)

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

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

  • access: public
Inx_Api_Mail_BuildException __construct (string $sEmailAddress, Inx_Api_Mail_RenderError $oError)
  • string $sEmailAddress: the email address of the recipient for which the mailing was built.
  • Inx_Api_Mail_RenderError $oError: 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 45)

Returns detail information about the error.

Returns detail information about the error.

  • return: detail information about the error.
  • access: public

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