mail.h

/***************************************************************************
 SimpleMail - Copyright (C) 2000 Hynek Schlawack and Sebastian Bauer

 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.

 This program 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 General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
***************************************************************************/

/*
** mail.h
*/

#ifndef SM__MAIL_H
#define SM__MAIL_H

#include <stdio.h>

#ifndef SM__LISTS_H
#include "lists.h"
#endif

#ifndef SM__CODESETS_H
#include "codesets.h"
#endif

struct header
{
	struct node node; /* embedded node structure */
	char *name;
	char *contents;
};

struct content_parameter
{
	struct node node;
	char *attribute;
	char *value;
};

/**
 * @brief Describes some user presentable information of a mail
 */
struct mail_info
{
	int status;						/* see below */
	int flags;						/* see below */
	utf8 *from_phrase;  	/* decoded "From" field, might be NULL if no phrase was defined */
	utf8 *from_addr;			/* the email address */
	utf8 *to_phrase;			/* decoded "To" field, only the first address, might be NULL if no phrase was defined */
	utf8 *to_addr;				/* the email address, only a single one */
	struct list *to_list; /* a list of all TO'ed receivers (if any) */
	struct list *cc_list; /* a list of all CC'ed receivers (if any) */
	char *pop3_server;		/* the name of the pop3 server where the mail has been downloaded */
	char *reply_addr;			/* the address where the mail should be replied */
	utf8 *subject;
	char *message_id;
	char *message_reply_id;
	unsigned int size;			/* the e-mails size in bytes */
	unsigned int seconds; 	/* seconds since 1.1.1978 */
	unsigned int received;	/* seconds since 1.1.1978 */

	utf8 *excerpt; /**< An small one liner of the mail's contents */

	char *filename;					/* the email filename on disk, NULL if info belongs from a mail not from disk */

	unsigned short reference_count; /* number of additional references to this object */
	unsigned short to_be_freed;

	/* for mail threads */
	struct mail_info *sub_thread_mail;	/* one more level */
	struct mail_info *next_thread_mail;	/* the same level */
	int child_mail;									/* is a child mail */

};

struct mail_complete
{
	struct mail_info *info;   /* can be NULL for multipart mails */

	struct list header_list; /* the mail's headers */
	char *html_header; /* the header in html format, created by mail_create_html_header */

	/* following things are only relevant when reading the mail */
	int mime; /* 0 means is not a mime mail */
	char *content_type;
	char *content_subtype; /* the types of the whole mail */
	char *content_charset; /* the contents charset (usually for text parts only) */
	int content_inline; /* inline the content */
	utf8 *content_description; /* the description field (might be NULL) */
	struct list content_parameter_list; /* additional parameters */
	char *content_transfer_encoding;
	char *content_id; /* id of the content */
	char *content_name;

	unsigned int text_begin; /* the beginning of the mail's text */
	unsigned int text_len; /* the length of the mails text */
	char *text; /* the mails text, allocated only for mails with filename */
	char *extra_text; /* this is extra allocated text, e.g. for decrypted */
										/* e-Mails, will always be freed if set */

	/* after mail_read_structure() */
	/* only used in multipart messages */
	struct mail_complete **multipart_array;
	int multipart_allocated;
	int num_multiparts;

  /* for "childs" of multipart messages */
	struct mail_complete *parent_mail; /* if NULL, mail is root */

	/* after mail_decode() */
	char *decoded_data; /* the decoded data */
	unsigned int decoded_len;
};

/* Mail status (uses a range from 0-15) */
#define MAIL_STATUS_UNREAD   0 /* unread message */
#define MAIL_STATUS_READ     1 /* read message */
#define MAIL_STATUS_WAITSEND 2 /* wait to be sendet, new composed mail */
#define MAIL_STATUS_SENT     3 /* sent the mail */
#define MAIL_STATUS_REPLIED  4 /* mail has been replied */
#define MAIL_STATUS_FORWARD  5 /* mail has been forwared */
#define MAIL_STATUS_REPLFORW 6 /* mail has been replied and forwarded */
#define MAIL_STATUS_HOLD		 7 /* mail should not be send */
#define MAIL_STATUS_ERROR    8 /* mail has an error */
#define MAIL_STATUS_SPAM     9 /* mail is spam */
#define MAIL_STATUS_MAX     15
#define MAIL_STATUS_MASK		 (0xf) /* the mask for the status types */
#define MAIL_STATUS_FLAG_MARKED (1 << 4) /* the mail is marked */

