message.h

Go to the documentation of this file.

/*
 * XetPan: a libEtPan! based Mail User Agent
 * Copyright (C) 2002 Melvin Hadasht
 *
 * 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 MESSAGE_H
#define MESSAGE_H

#include <stdio.h> /* FILE */

#include <libetpan.h>
#include <carray.h>

#include "folder-types.h"
#include "message-types.h"

struct XePMessage_s
{
  char *data;             
  size_t len;             
  XePFolder *folder;      
  uint32_t muid;          
  int async;              
  mailmessage *msg;       
  struct mailmime *mime;  
  struct mailimf_fields *fields;  
  struct mailimf_single_fields *single_fields;  
  struct mailmime *selected_mime; 
  struct mailmime *default_mime; 
  uint32_t flags_set;     
  uint32_t flags_unset;   
  char *source_charset;   
  const char *dest_charset; 
  int owner;              
  char *filename;         
  int fd;                 
  char *msg_data;         
  size_t msg_size;        
};


XePMessage *
a_Message_new(void);

XePMessage *
a_Message_new_from_data_noparse(char *data, size_t size);

XePMessage *
a_Message_new_from_file_noparse(const char *filename);

XePMessage *
a_Message_new_from_data(char *data, size_t len);

XePMessage *
a_Message_new_for_fetching(XePFolder *folder, mailmessage *msg);

XePMessage *
a_Message_new_to_compose(void);

XePMessage *
a_Message_new_to_reply(XePMessage *message);

XePMessage *
a_Message_new_to_forward(XePMessage *message);

XePMessage *
a_Message_new_to_redirect(XePMessage *message);

void
a_Message_free(XePMessage *message);


void
a_Message_free_cb(void *amessage, void *anargout);

XePMessage *
a_Message_clone(XePMessage *message);

int
a_Message_file_open(XePMessage *message);

void
a_Message_file_close(XePMessage *message);

void
a_Message_set_folder(XePMessage *message, XePFolder *folder);

XePFolder *
a_Message_get_folder(XePMessage *message);

char *
a_Message_message_formatted_get_header(mailmessage *msg, 
                                       XePMessageHeaderType type,
                                       char *other_header,
                                       char *template,
                                       char *dest_charset);

const char *
a_Message_header_get_name_from_type(XePMessageHeaderType type);

XePMessageHeaderType 
a_Message_header_get_type_from_name(const char *header_name);

void
a_Message_header_remove_by_name(XePMessage *message, const char *header_name);

void
a_Message_header_remove(XePMessage *message,
                        XePMessageHeaderType type,
                        const char *other_header);


void
a_Message_header_add_by_name(XePMessage *message,
                             const char *header_name,
                             const char *header_value,
                             const char *header_charset);

void
a_Message_header_add(XePMessage *message,
                     XePMessageHeaderType type,
                     const char *header_name,
                     const char *header_value,
                     const char *header_charset);

int
a_Message_header_set_from(XePMessage *message, 
                          const char *from,
                          const char *charset);
int
a_Message_header_add_to(XePMessage *message,
                        const char *to, 
                        const char *charset);

int
a_Message_header_add_cc(XePMessage *message, 
                        const char *cc,
                        const char *charset);

int
a_Message_header_add_bcc(XePMessage *message, 
                         const char *bcc,
                         const char *charset);

int
a_Message_header_add_reply_to(XePMessage *message,
                              const char *reply_to, 
                              const char *charset);

int
a_Message_header_add_other(XePMessage *message,
                           const char *header_name,
                           const char *header_value,
                           const char *header_charset);
int
a_Message_header_set_subject(XePMessage *message, 
                             const char *header_value, 
                             const char *header_charset);

char *
a_Message_message_formatted_get_local_date(struct mailimf_single_fields *fields,
                                           char *template,
                                           char *dest_charset);

char *
a_Message_message_formatted_get_orig_date(struct mailimf_single_fields *fields,
                                          char *template,
                                          char *dest_charset);
char *
a_Message_message_formatted_get_from(struct mailimf_single_fields *fields,
                                     char *template,
                                     char *dest_charset);
char *
a_Message_message_formatted_get_sender(struct mailimf_single_fields *fields,
                                       char *template,
                                       char *dest_charset);
