| Reference Manual of the tinymail framework | ||||
|---|---|---|---|---|
TnyMsgReceiveStrategy;
TnyMsgReceiveStrategyIface;
TnyMsg* tny_msg_receive_strategy_perform_get_msg
(TnyMsgReceiveStrategy *self,
TnyFolder *folder,
TnyHeader *header,
GError **err);
TnyMsgReceiveStrategy is implemented by TnyCamelFullMsgReceiveStrategy and TnyCamelPartialMsgReceiveStrategy.
A strategy that can implement receiving a message. For example by fully receiving it, or by partially receiving it.
typedef struct {
GTypeInterface parent;
TnyMsg * (*perform_get_msg_func) (TnyMsgReceiveStrategy *self, TnyFolder *folder, TnyHeader *header, GError **err);
} TnyMsgReceiveStrategyIface;
TnyMsg* tny_msg_receive_strategy_perform_get_msg (TnyMsgReceiveStrategy *self, TnyFolder *folder, TnyHeader *header, GError **err);
Performs the receiving of a message from a folder. If not NULL, the returned
value must be unreferenced after use. If the returned value is NULL and err
wasn't NULL, then err will be set.
self : |
A TnyMsgReceiveStrategy instance |
folder : |
The TnyFolder instance from which the message will be received |
header : |
The TnyHeader instance of the message that must be received |
err : |
A GError instance or NULL |
| Returns : | the received message or NULL |