Class Inx_Api_Rendering_BuildMode

Description

The Inx_Api_Rendering_BuildMode determines how a mailing is built by the Inx_Api_Rendering_GeneralMailingRenderer.

The Inx_Api_Rendering_BuildMode determines how a mailing is built by the Inx_Api_Rendering_GeneralMailingRenderer.

  • since: API 1.11.10

Located in /Api/Rendering/BuildMode.php (line 14)


	
			
Method Summary
Methods
static method ALTERNATIVEVIEW_ACTIVE (line 45)

Mode for alternative view. trigger any event or generate any click. the Inxmail server.

Mode for alternative view. Standard links are fully functional, tracking links are functional but will not trigger any event or generate any click. Embedded images are replaced with http references to image resources on the Inxmail server.

  • return: the 'alternative view active' build mode.
  • access: public
static Inx_Api_Rendering_BuildMode ALTERNATIVEVIEW_ACTIVE ()
static method ALTERNATIVEVIEW_ACTIVE_SIMPLE_LINKS (line 107)

Mode for alternative view. replaced with http references to image resources on the Inxmail server.

Mode for alternative view. All links are fully functional but converted to simple links. Embedded images are replaced with http references to image resources on the Inxmail server.

  • return: the 'alternative view active simple links' build mode.
  • access: public
static Inx_Api_Rendering_BuildMode ALTERNATIVEVIEW_ACTIVE_SIMPLE_LINKS ()
static method ALTERNATIVEVIEW_INACTIVE (line 61)

Mode for mail preview. any event or generate any click, unsubscription links will redirect but not unsubscribe anybody. are replaced with http references to image resources on the Inxmail server. return true while building the mailing.

Mode for mail preview. Standard links are fully functional, tracking links are functional but will not trigger any event or generate any click, unsubscription links will redirect but not unsubscribe anybody. Embedded images are replaced with http references to image resources on the Inxmail server. The function InInboxView() will return true while building the mailing.

  • return: the 'alternative view inactive' build mode.
  • access: public
static Inx_Api_Rendering_BuildMode ALTERNATIVEVIEW_INACTIVE ()
static method ARCHIVE (line 93)

Mode for archive view. any event or generate any click, unsubscription links will redirect but not unsubscribe anybody. are replaced with http references to image resources on the Inxmail server. return true while building the mailing.

Mode for archive view. Standard links are fully functional, tracking links are functional but will not trigger any event or generate any click, unsubscription links will redirect but not unsubscribe anybody. Embedded images are replaced with http references to image resources on the Inxmail server. The function InInboxView() will return true while building the mailing.

  • return: the 'archive' build mode.
  • access: public
static Inx_Api_Rendering_BuildMode ARCHIVE ()
static method byId (line 167)

Returns the Inx_Api_Rendering_BuildMode corresponding to the given ID. UKNOWN build mode will be returned. inside client code.

Returns the Inx_Api_Rendering_BuildMode corresponding to the given ID. If the ID is unknown, the UKNOWN build mode will be returned. The ID is used for transmission purposes and should not be used inside client code.

  • return: the Inx_Api_Rendering_BuildMode corresponding to the given ID.
  • access: public
static Inx_Api_Rendering_BuildMode byId (int $iId)
  • int $iId: the ID of the Inx_Api_Rendering_BuildMode to retrieve.
static method NEWSLETTER_SIMPLE_LINKS (line 121)

All links are fully functional but converted to simple links. to image resources on the Inxmail server.

All links are fully functional but converted to simple links. Embedded images are replaced with http references to image resources on the Inxmail server. The function InInboxView() will return true while building the mailing.

  • return: the 'newsletter simple links' build mode.
  • access: public
static Inx_Api_Rendering_BuildMode NEWSLETTER_SIMPLE_LINKS ()
static method NORMAL (line 30)

Mode for generating a normal mailing, ready to be sent.

Mode for generating a normal mailing, ready to be sent.

  • return: the 'normal' build mode.
  • access: public
static Inx_Api_Rendering_BuildMode NORMAL ()
static method PREVIEW (line 77)

Mode for mail preview. any event or generate any click, unsubscription links will redirect but not unsubscribe anybody. are replaced with http references to image resources on the Inxmail server. return true while building the mailing.

Mode for mail preview. Standard links are fully functional, tracking links are functional but will not trigger any event or generate any click, unsubscription links will redirect but not unsubscribe anybody. Embedded images are replaced with http references to image resources on the Inxmail server. The function InInboxView() will return true while building the mailing.

  • return: the 'preview' build mode.
  • access: public
static Inx_Api_Rendering_BuildMode PREVIEW ()
static method UNKNOWN (line 134)

Constant for an unknown build mode.

Constant for an unknown build mode. This mode indicates a version mismatch between API and server.

  • return: an unknown build mode.
  • access: public
static Inx_Api_Rendering_BuildMode UNKNOWN ()
static method values (line 183)

Returns an array containing all available Inx_Api_Rendering_BuildModes including UNKNOWN.

Returns an array containing all available Inx_Api_Rendering_BuildModes including UNKNOWN.

  • return: an array containing all available Inx_Api_Rendering_BuildModes including UNKNOWN.
  • access: public
static array values ()
getId (line 154)

Returns the ID of the Inx_Api_Rendering_BuildMode. not be used inside client code.

Returns the ID of the Inx_Api_Rendering_BuildMode. The ID is used for transmission purposes and should not be used inside client code.

  • return: the ID of the Inx_Api_Rendering_BuildMode.
  • access: public
int getId ()

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