You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
133 lines
3.4 KiB
133 lines
3.4 KiB
/*
|
|
* This is a simple kioslave to handle mbox-files.
|
|
* Copyright (C) 2004 Mart Kelder (mart.kde@hccnet.nl)
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
#ifndef READMBOX_H
|
|
#define READMBOX_H
|
|
|
|
#include "mboxfile.h"
|
|
|
|
class UrlInfo;
|
|
class MBox;
|
|
|
|
class TQFile;
|
|
class TQString;
|
|
class TQTextStream;
|
|
|
|
struct utimbuf;
|
|
|
|
/**
|
|
* This class handels reading from a mbox-file.
|
|
*/
|
|
class ReadMBox : public MBoxFile
|
|
{
|
|
public:
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param info The information of the file to read
|
|
* @param tqparent The instance of the tqparent MBoxProtocol.
|
|
* @param onlynew Only read new messages from the MBox file.
|
|
* @param savetime If true, the atime of the mbox-file is preserved (note that this touch the ctime).
|
|
*/
|
|
ReadMBox( const UrlInfo* info, MBoxProtocol* tqparent, bool onlynew = false, bool savetime = false );
|
|
|
|
/**
|
|
* Destructor
|
|
*/
|
|
~ReadMBox();
|
|
|
|
/**
|
|
* This functions return the current line
|
|
* @return The line last read, or TQString() if there wasn't such last line
|
|
*/
|
|
TQString currentLine() const;
|
|
|
|
/**
|
|
* This function returns the current id. The id is the first line of an email,
|
|
* and is used in filenaming. The id normally starts with "From ".
|
|
* @return The current ID, or TQString() if no id was found yet.
|
|
*/
|
|
TQString currentID() const;
|
|
|
|
/**
|
|
* This function reads the next line. The next line can be read by the currentLine()
|
|
* function call.
|
|
*
|
|
* @return true if succesfull, otherwise false.
|
|
*/
|
|
bool nextLine();
|
|
|
|
/**
|
|
* This function search the file for a certain id.
|
|
* If not found, the position is EOF.
|
|
* @param id The id of the message to be found.
|
|
* @return true if the message was found, false otherwise.
|
|
*/
|
|
bool searchMessage( const TQString& id );
|
|
|
|
/**
|
|
* Skips all lines which belongs to the current message. The cursor is on the first line
|
|
* of a new message message at the end of this function, or at EOF if the cursor was already
|
|
* on the last message.
|
|
* @return The number of bytes read while skipping the message.
|
|
*/
|
|
unsigned int skipMessage();
|
|
|
|
/**
|
|
* Sets the cursor back to the beginning of the file
|
|
*/
|
|
void rewind();
|
|
|
|
/**
|
|
* Returns true if the cursor is at EOF.
|
|
* @return true if and only if the cursor is at EOF.
|
|
*/
|
|
bool atEnd() const;
|
|
|
|
/**
|
|
* Return true if the message is a new message, or all messages are listed
|
|
* @return true if it must be listed
|
|
*/
|
|
bool inListing() const;
|
|
private:
|
|
/**
|
|
* Opens a file
|
|
* @return true Returns true if opening was succesful.
|
|
*/
|
|
bool open( bool savetime );
|
|
|
|
/**
|
|
* Closes a file.
|
|
*/
|
|
void close();
|
|
|
|
private:
|
|
TQFile* m_file;
|
|
TQTextStream* m_stream;
|
|
TQString* m_current_line;
|
|
TQString* m_current_id;
|
|
bool m_atend;
|
|
|
|
struct utimbuf* m_prev_time;
|
|
|
|
bool m_only_new, m_savetime;
|
|
|
|
bool m_status, m_prev_status, m_header;
|
|
};
|
|
#endif
|