Teamcenter Mail

Modules
	MAIL Errors

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

An alias list is a list of objects to which the system can send mail. Users, groups, group members, or other distribution lists can be added to an alias list. The alias list is same as the Address List shown in the Teamcenter user interface. You can use these objects in regular Teamcenter mail or as notification lists for authorizations.

The ImanAliasList class is a subclass of POM_application_object. All AOM functions work with alias lists.

Typedef Documentation

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)

Definition at line 54 of file envelope.h.

typedef enum MAIL_to_or_cc_e MAIL_to_or_cc_t

Enumeration Type Documentation

enum MAIL_callback_position_e

Enumerator
MAIL_replaced_callback
MAIL_before_callback
MAIL_after_callback

Definition at line 56 of file envelope.h.

enum MAIL_to_or_cc_e

Enumerator
MAIL_send_to
MAIL_send_cc

Definition at line 63 of file envelope.h.

Function Documentation

TC_API int MAIL_add_envelope_cc_receiver	(	tag_t	envelope,
		tag_t	ccReceiver
	)

Adds a new carbon copy recipient (ccReceiver) to an envelope. This can be a user, a groupmember, a group, or a distribution list.

Parameters

envelope	(I)
ccReceiver	(I)

TC_API int MAIL_add_envelope_receiver	(	tag_t	envelope,
		tag_t	receiver
	)

Adds a new recipient (receiver) to an envelope. This can be a user, a groupmember, a group, or a distribution list.

Parameters

envelope	(I)
receiver	(I)

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

Adds a new external recipient (receiver) to an envelope. This receiver should be a recognizable e-mail address or alias that is recognized in the current mail domain. It must also be specified whether this address is to be on the To list or CC list of the outgoing e-mail.

Note that the preference Mail_OSMail_activated must be set to TRUE for those recipients to receive the message.

Parameters

envelope	(I) The envelope tag
to_or_cc	(I) To or CC information. This must be either MAIL_send_to or MAIL_send_cc.
receiver	(I) Valid e-mail address ( e.g., joe@c.nosp@m.ompa.nosp@m.ny.co.nosp@m.m )

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
	)

Deprecated:

This function is deprecated and will be removed from Tc11. From Tc9.0 onwards, please use generic creation of BusinessObject(i.e createBusinessObject or TCTYPE_create_object ).

Creates a new envelope. The values for subject and comments may be read back with WSOM_ask_name and WSOM_ask_description respectively.

Parameters

subject	(I)
comments	(I)
envelope	(O)

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

Parameters

n_instances	(O)
instances	(OF) n_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]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use MAIL_initialize_envelope2

Initializes an envelope. You call this function immediately after creating an instance of a subclass of Envelope.

Parameters

envelope	(I)
subject	(I)
comments	(I)

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

Initializes an envelope. You call this function immediately after creating an instance of a subclass of Envelope.

Parameters

envelope	(I)
subject	(I)
comments	(I)

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

Lists all of the current carbon copy receivers for the given envelope.

Parameters

envelope	(I)
count	(O)
ccReceivers	(OF) count

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

Lists all of the current receivers for the given envelope.

Parameters

envelope	(I)
count	(O)
receivers	(OF) count

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

Lists all of the current primary receivers for the given envelope.

Parameters

envelope	(I)
count	(O)
receivers	(OF) count

TC_API int MAIL_register_send_callback	(	MAIL_send_callback_t	function_pointer,
		MAIL_callback_position_t	position
	)

Registers functions to execute in relation with sending OS Mail.

When the value of position is MAIL_replaced_callback, the given function will totally replace the Teamcenter OSMail code. When the value of position is MAIL_before_callback, the given function will be executed prior to the OS Mail function (it being either the Teamcenter function or the one given through a call to this function with position=MAIL_replaced_callback). When the value of position is MAIL_after_callback, the given function will be executed after the OS Mail function.

The registered functions and/or the Teamcenter mail function are executed only if the preference Mail_OSMail_activated is set to TRUE. Besides, they are executed once for each internal recipient.

Parameters

function_pointer	(I)
position	(I)

TC_API int MAIL_send_envelope

(

tag_t

envelope

)

Sends the envelope and its contents to all of the envelope's receivers. This function causes the envelope to be saved if not already saved. Once this ITK has been called, the envelope is deleted.

If the preference Mail_OSMail_activated is not set to true, only Teamcenter mail will be sent, and external recipients will not receive the mail.

Parameters

envelope

(I)