Message Functions

Last updated March 2020

Name	Description
add	Add disclaimer to a message
ec_async_fail	Fails a message and removes it from the system
ec_message_addref	Create a reference to an existing message
ec_message_assemble_to_legacy_email_message	glue the parts back together into an in-memory email_message
ec_message_assign_domain	Modify the domain record of an ec_message
ec_message_assign_domain_by_name	Assign the domain field of an ec_message based on the domain name string passed in as an argument
ec_message_body_in_core	Checks (or arranges) for the message body to be paged in-core
ec_message_builder	Convenience routine for building messages in a blocking fashion
ec_message_change_binding_slot	Set the binding for a message
ec_message_context_clean	Cleans the appropriate per-message dictionary
ec_message_context_delete	Delete a key/value pair from the message context or connection context dictionary
ec_message_context_copy	Copy a context variable from one ec_message to another
ec_message_context_discard	Discards the context dictionaries. They will be re-fetched on demand
ec_message_context_exists	Determines whether a provided key exists in the connection context or message context dictionary
ec_message_context_exists_and_get	Determines whether a dictionary key exists and, if so, supplies a reference to the value
ec_message_context_firstkey	Returns a pointer to the first key in the appropriate per-message dictionary, NULL if the dictionary is empty
ec_message_context_get	Returns a pointer to the value of the key in the appropriate dictionary, otherwise it returns an empty string
ec_message_context_nextkey	Returns a pointer to the 'next' key in the appropriate per-message dictionary, NULL if there are no more keys
ec_message_context_set	Store a key/value pair in the appropriate context dictionary
ec_message_context_size	Returns the size of the appropriate per-message dictionary
ec_message_copy	Create a copy of an existing message
ec_message_cowref	Create a copy-on-write reference to an existing message
ec_message_enqueue	Enqueue a message
ec_message_extract_part_to_string	Extract a message part to a string, decoding transfer encoding
ec_message_extract_part_to_string2	Extract a message part to a string, decoding transfer encoding
ec_message_free	Release resources held by this message
ec_message_get_body_fd_for_mmap	Requests the file descriptor from the IO layer for the purpose of memory mapping
ec_message_get_body_io_object	Requests an io_object from the IO layer
ec_message_get_code	Fetches the code set for the message
ec_message_get_delivery_method	Retrieve the delivery method of a message
ec_message_get_envelope	Returns information from the envelope of the message
ec_message_get_envelope2	Return information from the envelope of the message
ec_message_get_first_part	Returns the top level mime part of the message
ec_message_get_headers	Returns an rfc2822_context struct which stores the headers for the message part
ec_message_get_mailfrom	Returns the entire protocol-decorated mailfrom string
ec_message_get_message_memory	Returns a pointer to the message memory
ec_message_get_message_size	Returns the message size, in bytes
ec_message_get_pathway	Get the pathway of a message
ec_message_get_rcptto	returns the entire protocol-decorated rcptto string
ec_message_get_routing_domain	Get the routing domain of the message
ec_message_get_routing_domain2	Get the routing domain of the message
ec_message_is_large	Indicates if a message is large
ec_message_is_mcmt	returns 1 if the message is a MCMT container
ec_message_lock	Perform a mutex lock operation
ec_message_mcmt_fixup	This function is to be called by a listener when an injected message is a MCMT container (i.e
ec_message_new	Create a new message
ec_message_parser_defaults	Obtain message parsing/validation defaults
ec_message_parser_defaults2	Obtain message parsing/validation defaults
ec_message_parser_strerror	Returns a string representation of a message parsing error code
ec_message_part_add_child_first	Add part as the first child of another part
ec_message_part_add_child_last	Add part as the last child of another part
ec_message_part_copy_to_io_object	Render/Copy a message part to an io_object
ec_message_part_create_multipart	Create a new multipart container part
ec_message_part_create_singleton	Create a new singleton message part
ec_message_part_extract	Prepare to extract a message part in a streaming fashion
ec_message_part_extract2	Prepare to extract a message part in a streaming fashion
ec_message_part_get_content_type	Returns the content type and charset for a given part
ec_message_part_get_content_type2	Returns the content type and charset for a given part using strings
ec_message_part_get_content_type3	Returns the content type and charset for a given part
ec_message_part_insert_after	Insert a part after another part
ec_message_part_insert_before	Insert a part ahead of another part
ec_message_part_touch	Flags a message part as having been modified
ec_message_part_unlink	Unlink part from the mime tree
ec_message_refetch_meta	refetch extended meta information from the spool
ec_message_register_parser	Replaces the core message parser
ec_message_release_body_io_object	Releases the body io_object
ec_message_render_headers_to_string	Renders the headers of the first part of a message to a string
ec_message_render_meta_to_string	Renders meta information about the message to a string
ec_message_render_part_headers_to_string	Render the headers of a message part to a string
ec_message_render_part_to_string	Render a message part to a string
ec_message_render_to_string	Renders a message, swapping it in if needed
ec_message_rsrc_copy	Duplicate resource identifiers from source into destination
ec_message_rsrc_create	This creates an empty container for a resource identified with name
ec_message_rsrc_destroy	Removes the resource with the given name from the message in-memory resource list and then passes the resource to ec_message_rsrc_free
ec_message_rsrc_flush	Explicitly flush the resource name to its relevant backing store
ec_message_rsrc_free	Allows the underlying operating system to reclaim memory and objects associated with the given resource
ec_message_rsrc_get	This will return the I/O object associated with the resource name as well as the state
ec_message_rsrc_remove	This will set the resource name in message to state EC_MESSAGE_RSRC_DELETED
ec_message_rsrc_set	This function associates I/O object source with the resource name for message
ec_message_rsrc_state	This will return a state hint of a given resource
ec_message_rsrc_string	Returns a string representation of the resources associated with the message
ec_message_select_binding_by_group	Select a binding from a binding group
ec_message_separate	Separate references to an existing message
ec_message_set__object	set the _object for a message, maintaining appropriate accounting
ec_message_set_code	Set the message delivery code meta information
ec_message_set_envelope	Sets envelope information for the message
ec_message_set_first_part	Accessor function for changing the top level mime part for a message
ec_message_set_mailfrom	sets the entire protocol decorated mailfrom string
ec_message_set_next_attempt	Determines and sets the next attempt time for the message
ec_message_set_parser_defaults	Set message parsing/validation defaults
ec_message_set_rcptto	sets the entire protocol decorated rcptto string
ec_message_should_reduce_resources	Determines whether or not a message should be removed from memory
ec_message_snapshot	Create a snapshot of an existing message
ec_message_swap_in	causes the message content to be read in from disk
ec_message_swap_out	cause a message to be written to disk
ec_message_swap_out_meta	Write message meta data to disk
ec_message_unlink_on_free	Marks the message as to be removed from disk when the last reference is dropped
ec_message_unlock	Perform a message unlock operation
ec_retry_state_delref	Removes a reference from a retry state, and destroys it if no more exist
ec_retry_state_get	Retrieves or allocates a retry state associated with the given binding and domain
ec_retry_state_next	Return next offset associated with a retry state distribution, bounded to ceiling
ec_retry_state_reset	Resets a retry state
ob_get_current_message	Utility function to return the current ec_message

The ec_message data structure is documented at “ec_message”.

Was this page helpful?