/* A macro to easly get the mails status type */
#define mail_get_status_type(x) (((x)->status) & (MAIL_STATUS_MASK))
#define mail_is_spam(x) (mail_get_status_type(x) == MAIL_STATUS_SPAM)

#define mail_info_get_status_type(x) (((x)->status) & (MAIL_STATUS_MASK))
#define mail_info_is_spam(x) (mail_info_get_status_type(x) == MAIL_STATUS_SPAM)

/* Additional mail flags, they don't need to be stored within the filename */
#define MAIL_FLAGS_NEW	     (1L << 0) /* it's a new mail */
#define MAIL_FLAGS_GROUP     (1L << 1) /* it has been sent to more persons */
#define MAIL_FLAGS_ATTACH    (1L << 2) /* it has attachments */
#define MAIL_FLAGS_IMPORTANT (1L << 3) /* mail is important */
#define MAIL_FLAGS_CRYPT     (1L << 4) /* mail is crypted */
#define MAIL_FLAGS_SIGNED    (1L << 5) /* mail has been signed */
#define MAIL_FLAGS_NORCPT    (1L << 6) /* mail has no recipient */
#define MAIL_FLAGS_PARTIAL   (1L << 7) /* mail is only partial available localy */
#define MAIL_FLAGS_AUTOSPAM  (1L << 8) /* mail has been marked as spam automatically */

/* The following stuff is for optimizing displaying on AmigaOS, as strings
** must be converted here */
#define MAIL_FLAGS_SUBJECT_ASCII7   (1L << 24) /* subject uses only 7 bit */
#define MAIL_FLAGS_FROM_ASCII7      (1L << 25) /* from uses only 7 bit */
#define MAIL_FLAGS_TO_ASCII7        (1L << 26) /* to uses only 7 bit */
#define MAIL_FLAGS_FROM_ADDR_ASCII7 (1L << 27) /* from addr uses only 7 bit */
#define MAIL_FLAGS_TO_ADDR_ASCII7   (1L << 28) /* to addr uses only 7 bit */
#define MAIL_FLAGS_REPLYTO_ADDR_ASCII7 (1L << 29) /* reply to addr " */

#define mail_get_from(x) ((x)->info->from_phrase?((x)->info->from_phrase):((x)->info->from_addr))
#define mail_get_to(x) ((x)->info->to_phrase?((x)->info->to_phrase):((x)->info->to_addr))

#define mail_info_get_from(x) ((x)->from_phrase?((x)->from_phrase):((x)->from_addr))
#define mail_info_get_to(x) ((x)->to_phrase?((x)->to_phrase):((x)->to_addr))

struct mail_info *mail_info_create(void);
void mail_info_free(struct mail_info *);

struct mail_complete *mail_find_compound_object(struct mail_complete *m, char *id);
struct mail_complete *mail_find_content_type(struct mail_complete *m, char *type, char *subtype);
struct mail_complete *mail_find_initial(struct mail_complete *m);
struct mail_complete *mail_get_root(struct mail_complete *m);
struct mail_complete *mail_get_next(struct mail_complete *m);
int extract_name_from_address(char *addr, char **dest_phrase, char **dest_addr, int *more_ptr);
char *mail_get_from_address(struct mail_info *mail);
char *mail_get_to_address(struct mail_info *mail);
char **mail_info_get_recipient_addresses(struct mail_info *mail);
char *mail_get_replyto_address(struct mail_info *mail);
void mail_info_set_excerpt(struct mail_info *mail, utf8 *excerpt);

int mail_is_marked_as_deleted(struct mail_info *mail);
void mail_identify_status(struct mail_info *m);

