envelope.h File Reference

#include <tccore/workspaceobject.h>
#include <tc/libtc_exports.h>
#include <tc/libtc_undef.h>

Go to the source code of this file.

Data Structures
struct	MAIL_message_s

Typedefs
typedef enum MAIL_callback_position_e	MAIL_callback_position_t
typedef struct MAIL_message_s	MAIL_message_t
typedef int(*	MAIL_send_callback_t )(MAIL_message_t message)
typedef enum MAIL_to_or_cc_e	MAIL_to_or_cc_t

Enumerations
enum	MAIL_callback_position_e { MAIL_replaced_callback, MAIL_before_callback, MAIL_after_callback }
enum	MAIL_to_or_cc_e { MAIL_send_to, MAIL_send_cc }

Functions
TC_API int	MAIL_add_envelope_cc_receiver (tag_t envelope, tag_t ccReceiver)
TC_API int	MAIL_add_envelope_receiver (tag_t envelope, tag_t receiver)
TC_API int	MAIL_add_external_receiver (tag_t envelope, MAIL_to_or_cc_t to_or_cc, char *receiver)
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)
TC_API int	MAIL_envelope_extent (int *n_instances, tag_t **instances)
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])
TC_API int	MAIL_initialize_envelope2 (tag_t envelope, const char *subject, const char *comments)
TC_API int	MAIL_list_envelope_cc_receivers (tag_t envelope, int *count, tag_t **ccReceivers)
TC_API int	MAIL_list_envelope_receivers (tag_t envelope, int *count, tag_t **receivers)
TC_API int	MAIL_list_envelope_to_receivers (tag_t envelope, int *count, tag_t **receivers)
TC_API int	MAIL_register_send_callback (MAIL_send_callback_t function_pointer, MAIL_callback_position_t position)
TC_API int	MAIL_send_envelope (tag_t envelope)

Detailed Description

This file contains the prototypes for the ITK functions for the Envelope class.

Envelope is a subclass of Folder. Therefore, all FL and WSOM functions work with objects of this class. FL_insert, FL_remove and FL_ask_references are the only way to add, remove, or ask the contents of the envelope. Additionally, all AOM functions work with envelopes.

The basic process involved with mail is to create an envelope, insert the objects that you desire to mail, add the users, group members, groups, or distribution lists that you wish to send the objects to, and then send the envelope.

Definition in file envelope.h.