TnyMsgReceiveStrategy

TnyMsgReceiveStrategy — A strategy for receiving messages

Synopsis

                    TnyMsgReceiveStrategy;
                    TnyMsgReceiveStrategyIface;
TnyMsg*             tny_msg_receive_strategy_perform_get_msg
                                                        (TnyMsgReceiveStrategy *self,
                                                         TnyFolder *folder,
                                                         TnyHeader *header,
                                                         GError **err);

Object Hierarchy

  GInterface
   +----TnyMsgReceiveStrategy

Known Implementations

TnyMsgReceiveStrategy is implemented by TnyCamelFullMsgReceiveStrategy, TnyCamelPartialMsgReceiveStrategy and TnyCamelBsMsgReceiveStrategy.

Description

A strategy that can implement receiving a message. For example by fully receiving it, or by partially receiving it.

Details

TnyMsgReceiveStrategy

typedef struct _TnyMsgReceiveStrategy TnyMsgReceiveStrategy;

A strategy for receiving messages

free-function: g_object_unref


TnyMsgReceiveStrategyIface

typedef struct {
	GTypeInterface parent;

	TnyMsg * (*perform_get_msg) (TnyMsgReceiveStrategy *self, TnyFolder *folder, TnyHeader *header, GError **err);
} TnyMsgReceiveStrategyIface;


tny_msg_receive_strategy_perform_get_msg ()

TnyMsg*             tny_msg_receive_strategy_perform_get_msg
                                                        (TnyMsgReceiveStrategy *self,
                                                         TnyFolder *folder,
                                                         TnyHeader *header,
                                                         GError **err);

Performs the receiving of a message from folder. If not NULL, the returned value must be unreferenced after use.

self :

A TnyMsgReceiveStrategy

folder :

a TnyFolder from which the message will be received

header :

a TnyHeader of the message that must be received

err :

(null-ok): A GError or NULL

Returns :

(null-ok) (caller-owns): the received message or NULL

Since 1.0 audience: application-developer