Current File : /home/inlingua/public_html/decay_sym/root/usr/local/apps/dovecot/include/dovecot/istream-raw-mbox.h

#ifndef ISTREAM_RAW_MBOX_H
#define ISTREAM_RAW_MBOX_H

/* Create a mbox stream for parsing mbox. Reading stops before From-line,
   you'll have to call istream_raw_mbox_next() to get to next message.
   path is used only for logging purposes. */
struct istream *i_stream_create_raw_mbox(struct istream *input);

/* Return offset to beginning of the "\nFrom"-line. */
uoff_t istream_raw_mbox_get_start_offset(struct istream *stream);
/* Return offset to beginning of the headers. */
int istream_raw_mbox_get_header_offset(struct istream *stream,
				       uoff_t *hdr_offset_r);
/* Return offset to beginning of the body. */
int istream_raw_mbox_get_body_offset(struct istream *stream,
				     uoff_t *body_offset_r);

/* Return the number of bytes in the body of this message. If
   expected_body_size isn't UOFF_T_MAX, we'll use it as potentially valid body
   size to avoid actually reading through the whole message. */
int istream_raw_mbox_get_body_size(struct istream *stream,
				   uoff_t expected_body_size,
				   uoff_t *body_size_r);

/* Return received time of current message, or (time_t)-1 if the timestamp is
   broken. */
time_t istream_raw_mbox_get_received_time(struct istream *stream);

/* Return sender of current message. */
const char *istream_raw_mbox_get_sender(struct istream *stream);
/* Return TRUE if the empty line between this and the next mail contains CR. */
bool istream_raw_mbox_has_crlf_ending(struct istream *stream);

/* Jump to next message. If expected_body_size isn't UOFF_T_MAX, we'll use it
   as potentially valid body size. */
int istream_raw_mbox_next(struct istream *stream, uoff_t expected_body_size);

/* Seek to message at given offset. offset must point to beginning of
   "\nFrom ", or 0 for beginning of file. Returns -1 if it offset doesn't
   contain a valid From-line. */
int istream_raw_mbox_seek(struct istream *stream, uoff_t offset);
/* Set next message's start offset. If this isn't set, read stops at the next
   valid From_-line, even if it belongs to the current message's body
   (Content-Length: header can be used to determine that). */
void istream_raw_mbox_set_next_offset(struct istream *stream, uoff_t offset);

/* Returns TRUE if we've read the whole mbox. */
bool istream_raw_mbox_is_eof(struct istream *stream);
/* Returns TRUE if we've noticed corruption in used offsets/sizes. */
bool istream_raw_mbox_is_corrupted(struct istream *stream);
/* Change stream's locking state. We'll assert-crash if stream is tried to be
   read while it's unlocked. */
void istream_raw_mbox_set_locked(struct istream *stream);
void istream_raw_mbox_set_unlocked(struct istream *stream);

#endif