• Publicity: Public Only All

email-image-procs.tcl

Tcl API for email_image store and manipulation

Location:
packages/acs-subsite/tcl/email-image-procs.tcl
Author:
Miguel Marin <miguelmarin@viaro.net) Viaro Networks (www.viaro.net>

Procedures in this file

Detailed information

email_image::add_relation (public)

 email_image::add_relation -user_id user_id -item_id item_id

Add a new relation between user_id and item_id

Switches:
-user_id (required)
-item_id (required)
the item_id of the image in the content repository

Testcases:
No testcase defined.

email_image::create_type_folder_rel (public)

 email_image::create_type_folder_rel

Creates a new folder in the content repository with the name and label Email_Images. Also create a new type and register this type to the created folder. Makes a new relation type to associate the item_id (email_image in the content repository) with the user_id.

Testcases:
No testcase defined.

email_image::edit_email_image (public)

 email_image::edit_email_image -user_id user_id -new_email new_email \
    [ -bgcolor bgcolor ] [ -transparent transparent ]

Creates a new email_image of the user with his/her new edited email on it and store it in the content repository under the Email_Images folder. If the user has an image already stored it makes a new revision of the image, if not, it creates a new item with the new image.

Switches:
-user_id (required)
-new_email (required)
-bgcolor (optional)
The background color of the image in the format \#xxxxxx, default to \#ffffff
-transparent (optional)
If you want the background color transparent set it to 1. Default to 1

Testcases:
No testcase defined.

email_image::get_email (public)

 email_image::get_email -user_id user_id

Returns the email of the user

Switches:
-user_id (required)

Testcases:
No testcase defined.

email_image::get_folder_id (public)

 email_image::get_folder_id

Returns the folder_id of the folder with the name "Email_Images"

Testcases:
No testcase defined.

email_image::get_priv_email (public)

 email_image::get_priv_email -user_id user_id \
    [ -subsite_id subsite_id ]

Returns the priv_email field of the user from the users table.

Switches:
-user_id (required)
-subsite_id (optional)

Testcases:
No testcase defined.

email_image::get_related_item_id (public)

 email_image::get_related_item_id -user_id user_id

Returns the item_id of the email_image stored in the content repository for user_id.

Switches:
-user_id (required)

Testcases:
No testcase defined.

email_image::get_user_email (public)

 email_image::get_user_email -user_id user_id \
    [ -return_url return_url ] [ -bgcolor bgcolor ] \
    [ -transparent transparent ] [ -subsite_id subsite_id ]

Returns the email in different ways (text level 4, image or text and image level 3, link level 2, ...) according to the priv_email field in the users table. To create an image the ImageMagick software is required, if ImageMagick is not present then the @ symbol in the email will be shown as an image. When creating an image you can choose the background color (In this format \#xxxxxx). Also you can make the background color transparent (1 or 0).

Switches:
-user_id (required)
-return_url (optional)
The url to return when the email is shown as a link
-bgcolor (optional)
The Background color of the image. Default to \#ffffff
-transparent (optional)
If the bgcolor is transparent. Default to 1
-subsite_id (optional)

Testcases:
No testcase defined.

email_image::new_item (public)

 email_image::new_item -user_id user_id [ -return_url return_url ] \
    [ -bgcolor bgcolor ] [ -transparent transparent ]

Creates the email_image of the user with his/her email on it and store it in the content repository under the Email_Images folder.

Switches:
-user_id (required)
-return_url (optional)
-bgcolor (optional)
The background color of the image in the format \#xxxxxx, default to \#ffffff
-transparent (optional)
If you want the background color transparent set it to 1. Default to 1

Testcases:
No testcase defined.

email_image::update_private_p (public)

 email_image::update_private_p -user_id user_id -level level

Changes the priv_email field from the users table

Switches:
-user_id (required)
-level (required)
Change to this level

Testcases:
No testcase defined.
[ show source ]