char *
a_Message_message_formatted_get_reply_to(struct mailimf_single_fields *fields,
                                         char *template,
                                         char *dest_charset);
char *
a_Message_message_formatted_get_to(struct mailimf_single_fields *fields,
                                   char *template,
                                   char *dest_charset);
char *
a_Message_message_formatted_get_cc(struct mailimf_single_fields *fields,
                                   char *template,
                                   char *dest_charset);
char *
a_Message_message_formatted_get_bcc(struct mailimf_single_fields *fields,
                                    char *template,
                                    char *dest_charset);

char *
a_Message_message_formatted_get_message_id(struct mailimf_single_fields *fields,
                                           char *template,
                                           char *dest_charset);

char *
a_Message_message_formatted_get_in_reply_to(struct mailimf_single_fields *fields,
                                            char *template,
                                            char *dest_charset);

char *
a_Message_message_formatted_get_references(struct mailimf_single_fields *fields,
                                           char *template,
                                           char *dest_charset);

char *
a_Message_message_formatted_get_subject(struct mailimf_single_fields *fields,
                                        char *template,
                                        char *dest_charset);

char *
a_Message_message_formatted_get_comments(struct mailimf_single_fields *fields,
                                         char *template,
                                         char *dest_charset);

char *
a_Message_message_formatted_get_keywords(struct mailimf_single_fields *fields,
                                         char *template,
                                         char *dest_charset);

char *
a_Message_message_formatted_get_other(struct mailimf_single_fields *fields,
                                      char *template,
                                      char *other_header,
                                      char *dest_charset);

int
a_Message_message_get_subject(struct mailimf_single_fields *fields,
                              char *dest_charset,
                              char **subject);

int
a_Message_message_get_from(struct mailimf_single_fields *fields,
                           char *dest_charset,
                           char **display_name,
                           char **email_address);

int
a_Message_message_get_other(struct mailimf_fields *fields,
                            char *other_header, 
                            char *dest_charset,
                            char **other);

void
a_Message_decode_selected(XePMessage *message);

/* Message fetching */

int
a_Message_get_bodystructure(XePMessage *message);

int
a_Message_mime_find_default(XePMessage *message);

int
a_Message_fetch_part(XePMessage *message);

int
a_Message_fetch(XePMessage *message);

int
a_Message_flags_change(XePMessage *message);

int
a_Message_array_flags_change(carray *messages);

int
a_Message_mime_is_text(struct mailmime *mime);

char *
a_Message_mime_get_type(struct mailmime_content *content);

struct mailmime *
a_Message_mime_new_from_file(const char *filename, 
                             const char *mime_type,
                             int mechanism);

struct mailmime *
a_Message_mime_new_from_data(char *data,
                             size_t size,
                             const char *mime_type,
                             int mechanism);

void
a_Message_mime_set_body_text(struct mailmime *mime, 
                             char *data, 
                             size_t size);

struct mailmime *
a_Message_mime_new_multipart(char *subtype, int mechanism);

struct mailmime *
a_Message_mime_new_message(char *subtype, int mechanism);

struct mailmime *
a_Message_mime_add_part_to_selected(XePMessage *message, 
                                    char *data,
                                    size_t size,
                                    const char *mime_type,
                                    int mechanism);
int
a_Message_mime_add_parameter(struct mailmime *mime, 
                             const char *param_name,
                             const char *param_value);

int
a_Message_mime_remove_parameter(struct mailmime *mime,
                                const char *param_name);

int
a_Message_mime_add_submime(struct mailmime *mime, struct mailmime *submime);

void
a_Message_mime_set_description(struct mailmime *mime, char *description);

int
a_Message_mime_remove_selected(XePMessage *message);

const char *
a_Message_get_first_from_addr_spec(XePMessage *message);

struct mailimf_field *
a_Message_get_field(XePMessage *message,
                    XePMessageHeaderType type,
                    const char *other_header);

int
a_Message_data_save_as(XePMessage *message, const char *filename);

void
a_Message_write_to_file(XePMessage *message, FILE *file);

char *
a_Message_write_to_temp_file(XePMessage *message);

void
a_Message_append_to_folder(XePMessage *message);

carray *
a_Message_array_new_for_flags_change(XePFolder *folder,
                                     void **selection, 
                                     uint32_t n, 
                                     XePMessageFlagsOp flag_op,
                                     int flags);
#endif

---