#include <SMTPResponse.hpp>

Inheritance diagram for SMTPResponse:

Collaboration diagram for SMTPResponse:

Classes
struct	enhancedStatusCode

class	responseLine

struct	state

Public Member Functions
int	getCode () const

const enhancedStatusCode	getEnhancedCode () const

const string	getText () const

const responseLine	getLineAt (const size_t pos) const

size_t	getLineCount () const

const responseLine	getLastLine () const

const state	getCurrentState () const

Static Public Member Functions
static shared_ptr< SMTPResponse >	readResponse (shared_ptr< tracer > tr, shared_ptr< socket > sok, shared_ptr< timeoutHandler > toh, const state &st)

Additional Inherited Members
Protected Member Functions inherited from object
	object ()

	object (const object &)

object &	operator= (const object &)

virtual	~object ()

Detailed Description

A SMTP response, as sent by the server.

Member Function Documentation

◆ getCode()

int getCode ( ) const

Return the SMTP response code.

Returns: response code

◆ getCurrentState()

const SMTPResponse::state getCurrentState ( ) const

Returns the current state of the response parser.

Returns: current parser state

References SMTPResponse::state::responseBuffer.

◆ getEnhancedCode()

const SMTPResponse::enhancedStatusCode getEnhancedCode ( ) const

Return the SMTP enhanced status code, if available.

Returns: enhanced status code

◆ getLastLine()

const SMTPResponse::responseLine getLastLine ( ) const

Return the last line in the response.

Returns: last response line

◆ getLineAt()

const SMTPResponse::responseLine getLineAt ( const size_t pos ) const

Return the response line at the specified position.

Parameters

pos	line index

Returns: line at the specified index

◆ getLineCount()

size_t getLineCount ( ) const

Return the number of lines in the response.

Returns: number of lines in the response

◆ getText()

const string getText ( ) const

Return the SMTP response text.

The text of each line is concatenated.

Returns: response text

◆ readResponse()

shared_ptr< SMTPResponse > readResponse	(	shared_ptr< tracer >	tr,
		shared_ptr< socket >	sok,
		shared_ptr< timeoutHandler >	toh,
		const state &	st
	)

static

Receive and parse a new SMTP response from the specified socket.

Parameters

tr	tracer
sok	socket from which to read
toh	time-out handler
st	previous state of response parser for the specified socket

Returns: SMTP response

Exceptions

exceptions::operation_timed_out if no data has been received within the granted time

The documentation for this class was generated from the following files:

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members