![[Index]](../../../../a_stock/images/btn_index.gif)
![[Previous]](../../../../a_stock/images/btn_prev_top.gif)
![[Next]](../../../../a_stock/images/btn_next_top.gif)
|
|
|
|
|
|
||
class CSmtpClientMtm : public CBaseMtm;
SMTP client MTM interface.
Most of the functions in this class are implementations of the virtual functions defined by the base class CBaseMtm.
MMsvEntryObserver - Provides the interface for notification of events associated with an entry.
CBase -
Base class for all classes to be instantiated on the heap.
CBaseMtm - Provides a high-level interface for accessing and manipulating a Message Server ...
CSmtpClientMtm - SMTP client MTM interface.
Defined in CSmtpClientMtm:
AddAddresseeL(TMsvRecipientType,const TDesC &)AddAddresseeL(TMsvRecipientType,const TDesC &,const TDesC &)AddAddresseeL(const TDesC &)Adds an addressee for the current context.AddAddresseeL(const TDesC &,const TDesC &)Adds an addressee with an alias for the current context.AddAttachmentL(RFile &,const TDesC8 &,TUint,TRequestStatus &)AddAttachmentL(const TDesC &,const TDesC8 &,TUint,TRequestStatus &)AddEntryAsAttachmentL(TMsvId,TRequestStatus &)AddLinkedAttachmentL(const TDesC &,const TDesC8 &,TUint,TRequestStatus &)CancelAttachmentOperation()Cancels the current attachment operation. ChangeDefaultServiceL(const TMsvId &)Sets the default SMTP service.ContextEntrySwitched()Called by the base class functions CBaseMtm::SwitchCurrentEntryL(TMsvId) and CBa...CreateAttachmentL(const TDesC &,RFile &,const TDesC8 &,TUint,TRequestStatus &)CreateMessageL(TMsvId)Creates a new message entry as a child of the current context.DefaultServiceL()constGets the default SMTP service.Find(const TDesC &,TMsvPartList)Searches the specified message part(s) for the plain-text version of the text to...ForwardL(TMsvId,TMsvPartList,TRequestStatus &)Creates a forwarded message from the current message context.InvokeAsyncFunctionL(TInt,const CMsvEntrySelection &,TDes8 &,TRequestStatus &)Invokes asynchronous SMTP-specific operations.InvokeSyncFunctionL(TInt,const CMsvEntrySelection &,TDes8 &)Invokes a synchronous SMTP-specific operation.LoadMessageL()Loads the cache with the message data for the current context. QueryCapability(TUid,TInt &)Queries if the MTM supports a particular capability, specified by a UID.RemoveAddressee(TInt)Removes an address from the current address list.RemoveDefaultServiceL()Removes the default SMTP service. ReplyL(TMsvId,TMsvPartList,TRequestStatus &)Creates a reply message to the current message context.RestoreSettingsL()Loads into the object's cache the service settings from the Central Repository f...SaveMessageL()Commits cached changes to the current message context to the storage controlled ...SetSettingsL(const CImSmtpSettings &)Copies the specified service settings to the cached service settings.SetSubjectL(const TDesC &)Sets the message context's subject text.Settings()constGets the current cached service settings.StoreSettingsL()Stores the current service settings from the object's cache in to the Central Re...SubjectL()constGets the message context's subject text.ValidateMessage(TMsvPartList)Validates the current message context.Inherited from CBase:
Delete(CBase *)Deletes the specified object.operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...operator new(TUint,TAny *)Initialises the object to binary zeroes.operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...Inherited from CBaseMtm:
AddresseeList()constGets the list of intended recipients for the current context, which must be a me...BioTypeChangedL(TUid)Informs client-side MTM that the context's BIO field is being changed as a resul...Body()Gets the body text of the context, that must be a message. For non-message conte...Body()constGets the read-only body text of the context, that must be a message. For non-mes...CBaseMtm(CRegisteredMtmDll &,CMsvSession &)Creates a CBaseMtm with member variables initialised from the passed arguments.Entry()constGets a CMsvEntry for the current context. The message client application can the...Extension_(TUint,TAny *&,TAny *)The default Extension service. The default implementation of this function assum...Filler1()Filler2()GetInterface(TUid)Returns a pointer to the interface with the specified Uid.HandleEntryEventL(TMsvEntryEvent,TAny *,TAny *,TAny *)Indicates that an event has occurred.HasContext()constTests if an MTM context has been set.RestoreBodyL(CMsvStore &)Gets the current cached CRichText from the appropriate stream in the specified m...Session()Gets a reference to the session object passed by the creator of the Client-side ...SetCurrentEntryL(CMsvEntry *)Sets the entry on which later actions are performed to the specified CMsvEntry.SetMessageCharacterSet(TUint)Sets the character encoding value. The character encoding value options are 7-bi...StoreBodyL(CMsvStore &)Stores and commits the current cached CRichText body text to the appropriate str...SwitchCurrentEntryL(TMsvId)Changes the entry on which later actions are performed to the entry with the spe...Type()constGets the Type UID of the message type associated with the Client-side MTM.iAddresseeListThe address list for the current context. iCharFormatLayerCharacter formatting applied to the CRichText object for the body text, as retur...iMsvEntryThe current context. iParaFormatLayerParagraph formatting applied to the CRichText object for the body text, as retur...Inherited from MMsvEntryObserver:
EMsvChildrenChangedOne or more of the children have been changed. aArg1 points to a CMsvEntrySelect...EMsvChildrenInvalidAn error has occurred such that the status of the children is unknown and probab...EMsvChildrenMissingSome new children have been created, but CMsvEntry was unable to retrieve the da...EMsvContextInvalidThe context has become invalid. The entry has been changed, but the CMsvEntry wa...EMsvDeletedChildrenChildren have been deleted. aArg1 points to a CMsvEntrySelection contain the ID ...EMsvEntryChangedThe entry has been changed, either as a result of a CMsvEntry::ChangeL(const TMs...EMsvEntryDeletedThe entry has been deleted by another client. The context is now invalid. EMsvEntryMovedThe current entry has been moved by another client. The CMsvEntry has already be...EMsvNewChildrenNew children have been created. aArg1 points to a CMsvEntrySelection contain the...TMsvEntryEventDefines entry event types. virtual void SaveMessageL();
Commits cached changes to the current message context to the storage controlled by the Message Server.
virtual void LoadMessageL();
Loads the cache with the message data for the current context.
IMPORT_C void StoreSettingsL();
Stores the current service settings from the object's cache in to the Central Repository for the current entry.
The current entry must be a service.
IMPORT_C void RestoreSettingsL();
Loads into the object's cache the service settings from the Central Repository for the current entry.
virtual CMsvOperation* ReplyL(TMsvId aReplyEntryId, TMsvPartList aPartlist, TRequestStatus &aCompletionStatus);
Creates a reply message to the current message context.
|
|
virtual CMsvOperation* ForwardL(TMsvId aForwardEntryId, TMsvPartList aPartList, TRequestStatus &aCompletionStatus);
Creates a forwarded message from the current message context.
|
|
virtual TMsvPartList ValidateMessage(TMsvPartList aPartList);
Validates the current message context.
The addresses for the message are checked to be well-formed email addresses.
|
|
virtual TMsvPartList Find(const TDesC &aTextToFind, TMsvPartList aPartList);
Searches the specified message part(s) for the plain-text version of the text to be found.
|
|
virtual void AddAddresseeL(const TDesC &aRealAddress);
Adds an addressee for the current context.
|
virtual void AddAddresseeL(const TDesC &aRealAddress, const TDesC &aAlias);
Adds an addressee with an alias for the current context.
|
virtual void AddAddresseeL(TMsvRecipientType aType, const TDesC &aRealAddress);
|
virtual void AddAddresseeL(TMsvRecipientType aType, const TDesC &aRealAddress, const TDesC &aAlias);
|
virtual void RemoveAddressee(TInt aIndex);
Removes an address from the current address list.
|
IMPORT_C void SetSettingsL(const CImSmtpSettings &aSettings);
Copies the specified service settings to the cached service settings.
|
IMPORT_C const CImSmtpSettings& Settings() const;
Gets the current cached service settings.
|
IMPORT_C virtual void SetSubjectL(const TDesC &aSubject);
Sets the message context's subject text.
|
IMPORT_C virtual const TPtrC SubjectL() const;
Gets the message context's subject text.
|
virtual TInt QueryCapability(TUid aCapability, TInt &aResponse);
Queries if the MTM supports a particular capability, specified by a UID.
|
|
virtual void InvokeSyncFunctionL(TInt aFunctionId, const CMsvEntrySelection &aSelection, TDes8 &aParameter);
Invokes a synchronous SMTP-specific operation.
|
virtual CMsvOperation* InvokeAsyncFunctionL(TInt aFunctionId, const CMsvEntrySelection &aSelection, TDes8 &aParameter, TRequestStatus
&aCompletionStatus);
Invokes asynchronous SMTP-specific operations.
|
|
|
TSmtpCmdsSMTP-specific commands that can be issued through CSmtpClientMtm::InvokeAsyncFun...IMPORT_C virtual void AddAttachmentL(const TDesC &aFilePath, const TDesC8 &aMimeType, TUint aCharset, TRequestStatus &aStatus);
|
IMPORT_C virtual void AddAttachmentL(RFile &aFile, const TDesC8 &aMimeType, TUint aCharset, TRequestStatus &aStatus);
|
IMPORT_C virtual void AddLinkedAttachmentL(const TDesC &aFilePath, const TDesC8 &aMimeType, TUint aCharset, TRequestStatus
&aStatus);
|
IMPORT_C virtual void AddEntryAsAttachmentL(TMsvId aAttachmentId, TRequestStatus &aStatus);
|
IMPORT_C virtual void CreateAttachmentL(const TDesC &aFileName, RFile &aAttachmentFile, const TDesC8 &aMimeType, TUint aCharset,
TRequestStatus &aStatus);
|
IMPORT_C virtual void CreateMessageL(TMsvId aServiceId);
Creates a new message entry as a child of the current context.
|
IMPORT_C virtual TMsvId DefaultServiceL() const;
Gets the default SMTP service.
KErrNotFound If default service setting does not exist.
|
|
|
IMPORT_C virtual void ChangeDefaultServiceL(const TMsvId &aService);
Sets the default SMTP service.
|
IMPORT_C virtual void CancelAttachmentOperation();
Cancels the current attachment operation.
protected: virtual void ContextEntrySwitched();
Called by the base class functions CBaseMtm::SwitchCurrentEntryL(TMsvId) and CBaseMtm::SetCurrentEntryL(CMsvEntry *) when the context is changed to another entry.
Client applications do not use this function. It is relevant only to implementers of derived classes.
Requirements:
An implementation should clear:
1. address data stored in iAddresseeList
2. any caches of MTM-specific entry data relating to a previous context. For example, if the implementation has a private buffer storing a message subject, for access through Subject(), this buffer should be cleared.
|
Copyright © 2005-2008 Symbian Software Ltd. |
|
![[Previous]](../../../../a_stock/images/btn_prev.gif)
![[Top]](../../../../a_stock/images/btn_top.gif)
![[Next]](../../../../a_stock/images/btn_next.gif)