ANSLibs/chilkat/include/CkEmailBundle.h

// CkEmailBundle.h: interface for the CkEmailBundle class.
//
//////////////////////////////////////////////////////////////////////

// This header is generated for Chilkat 11.3.0

#define _CkVersion 11.3.0

#ifndef _CkEmailBundle_H
#define _CkEmailBundle_H
	
#include "chilkatDefs.h"
#include "CkString.h"
#include "CkMultiByteBase.h"

class CkEmail;
class CkJsonObject;
class CkStringArray;
class CkTask;



#if !defined(__sun__) && !defined(__sun)
#pragma pack (push, 8)
#endif


#undef Copy

// CLASS: CkEmailBundle
class CK_VISIBLE_PUBLIC CkEmailBundle  : public CkMultiByteBase
{
    private:

	// Don't allow assignment or copying these objects.
	CkEmailBundle(const CkEmailBundle &);
	CkEmailBundle &operator=(const CkEmailBundle &);

    public:
	CkEmailBundle(void);
	virtual ~CkEmailBundle(void);

	static CkEmailBundle *createNew(void);
	static CkEmailBundle *createNew2(int progLang);
	void CK_VISIBLE_PRIVATE inject(void *impl);

	// May be called when finished with the object to free/dispose of any
	// internal resources held by the object. 
	void dispose(void);

	
		
	

	// BEGIN PUBLIC INTERFACE

	// ----------------------
	// Properties
	// ----------------------
	// The number of emails in this bundle.
	int get_MessageCount(void);



	// ----------------------
	// Methods
	// ----------------------
	// Adds an email object to the bundle.
	bool AddEmail(CkEmail &email);


	// Removes and discards all emails contained in this object.
	void Clear(void);


	// Copies the Nth email contained in this object into email. The 1st email is at
	// index 0.
	bool EmailAt(int index, CkEmail &email);


	// This method is deprecated. Applications should instead call FindEmail .
	// 
	// Returns the first email having a header field matching the headerFieldName and headerFieldValue exactly
	// (case sensitive). If no matching email is found, returns _NULL_.
	// 
	// The caller is responsible for deleting the object returned by this method.
	CkEmail *FindByHeader(const char *headerFieldName, const char *headerFieldValue);


	// Returns the first email from the bundle that matches the search criteria
	// specified in json. This method, which replaces the deprecated FindByHeader
	// method, currently offers the same functionality but can be expanded for
	// additional search options in the future. The matching email, if found, is
	// returned in email.
	bool FindEmail(CkJsonObject &json, CkEmail &email);


	// This method is deprecated. Applications should instead call EmailAt .
	// 
	// Returns the Nth Email in the bundle. The email returned is a copy of the email
	// in the bundle. Updating the email object returned by GetEmail has no effect on
	// the email within the bundle. To update/replace the email in the bundle, your
	// program should call GetEmail to get a copy, make modifications, call
	// RemoveEmailByIndex to remove the email (passing the same index used in the call
	// to GetEmail), and then call AddEmail to insert the new/modified email into the
	// bundle.
	// 
	// IMPORTANT: This method does NOT communicate with any mail server to download the
	// email. It simply returns the Nth email object that exists within it's in-memory
	// collection of email objects.
	// 
	// The caller is responsible for deleting the object returned by this method.
	CkEmail *GetEmail(int index);


	// This method is deprecated and will be removed in a future version of Chilkat.
	// 
	// Returns a StringArray object containing UIDLs for all Email objects in the
	// bundle. UIDLs are only valid for emails retrieved from POP3 servers. An email on
	// a POP3 server has a UIDL , an email on IMAP servers has a UID . If the email was
	// retrieved from an IMAP server, the UID will be accessible via the ckx-imap-uid
	// header field.
	// 
	// The caller is responsible for deleting the object returned by this method.
	CkStringArray *GetUidls(void);


	// Converts the email bundle to an XML document in memory. Returns the XML document
	// as a string.
	bool GetXml(CkString &outXml);

	// Converts the email bundle to an XML document in memory. Returns the XML document
	// as a string.
	const char *getXml(void);
	// Converts the email bundle to an XML document in memory. Returns the XML document
	// as a string.
	const char *xml(void);


	// Loads the email bundle from a completed asynchronous task.
	bool LoadTaskResult(CkTask &task);


	// Loads an email bundle from an XML file.
	bool LoadXml(const char *filename);


	// Loads an email bundle from an XML string.
	bool LoadXmlString(const char *xmlStr);


	// Removes an email from the bundle. This does not remove the email from the mail
	// server.
	bool RemoveEmail(CkEmail &email);


	// Removes the Nth email in a bundle. (Indexing begins at 0.)
	bool RemoveEmailByIndex(int index);


	// Converts each email to XML and persists the bundle to an XML file. The email
	// bundle can later be re-instantiated by calling MailMan.LoadXmlFile
	bool SaveXml(const char *filename);


	// Sorts emails in the bundle by date.
	void SortByDate(bool ascending);


	// Sorts emails in the bundle by recipient.
	void SortByRecipient(bool ascending);


	// Sorts emails in the bundle by sender.
	void SortBySender(bool ascending);


	// Sorts emails in the bundle by subject.
	void SortBySubject(bool ascending);






	// END PUBLIC INTERFACE


};
#if !defined(__sun__) && !defined(__sun)
#pragma pack (pop)
#endif
	
#endif