aboutsummaryrefslogblamecommitdiffstats
path: root/camel/camel-mime-message.h
blob: c790138f708007f4495597d18dd28ed8595865db (plain) (tree)
1
2
3
4
5
6
7

                                                                                             
  

                                                       
  
                                                                   







                                                                     
                                                                


















                                                                      

                                  
                                   
                                         
 


                                      
 



                                                                                                                
                                                                                  

 

                                       
 











                                                                                        
                        
 
                                    
 
                           


                                                                
 

                        
 
                    

                                                                          
 
                          

                                                           

                          
                                                                                

                           
                            
  
 



                                 

                
                                        



                                                                                                   
                                



                                                                                   








                                           
                                                                  

 



                                                                                                                        











                                                                                            










                                                                                                           



                                                                                                                

                                                                                            
 




                                 
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; fill-column: 160 -*- */
/* camelMimeMessage.h : class for a mime message
 *
 * Authors: Bertrand Guiheneuf <bertrand@helixcode.com>
 *      Michael Zucchi <notzed@helixcode.com>
 *
 * Copyright 1999, 2000 Helix Code, Inc. (http://www.helixcode.com)
 *
 * 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
 */


#ifndef CAMEL_MIME_MESSAGE_H
#define CAMEL_MIME_MESSAGE_H 1


#ifdef __cplusplus
extern "C" {
#pragma }
#endif /* __cplusplus }*/

#include <gtk/gtk.h>
#include <camel/camel-types.h>
#include <camel/camel-mime-part.h>
#include <camel/camel-mime-utils.h>
#include <camel/camel-internet-address.h>

#define CAMEL_RECIPIENT_TYPE_TO "To"
#define CAMEL_RECIPIENT_TYPE_CC "Cc"
#define CAMEL_RECIPIENT_TYPE_BCC "Bcc"


#define CAMEL_MIME_MESSAGE_TYPE     (camel_mime_message_get_type ())
#define CAMEL_MIME_MESSAGE(obj)     (GTK_CHECK_CAST((obj), CAMEL_MIME_MESSAGE_TYPE, CamelMimeMessage))
#define CAMEL_MIME_MESSAGE_CLASS(k) (GTK_CHECK_CLASS_CAST ((k), CAMEL_MIME_MESSAGE_TYPE, CamelMimeMessageClass))
#define CAMEL_IS_MIME_MESSAGE(o)    (GTK_CHECK_TYPE((o), CAMEL_MIME_MESSAGE_TYPE))


/* specify local time */
#define CAMEL_MESSAGE_DATE_CURRENT (~0)

/* system flag bits */
enum _CamelMessageFlags {
    CAMEL_MESSAGE_ANSWERED = 1<<0,
    CAMEL_MESSAGE_DELETED = 1<<1,
    CAMEL_MESSAGE_DRAFT = 1<<2,
    CAMEL_MESSAGE_FLAGGED = 1<<3,
    CAMEL_MESSAGE_SEEN = 1<<4,
    /* following flags are for the folder, and are not really permanent flags */
    CAMEL_MESSAGE_FOLDER_FLAGGED = 1<<16, /* for use by the folder implementation */
    CAMEL_MESSAGE_USER = 1<<31 /* supports user flags */
};

struct _CamelMimeMessage
{
    CamelMimePart parent_object;

    /* header fields */
    time_t date;
    int date_offset;    /* GMT offset */
    char *date_str;     /* cached copy of date string */

    gchar *subject;
    gchar *reply_to;

    gchar *from;

    GHashTable *recipients; /* hash table of CamelInternetAddress's */

    /* other fields */
    guint32 flags;      /* system flags */
    GHashTable *user_flags; /* if present, then true */
    gboolean expunged;
    
    guint message_number; /* set by folder object when retrieving message */
    gchar *message_uid;

    CamelFolder *folder;
};

enum _MessageChangeType {
    MESSAGE_FLAGS_CHANGED,
    MESSAGE_ENVELOPE_CHANGED,
};

typedef struct {
    CamelMimePartClass parent_class;

    /* signals */
    void        (*message_changed)  (CamelMimeMessage *, enum _MessageChangeType type);

    /* Virtual methods */   
    void            (*set_message_number)     (CamelMimeMessage *mime_message, 
                           guint number);
    guint           (*get_message_number)     (CamelMimeMessage *mime_message);

} CamelMimeMessageClass;



/* Standard Gtk function */
GtkType camel_mime_message_get_type (void);


/* public methods */
CamelMimeMessage * camel_mime_message_new                  (void);


void               camel_mime_message_set_date         (CamelMimeMessage *mime_message,  time_t date, int offset);
void               camel_mime_message_get_date         (CamelMimeMessage *mime_message,  time_t *date, int *offset);
char          *camel_mime_message_get_date_string      (CamelMimeMessage *mime_message);

const gchar *      camel_mime_message_get_received_date    (CamelMimeMessage *mime_message);
const gchar *      camel_mime_message_get_sent_date        (CamelMimeMessage *mime_message);
void               camel_mime_message_set_reply_to         (CamelMimeMessage *mime_message, 
                                const gchar *reply_to);
const gchar *      camel_mime_message_get_reply_to         (CamelMimeMessage *mime_message);
void               camel_mime_message_set_subject          (CamelMimeMessage *mime_message, 
                                const gchar *subject);
const gchar *      camel_mime_message_get_subject          (CamelMimeMessage *mime_message);
void               camel_mime_message_set_from             (CamelMimeMessage *mime_message, 
                                const gchar *from);
const gchar *      camel_mime_message_get_from             (CamelMimeMessage *mime_message);


void        camel_mime_message_add_recipient (CamelMimeMessage *mime_message,
                          const char *type, const char *name, const char *address);
void        camel_mime_message_remove_recipient_address (CamelMimeMessage *mime_message, 
                                 const char *type, const char *address);
void        camel_mime_message_remove_recipient_name (CamelMimeMessage *mime_message, 
                              const char *type, const char *name);

const CamelInternetAddress *camel_mime_message_get_recipients (CamelMimeMessage *mime_message, 
                                   const char *type);

guint32       camel_mime_message_get_flags      (CamelMimeMessage *m);
void          camel_mime_message_set_flags      (CamelMimeMessage *m, guint32 flags, guint32 set);
gboolean      camel_mime_message_get_user_flag  (CamelMimeMessage *m, const char *name);
void          camel_mime_message_set_user_flag  (CamelMimeMessage *m, const char *name, gboolean value);

guint              camel_mime_message_get_message_number   (CamelMimeMessage *mime_message);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* CAMEL_MIME_MESSAGE_H */