:GetLineMode()


Class

     aprPOP()

 

Syntax

     :GetLineMode( [nMode], [hSession] ) -> nLineMode

 

Parameters

 

nMode

Line mode. See table below.

 

hSession

Optional: If hSession is not passed, the value in :Session will be used

 

Return

Returns the current Line Mode.

 

Description

The :GetLineMode() function returns the value of the line mode bitmask.

 

  

Bitmask specifying the current line mode.

The bitmask is created by combining one or more of the following options:

 

POP_MODE_LINEBREAK

This option specifies that data returned from the server should be terminated on receipt of an end-of-line character sequence. This enables an application to easily read the contents of a header or message in a "line by line" mode.

 

POP_MODE_BINARY

This option specifies that the server may return 8-bit binary data. By default, the client will ignore data that contains non-printable control characters or characters with the high bit set.

 

 

See Also

:SetLineMode(), :Read()