Class Inx_Api_Rendering_ContentType

Description

The Inx_Api_Rendering_ContentType enumeration defines the format of the content of a mailing.

The Inx_Api_Rendering_ContentType enumeration defines the format of the content of a mailing.

Located in /Api/Rendering/ContentType.php (line 15)


	
			
Method Summary
Methods
static method byId (line 114)

Returns the Inx_Api_Rendering_ContentType corresponding to the given id. UNKNOWN type will be returned. inside client code.

Returns the Inx_Api_Rendering_ContentType corresponding to the given id. If the ID is unknown, the UNKNOWN type will be returned. The ID is used for transmission purposes and should not be used inside client code.

  • return: the Inx_Api_Rendering_ContentType corresponding to the given ID.
  • access: public
static Inx_Api_Rendering_ContentType byId (int $iId)
  • int $iId: id the ID of the Inx_Api_Rendering_ContentType to retrieve.
static method HTML_TEXT (line 28)

Content type indicating a HTML content.

Content type indicating a HTML content. A mailing with this content type has only a HTML text part.

  • return: the HTML text content type.
  • access: public
static Inx_Api_Rendering_ContentType HTML_TEXT ()
static method MULTIPART (line 54)

Content type indicating a multipart content.

Content type indicating a multipart content. A mailing with this content type has a HTML and a plain text part.

  • return: the multipart content type.
  • access: public
static Inx_Api_Rendering_ContentType MULTIPART ()
static method PLAIN_TEXT (line 41)

Content type indicating a plain text content.

Content type indicating a plain text content. A mailing with this content type has only a plain text part.

  • return: the plain text content type.
  • access: public
static Inx_Api_Rendering_ContentType PLAIN_TEXT ()
static method SYSTEM (line 68)

Unspecified content type that can only be used to build a mailing. building the mailing is the one associated with the mailing in the remote system i.

Unspecified content type that can only be used to build a mailing. In this case, the content type used for building the mailing is the one associated with the mailing in the remote system i.e. the format of the mailing.

  • return: the default system content type.
  • access: public
static method UNKNOWN (line 81)

Unknown content type, not a legal value for building a mailing.

Unknown content type, not a legal value for building a mailing.

  • return: an unknown content type.
  • access: public
static Inx_Api_Rendering_ContentType UNKNOWN ()
static method values (line 130)

Returns an array containing all available Inx_Api_Rendering_ContentTypes including UNKNOWN.

Returns an array containing all available Inx_Api_Rendering_ContentTypes including UNKNOWN.

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

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

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

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

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