tc/envelope.h

Go to the documentation of this file.

/*==============================================================================
                Copyright (c) 2003-2005 UGS Corporation
                   Unpublished - All Rights Reserved
 ==============================================================================*/

/*  */

#ifndef ENVELOPE_H
#define ENVELOPE_H

#include <tccore/workspaceobject.h>

typedef struct MAIL_message_s
{
    tag_t       tag;              
    const char* from_user;        
    const char* to_user;          
    const char* subject;          
    const char* text;             
    logical     is_Cc_recipient;  
} MAIL_message_t;

typedef int (* MAIL_send_callback_t) ( MAIL_message_t message );

typedef enum MAIL_callback_position_e
{
    MAIL_replaced_callback,
    MAIL_before_callback,
    MAIL_after_callback
}   MAIL_callback_position_t;

typedef enum MAIL_to_or_cc_e
{
    MAIL_send_to,
    MAIL_send_cc
} MAIL_to_or_cc_t;

#include <tc/libtc_exports.h>

#ifdef __cplusplus
extern "C"{
#endif

extern TC_API int MAIL_envelope_extent(
    int*            n_instances,    
    tag_t**         instances       
    );

extern TC_API int MAIL_create_envelope (
    const char      subject[WSO_name_size_c + 1],   
    const char      comments[WSO_desc_size_c + 1],  
    tag_t*          envelope                        
    );

extern TC_API int MAIL_initialize_envelope (
    tag_t           envelope,                       
    const char      subject[WSO_name_size_c + 1],   
    const char      comments[WSO_desc_size_c + 1]   
    );

extern TC_API int MAIL_initialize_envelope2 (
    tag_t           envelope,                       
    const char      *subject,                       
    const char      *comments                       
    );

extern TC_API int MAIL_add_envelope_receiver (
    tag_t           envelope,   
    tag_t           receiver    
    );

extern TC_API int MAIL_add_envelope_cc_receiver (
    tag_t           envelope,   
    tag_t           ccReceiver  
    );

extern TC_API int MAIL_list_envelope_receivers (
    tag_t           envelope,   
    int*            count,      
    tag_t**         receivers   
    );

extern TC_API int MAIL_list_envelope_to_receivers (
    tag_t           envelope,   
    int*            count,      
    tag_t**         receivers   
    );

extern TC_API int MAIL_list_envelope_cc_receivers (
    tag_t           envelope,    
    int*            count,       
    tag_t**         ccReceivers  
    );

extern TC_API int MAIL_send_envelope (
    tag_t           envelope    
    );

extern TC_API int MAIL_register_send_callback(
    MAIL_send_callback_t        function_pointer, 
    MAIL_callback_position_t    position          
    );

extern TC_API int MAIL_add_external_receiver (
    tag_t           envelope,   
    MAIL_to_or_cc_t to_or_cc,   
    char*           receiver    
    );

#ifdef __cplusplus
}
#endif

#include <tc/libtc_undef.h>

#endif

---