struct mail_complete *mail_complete_create(void);
struct mail_complete *mail_create_for(char *from, char *to_str_unexpanded, char *replyto, char *subject, char *body);
struct mail *mail_create_from_file(char *filename);
struct mail_complete *mail_complete_create_from_file(char *filename);
struct mail_complete *mail_create_reply(int num, struct mail_complete **mail_array);
struct mail_complete *mail_create_forward(int num, char **filename_array);
struct mail_info *mail_info_create_from_file(char *filename);

void mail_complete_free(struct mail_complete *mail);

int mail_read_header_list_if_empty(struct mail_complete *m);
int mail_process_headers(struct mail_complete *mail);
void mail_read_contents(char *folder, struct mail_complete *mail);
void mail_decode(struct mail_complete *mail);
void *mail_decode_bytes(struct mail_complete *mail, unsigned int *len_ptr);
void mail_decoded_data(struct mail_complete *mail, void **decoded_data_ptr, int *decoded_data_len_ptr);
int mail_create_html_header(struct mail_complete *mail, int all_headers);

char *mail_find_header_contents(struct mail_complete *mail, char *name);
char *mail_get_new_name(int status);
char *mail_get_status_filename(char *oldfilename, int status_new);

void mail_reference(struct mail_info *mail);
void mail_dereference(struct mail_info *mail);

/* was static */
struct header *mail_find_header(struct mail_complete *mail, char *name);

/* mail scan functions */

struct mail_scan /* don't not access this */
{
	struct mail_complete *mail; /* the mail */
	int avoid_duplicates;

	int position; /* the current position inside the mail */

	char *line; /* temporary saved line */
	int name_size; /* the length of the header's name */
	int contents_size; /* the length of the contents's name */
	int mode;
};

void mail_scan_buffer_start(struct mail_scan *ms, struct mail_complete *mail, int avoid_duplicates);
void mail_scan_buffer_end(struct mail_scan *ms);
int mail_scan_buffer(struct mail_scan *ms, char *mail_buf, int size);

/* for mail composing */
struct composed_mail
{
	struct node node; /* embedded node structure */

	char *from; /* the mail's from account, utf8 */
	char *replyto; /* reply address, utf8 */
	char *to; /* maybe NULL, utf8 */
	char *cc; /* maybe NULL, utf8 */
	char *bcc; /* maybe NULL, utf8 */
	char *subject; /* maybe NULL, utf8 */

	char *filename; /* filename, maybe NULL, used with fopen() */
	char *temporary_filename; /* maybe NULL */
	char *text; /* maybe NULL */
	char *content_type; /* maybe NULL */
	char *content_description; /* maybe NULL */
	char *content_filename; /* maybe NULL, utf8, used in content disposition */

	struct list list; /* more entries */

	char *mail_filename; /* The name of the mail (mainly used for changeing) */
	char *mail_folder; /* the folder of the mail ( -- " -- ) */

	char *reply_message_id; /* only for the root mail */
	int encrypt;
	int sign;
	int importance; /* 0=low, 1=normal, 2=high */

	/* more will follow */
};

void composed_mail_init(struct composed_mail *mail);

int mail_compose_new(struct composed_mail *new_mail, int hold);

/* for nodes in an address list NOTE: misplaced in mail.h */
struct address
{
	struct node node;
	char *realname;
	char *email;
};

struct list *create_address_list(char *str);
struct mailbox *find_addr_spec_in_address_list(struct list *list, char *addr_spec);
void append_to_address_list(struct list *list, char *str);
void append_mailbox_to_address_list(struct list *list, struct mailbox *mb);
void remove_from_address_list(struct list *list, char *email);
void free_address_list(struct list *list);
utf8 *get_addresses_from_list_safe(struct list *list, struct codeset *codeset);

char *mail_create_string(char *format, struct mail_info *mail, char *realname,
												 char *addr_spec);

int mail_allowed_to_download(struct mail_info *mail);

/* Private functions. Only use for testing */
int private_mail_compose_write(FILE *fp, struct composed_mail *new_mail);

#endif