FormMail Class Reference

Classe permettant la generation du formulaire html d'envoi de mail unitaire Usage: $formail = new FormMail($db) $formmail->proprietes=1 ou chaine ou tableau de valeurs $formmail->show_form() affiche le formulaire. More...

Inheritance diagram for FormMail:

Collaboration diagram for FormMail:

Public Member Functions
	__construct ($db)
	Constructor.
	clear_attached_files ()
	Clear list of attached files in send mail form (also stored in session)
	add_attached_files ($path, $file='', $type='')
	Add a file into the list of attached files (stored in SECTION array)
	remove_attached_files ($keytodelete)
	Remove a file from the list of attached files (stored in SECTION array)
	get_attached_files ()
	Return list of attached files (stored in SECTION array)
	show_form ($addfileaction='addfile', $removefileaction='removefile')
	Show the form to input an email this->withfile: 0=No attaches files, 1=Show attached files, 2=Can add new attached files this->withmaindocfile.
	get_form ($addfileaction='addfile', $removefileaction='removefile')
	Get the form to input an email this->withfile: 0=No attaches files, 1=Show attached files, 2=Can add new attached files this->param: Contains more parameters like email templates info this->withfckeditor: 1=We use an advanced editor, so we switch content into HTML.
	getHtmlForTo ()
	get html For To
	getHtmlForCc ()
	get html For CC
	getHtmlForWithCcc ()
	get html For WithCCC
	getHtmlForWithErrorsTo ()
	get Html For WithErrorsTo
	getHtmlForDeliveryreceipt ()
	get Html For Asking for Delivery Receipt
	getHtmlForTopic ($arraydefaultmessage, $helpforsubstitution)
	get Html For Topic of message
	getEMailTemplate ($dbs, $type_template, $user, $outputlangs, $id=0, $active=1, $label='', $defaultfortype=-1)
	Return templates of email with type = $type_template or type = 'all'.
	isEMailTemplate ($type_template, $user, $outputlangs)
	Find if template exists Search into table c_email_templates.
	fetchAllEMailTemplate ($type_template, $user, $outputlangs, $active=1)
	Find if template exists and are available for current user, then set them into $this->lines_module.
	setSubstitFromObject ($object, $outputlangs)
	Set ->substit (and ->substit_line) array from object.
Public Member Functions inherited from Form
	editfieldkey ($text, $htmlname, $preselected, $object, $perm, $typeofdata='string', $moreparam='', $fieldrequired=0, $notabletag=0, $paramid='id', $help='')
	Output key field for an editable field.
	editfieldval ($text, $htmlname, $value, $object, $perm, $typeofdata='string', $editvalue='', $extObject=null, $custommsg=null, $moreparam='', $notabletag=1, $formatfunc='', $paramid='id', $gm='auto', $moreoptions=array(), $editaction='')
	Output value of a field for an editable field.
	widgetForTranslation ($fieldname, $object, $perm, $typeofdata='string', $check='', $morecss='')
	Output edit in place form.
	textwithtooltip ($text, $htmltext, $tooltipon=1, $direction=0, $img='', $extracss='', $notabs=3, $incbefore='', $noencodehtmltext=0, $tooltiptrigger='', $forcenowrap=0)
	Show a text and picto with tooltip on text or picto.
	textwithpicto ($text, $htmltext, $direction=1, $type='help', $extracss='', $noencodehtmltext=0, $notabs=3, $tooltiptrigger='', $forcenowrap=0)
	Show a text with a picto and a tooltip on picto.
	selectMassAction ($selected, $arrayofaction, $alwaysvisible=0, $name='massaction', $cssclass='checkforselect')
	Generate select HTML to choose massaction.
	select_country ($selected='', $htmlname='country_id', $htmloption='', $maxlength=0, $morecss='minwidth300', $usecodeaskey='', $showempty=1, $disablefavorites=0, $addspecialentries=0, $exclude_country_code=array(), $hideflags=0)
	Return combo list of activated countries, into language of user.
	select_incoterms ($selected='', $location_incoterms='', $page='', $htmlname='incoterm_id', $htmloption='', $forcecombo=1, $events=array(), $disableautocomplete=0)
	Return select list of incoterms.
	select_type_of_lines ($selected='', $htmlname='type', $showempty=0, $hidetext=0, $forceall=0)
	Return list of types of lines (product or service) Example: 0=product, 1=service, 9=other (for external module)
	load_cache_types_fees ()
	Load into cache cache_types_fees, array of types of fees.
	select_type_fees ($selected='', $htmlname='type', $showempty=0)
	Return list of types of notes.
	select_company ($selected='', $htmlname='socid', $filter='', $showempty='', $showtype=0, $forcecombo=0, $events=array(), $limit=0, $morecss='minwidth100', $moreparam='', $selected_input_value='', $hidelabel=1, $ajaxoptions=array(), $multiple=false, $excludeids=array(), $showcode=0)
	Output html form to select a third party.
	select_thirdparty_list ($selected='', $htmlname='socid', $filter='', $showempty='', $showtype=0, $forcecombo=0, $events=array(), $filterkey='', $outputmode=0, $limit=0, $morecss='minwidth100', $moreparam='', $multiple=false, $excludeids=array(), $showcode=0)
	Output html form to select a third party.
	select_remises ($selected, $htmlname, $filter, $socid, $maxvalue=0)
	Return HTML combo list of absolute discounts.
	select_contacts ($socid, $selected='', $htmlname='contactid', $showempty=0, $exclude='', $limitto='', $showfunction=0, $morecss='', $showsoc=0, $forcecombo=0, $events=array(), $options_only=false, $moreparam='', $htmlid='')
	Return list of all contacts (for a third party or all)
	selectcontacts ($socid, $selected='', $htmlname='contactid', $showempty=0, $exclude='', $limitto='', $showfunction=0, $morecss='', $options_only=false, $showsoc=0, $forcecombo=0, $events=array(), $moreparam='', $htmlid='', $multiple=false, $disableifempty=0)
	Return HTML code of the SELECT of list of all contacts (for a third party or all).
	select_users ($selected='', $htmlname='userid', $show_empty=0, $exclude=null, $disabled=0, $include='', $enableonly='', $force_entity='0')
	Return the HTML select list of users.
	select_dolusers ($selected='', $htmlname='userid', $show_empty=0, $exclude=null, $disabled=0, $include='', $enableonly='', $force_entity='0', $maxlength=0, $showstatus=0, $morefilter='', $show_every=0, $enableonlytext='', $morecss='', $notdisabled=0, $outputmode=0, $multiple=false, $forcecombo=0)
	Return select list of users.
	select_dolusers_forevent ($action='', $htmlname='userid', $show_empty=0, $exclude=null, $disabled=0, $include='', $enableonly='', $force_entity='0', $maxlength=0, $showstatus=0, $morefilter='', $showproperties=0, $listofuserid=array(), $listofcontactid=array(), $listofotherid=array())
	Return select list of users.
	select_produits ($selected='', $htmlname='productid', $filtertype='', $limit=0, $price_level=0, $status=1, $finished=2, $selected_input_value='', $hidelabel=0, $ajaxoptions=array(), $socid=0, $showempty='1', $forcecombo=0, $morecss='', $hidepriceinlabel=0, $warehouseStatus='', $selected_combinations=null, $nooutput=0, $status_purchase=-1)
	Return list of products for customer in Ajax if Ajax activated or go to select_produits_list.
	select_bom ($selected='', $htmlname='bom_id', $limit=0, $status=1, $type=0, $showempty='1', $morecss='', $nooutput='', $forcecombo=0, $TProducts=[])
	Return list of BOM for customer in Ajax if Ajax activated or go to select_produits_list.
	select_produits_list ($selected='', $htmlname='productid', $filtertype='', $limit=20, $price_level=0, $filterkey='', $status=1, $finished=2, $outputmode=0, $socid=0, $showempty='1', $forcecombo=0, $morecss='', $hidepriceinlabel=0, $warehouseStatus='', $status_purchase=-1)
	Return list of products for a customer.
	select_produits_fournisseurs ($socid, $selected='', $htmlname='productid', $filtertype='', $filtre='', $ajaxoptions=array(), $hidelabel=0, $alsoproductwithnosupplierprice=0, $morecss='', $placeholder='')
	Return list of products for customer (in Ajax if Ajax activated or go to select_produits_fournisseurs_list)
	select_produits_fournisseurs_list ($socid, $selected='', $htmlname='productid', $filtertype='', $filtre='', $filterkey='', $statut=-1, $outputmode=0, $limit=100, $alsoproductwithnosupplierprice=0, $morecss='', $showstockinlist=0, $placeholder='')
	Return list of suppliers products.
	select_product_fourn_price ($productid, $htmlname='productfournpriceid', $selected_supplier='')
	Return list of suppliers prices for a product.
	select_address ($selected, $socid, $htmlname='address_id', $showempty=0)
	Return list of delivery address.
	load_cache_conditions_paiements ()
	load_cache_availability ()
	selectAvailabilityDelay ($selected='', $htmlname='availid', $filtertype='', $addempty=0, $morecss='')
	loadCacheInputReason ()
	selectInputReason ($selected='', $htmlname='demandreasonid', $exclude='', $addempty=0, $morecss='', $notooltip=0)
	Return list of input reason (events that triggered an object creation, like after sending an emailing, making an advert, ...) List found into table c_input_reason loaded by loadCacheInputReason.
	load_cache_types_paiements ()
	select_conditions_paiements ($selected=0, $htmlname='condid', $filtertype=-1, $addempty=0, $noinfoadmin=0, $morecss='', $deposit_percent=-1)
	print list of payment modes.
	getSelectConditionsPaiements ($selected=0, $htmlname='condid', $filtertype=-1, $addempty=0, $noinfoadmin=0, $morecss='', $deposit_percent=-1)
	Return list of payment modes.
	select_types_paiements ($selected='', $htmlname='paiementtype', $filtertype='', $format=0, $empty=1, $noadmininfo=0, $maxlength=0, $active=1, $morecss='', $nooutput=0)
	Return list of payment methods Constant MAIN_DEFAULT_PAYMENT_TYPE_ID can used to set default value but scope is all application, probably not what you want.
	selectPriceBaseType ($selected='', $htmlname='price_base_type', $addjscombo=0)
	Selection HT or TTC.
	load_cache_transport_mode ()
	selectTransportMode ($selected='', $htmlname='transportmode', $format=0, $empty=1, $noadmininfo=0, $maxlength=0, $active=1, $morecss='')
	selectShippingMethod ($selected='', $htmlname='shipping_method_id', $filtre='', $useempty=0, $moreattrib='', $noinfoadmin=0, $morecss='')
	Return a HTML select list of shipping mode.
	formSelectShippingMethod ($page, $selected='', $htmlname='shipping_method_id', $addempty=0)
	Display form to select shipping mode.
	selectSituationInvoices ($selected='', $socid=0)
	Creates HTML last in cycle situation invoices selector.
	selectUnits ($selected='', $htmlname='units', $showempty=0, $unit_type='')
	select_comptes ($selected='', $htmlname='accountid', $status=0, $filtre='', $useempty=0, $moreattrib='', $showcurrency=0, $morecss='', $nooutput=0)
	Return a HTML select list of bank accounts.
	selectEstablishments ($selected='', $htmlname='entity', $status=0, $filtre='', $useempty=0, $moreattrib='')
	Return a HTML select list of establishment.
	formSelectAccount ($page, $selected='', $htmlname='fk_account', $addempty=0)
	Display form to select bank account.
	select_all_categories ($type, $selected='', $htmlname="parent", $maxlength=64, $markafterid=0, $outputmode=0, $include=0, $morecss='')
	Return list of categories having choosed type.
	form_confirm ($page, $title, $question, $action, $formquestion='', $selectedchoice="", $useajax=0, $height=170, $width=500)
	formconfirm ($page, $title, $question, $action, $formquestion='', $selectedchoice='', $useajax=0, $height=0, $width=500, $disableformtag=0, $labelbuttonyes='Yes', $labelbuttonno='No')
	form_project ($page, $socid, $selected='', $htmlname='projectid', $discard_closed=0, $maxlength=20, $forcefocus=0, $nooutput=0, $textifnoproject='', $morecss='')
	Show a form to select a project.
	form_conditions_reglement ($page, $selected='', $htmlname='cond_reglement_id', $addempty=0, $type='', $filtertype=-1, $deposit_percent=-1, $nooutput=0)
	Show a form to select payment conditions.
	form_availability ($page, $selected='', $htmlname='availability', $addempty=0)
	Show a form to select a delivery delay.
	formInputReason ($page, $selected='', $htmlname='demandreason', $addempty=0)
	Output HTML form to select list of input reason (events that triggered an object creation, like after sending an emailing, making an advert, ...) List found into table c_input_reason loaded by loadCacheInputReason.
	form_date ($page, $selected, $htmlname, $displayhour=0, $displaymin=0, $nooutput=0, $type='')
	Show a form + html select a date.
	form_users ($page, $selected='', $htmlname='userid', $exclude='', $include='')
	Show a select form to choose a user.
	form_modes_reglement ($page, $selected='', $htmlname='mode_reglement_id', $filtertype='', $active=1, $addempty=0, $type='', $nooutput=0)
	Show form with payment mode.
	formSelectTransportMode ($page, $selected='', $htmlname='transport_mode_id', $active=1, $addempty=0)
	Show form with transport mode.
	form_multicurrency_code ($page, $selected='', $htmlname='multicurrency_code')
	Show form with multicurrency code.
	form_multicurrency_rate ($page, $rate='', $htmlname='multicurrency_tx', $currency='')
	Show form with multicurrency rate.
	form_remise_dispo ($page, $selected, $htmlname, $socid, $amount, $filter='', $maxvalue=0, $more='', $hidelist=0, $discount_type=0)
	Show a select box with available absolute discounts.
	form_contacts ($page, $societe, $selected='', $htmlname='contactid')
	Show forms to select a contact.
	form_thirdparty ($page, $selected='', $htmlname='socid', $filter='', $showempty=0, $showtype=0, $forcecombo=0, $events=array(), $nooutput=0, $excludeids=array(), $textifnothirdparty='')
	Output html select to select thirdparty.
	select_currency ($selected='', $htmlname='currency_id')
	Retourne la liste des devises, dans la langue de l'utilisateur.
	selectCurrency ($selected='', $htmlname='currency_id', $mode=0, $useempty='')
	Retourne la liste des devises, dans la langue de l'utilisateur.
	selectMultiCurrency ($selected='', $htmlname='multicurrency_code', $useempty=0, $filter='', $excludeConfCurrency=false, $morecss='')
	Return array of currencies in user language.
	load_cache_vatrates ($country_code)
	Load into the cache vat rates of a country.
	load_tva ($htmlname='tauxtva', $selectedrate='', $societe_vendeuse='', $societe_acheteuse='', $idprod=0, $info_bits=0, $type='', $options_only=false, $mode=0)
	Output an HTML select vat rate.
	select_date ($set_time='', $prefix='re', $h=0, $m=0, $empty=0, $form_name="", $d=1, $addnowlink=0, $nooutput=0, $disabled=0, $fullday='', $addplusone='', $adddateof='')
	Show a HTML widget to input a date or combo list for day, month, years and optionaly hours and minutes.
	selectDateToDate ($set_time='', $set_time_end='', $prefix='re', $empty=0, $forcenewline=0)
	Show 2 HTML widget to input a date or combo list for day, month, years and optionaly hours and minutes.
	selectDate ($set_time='', $prefix='re', $h=0, $m=0, $empty=0, $form_name="", $d=1, $addnowlink=0, $disabled=0, $fullday='', $addplusone='', $adddateof='', $openinghours='', $stepminutes=1, $labeladddateof='', $placeholder='', $gm='auto')
	Show a HTML widget to input a date or combo list for day, month, years and optionaly hours and minutes.
	selectTypeDuration ($prefix, $selected='i', $excludetypes=array())
	selectTypeDuration
	select_duration ($prefix, $iSecond='', $disabled=0, $typehour='select', $minunderhours=0, $nooutput=0)
	Function to show a form to select a duration on a page.
	selectTickets ($selected='', $htmlname='ticketid', $filtertype='', $limit=0, $status=1, $selected_input_value='', $hidelabel=0, $ajaxoptions=array(), $socid=0, $showempty='1', $forcecombo=0, $morecss='', $selected_combinations=null, $nooutput=0)
	Return list of tickets in Ajax if Ajax activated or go to selectTicketsList.
	selectTicketsList ($selected='', $htmlname='ticketid', $filtertype='', $limit=20, $filterkey='', $status=1, $outputmode=0, $showempty='1', $forcecombo=0, $morecss='')
	Return list of tickets.
	selectProjects ($selected='', $htmlname='projectid', $filtertype='', $limit=0, $status=1, $selected_input_value='', $hidelabel=0, $ajaxoptions=array(), $socid=0, $showempty='1', $forcecombo=0, $morecss='', $selected_combinations=null, $nooutput=0)
	Return list of projects in Ajax if Ajax activated or go to selectTicketsList.
	selectProjectsList ($selected='', $htmlname='projectid', $filtertype='', $limit=20, $filterkey='', $status=1, $outputmode=0, $showempty='1', $forcecombo=0, $morecss='')
	Return list of projects.
	selectMembers ($selected='', $htmlname='adherentid', $filtertype='', $limit=0, $status=1, $selected_input_value='', $hidelabel=0, $ajaxoptions=array(), $socid=0, $showempty='1', $forcecombo=0, $morecss='', $selected_combinations=null, $nooutput=0)
	Return list of members in Ajax if Ajax activated or go to selectTicketsList.
	selectMembersList ($selected='', $htmlname='adherentid', $filtertype='', $limit=20, $filterkey='', $status=1, $outputmode=0, $showempty='1', $forcecombo=0, $morecss='')
	Return list of adherents.
	selectForForms ($objectdesc, $htmlname, $preselectedvalue, $showempty='', $searchkey='', $placeholder='', $morecss='', $moreparams='', $forcecombo=0, $disabled=0, $selected_input_value='')
	Generic method to select a component from a combo list.
	selectForFormsList ($objecttmp, $htmlname, $preselectedvalue, $showempty='', $searchkey='', $placeholder='', $morecss='', $moreparams='', $forcecombo=0, $outputmode=0, $disabled=0, $sortfield='', $filter='')
	Output html form to select an object.
	showCategories ($id, $type, $rendermode=0, $nolink=0)
	Render list of categories linked to object with id $id and type $type.
	showLinkedObjectBlock ($object, $morehtmlright='', $compatibleImportElementsList=false, $title='RelatedObjects')
	Show linked object block.
	showLinkToObjectBlock ($object, $restrictlinksto=array(), $excludelinksto=array())
	Show block with links to link to other objects.
	selectyesno ($htmlname, $value='', $option=0, $disabled=false, $useempty=0, $addjscombo=0, $morecss='', $labelyes='Yes', $labelno='No')
	Return an html string with a select combo box to choose yes or no.
	select_export_model ($selected='', $htmlname='exportmodelid', $type='', $useempty=0)
	Return list of export templates.
	showrefnav ($object, $paramid, $morehtml='', $shownav=1, $fieldid='rowid', $fieldref='ref', $morehtmlref='', $moreparam='', $nodbprefix=0, $morehtmlleft='', $morehtmlstatus='', $morehtmlright='')
	Return a HTML area with the reference of object and a navigation bar for a business object Note: To complete search with a particular filter on select, you can set $object->next_prev_filter set to define SQL criterias.
	showbarcode (&$object, $width=100, $morecss='')
	Return HTML code to output a barcode.
	select_dolgroups ($selected='', $htmlname='groupid', $show_empty=0, $exclude='', $disabled=0, $include='', $enableonly='', $force_entity='0', $multiple=false, $morecss='')
	Return select list of groups.
	showFilterButtons ($pos='')
	Return HTML to show the search and clear seach button.
	showCheckAddButtons ($cssclass='checkforaction', $calljsfunction=0, $massactionname="massaction")
	Return HTML to show the search and clear search button.
	showFilterAndCheckAddButtons ($addcheckuncheckall=0, $cssclass='checkforaction', $calljsfunction=0, $massactionname="massaction")
	Return HTML to show the search and clear seach button.
	selectExpenseCategories ($selected='', $htmlname='fk_c_exp_tax_cat', $useempty=0, $excludeid=array(), $target='', $default_selected=0, $params=array(), $info_admin=1)
	Return HTML to show the select of expense categories.
	selectExpenseRanges ($selected='', $htmlname='fk_range', $useempty=0)
	Return HTML to show the select ranges of expense range.
	selectExpense ($selected='', $htmlname='fk_c_type_fees', $useempty=0, $allchoice=1, $useid=0)
	Return HTML to show a select of expense.
	selectInvoice ($socid=-1, $selected='', $htmlname='invoiceid', $maxlength=24, $option_only=0, $show_empty='1', $discard_closed=0, $forcefocus=0, $disabled=0, $morecss='maxwidth500', $projectsListId='', $showproject='all', $usertofilter=null)
	Output a combo list with invoices qualified for a third party.
	selectInvoiceRec ($selected='', $htmlname='facrecid', $maxlength=24, $option_only=0, $show_empty='1', $forcefocus=0, $disabled=0, $morecss='maxwidth500')
	Output a combo list with invoices qualified for a third party.
	searchComponent ($arrayofcriterias, $search_component_params, $arrayofinputfieldsalreadyoutput=array(), $search_component_params_hidden='')
	Output the component to make advanced search criteries.
	selectModelMail ($prefix, $modelType='', $default=0, $addjscombo=0)
	selectModelMail
	buttonsSaveCancel ($save_label='Save', $cancel_label='Cancel', $morebuttons=array(), $withoutdiv=0, $morecss='', $dol_openinpopup='')
	Output the buttons to submit a creation/edit form.

Static Public Member Functions
static	getAvailableSubstitKey ($mode='formemail', $object=null)
	Get list of substitution keys available for emails.
Static Public Member Functions inherited from Form
static	selectarray ($htmlname, $array, $id='', $show_empty=0, $key_in_label=0, $value_as_key=0, $moreparam='', $translate=0, $maxlen=0, $disabled=0, $sort='', $morecss='minwidth75', $addjscombo=1, $moreparamonempty='', $disablebademail=0, $nohtmlescape=0)
	Return a HTML select string, built from an array of key+value.
static	selectArrayAjax ($htmlname, $url, $id='', $moreparam='', $moreparamtourl='', $disabled=0, $minimumInputLength=1, $morecss='', $callurlonselect=0, $placeholder='', $acceptdelayedhtml=0)
	Return a HTML select string, built from an array of key+value, but content returned into select come from an Ajax call of an URL.
static	selectArrayFilter ($htmlname, $array, $id='', $moreparam='', $disableFiltering=0, $disabled=0, $minimumInputLength=1, $morecss='', $callurlonselect=0, $placeholder='', $acceptdelayedhtml=0, $textfortitle='')
	Return a HTML select string, built from an array of key+value, but content returned into select is defined into $array parameter.
static	multiselectarray ($htmlname, $array, $selected=array(), $key_in_label=0, $value_as_key=0, $morecss='', $translate=0, $width=0, $moreattrib='', $elemtype='', $placeholder='', $addjscombo=-1)
	Show a multiselect form from an array.
static	multiSelectArrayWithCheckbox ($htmlname, &$array, $varpage, $pos='')
	Show a multiselect dropbox from an array.
static	showphoto ($modulepart, $object, $width=100, $height=0, $caneditfield=0, $cssclass='photowithmargin', $imagesize='', $addlinktofullsize=1, $cache=0, $forcecapture='', $noexternsourceoverwrite=0)

Additional Inherited Members
Protected Member Functions inherited from Form
	editInPlace ($object, $value, $htmlname, $condition, $inputType='textarea', $editvalue=null, $extObject=null, $custommsg=null)
	Output edit in place form.
	constructProductListOption (&$objp, &$opt, &$optJson, $price_level, $selected, $hidepriceinlabel=0, $filterkey='', $novirtualstock=0)
	Function to forge the string with OPTIONs of SELECT.
	constructTicketListOption (&$objp, &$opt, &$optJson, $selected, $filterkey='')
	constructTicketListOption.
	constructProjectListOption (&$objp, &$opt, &$optJson, $selected, $filterkey='')
	constructProjectListOption.
	constructMemberListOption (&$objp, &$opt, &$optJson, $selected, $filterkey='')
	constructMemberListOption.

Detailed Description

Classe permettant la generation du formulaire html d'envoi de mail unitaire Usage: $formail = new FormMail($db) $formmail->proprietes=1 ou chaine ou tableau de valeurs $formmail->show_form() affiche le formulaire.

Definition at line 40 of file html.formmail.class.php.

Constructor & Destructor Documentation

__construct()

FormMail::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from Form.

Definition at line 178 of file html.formmail.class.php.

Member Function Documentation

add_attached_files()

FormMail::add_attached_files	(		$path,
			$file = '',
			$type = '' )

Add a file into the list of attached files (stored in SECTION array)

Parameters

string	$path	Full absolute path on filesystem of file, including file name
string	$file	Only filename (can be basename($path))
string	$type	Mime type (can be dol_mimetype($file))

Returns

void

Definition at line 242 of file html.formmail.class.php.

References dol_mimetype().

Referenced by get_form().

clear_attached_files()

FormMail::clear_attached_files

(

)

Clear list of attached files in send mail form (also stored in session)

Returns

void

Definition at line 214 of file html.formmail.class.php.

References dol_delete_dir_recursive().

Referenced by get_form().

fetchAllEMailTemplate()

FormMail::fetchAllEMailTemplate	(		$type_template,
			$user,
			$outputlangs,
			$active = 1 )

Find if template exists and are available for current user, then set them into $this->lines_module.

Search into table c_email_templates

Parameters

string	$type_template	Get message for key module
User	$user	Use template public or limited to this user
Translate	$outputlangs	Output lang object
int	$active	1=Only active template, 0=Only disabled, -1=All

Returns

int <0 if KO, nb of records found if OK

Definition at line 1489 of file html.formmail.class.php.

Referenced by get_form().

get_attached_files()

FormMail::get_attached_files

(

)

Return list of attached files (stored in SECTION array)

Returns

array array('paths'=> ,'names'=>, 'mimes'=> )

Definition at line 317 of file html.formmail.class.php.

get_form()

FormMail::get_form	(		$addfileaction = 'addfile',
			$removefileaction = 'removefile' )

Get the form to input an email this->withfile: 0=No attaches files, 1=Show attached files, 2=Can add new attached files this->param: Contains more parameters like email templates info this->withfckeditor: 1=We use an advanced editor, so we switch content into HTML.

Parameters

string	$addfileaction	Name of action when posting file attachments
string	$removefileaction	Name of action when removing file attachments

Returns

string Form to show

Definition at line 365 of file html.formmail.class.php.

References add_attached_files(), button, clear_attached_files(), dol_escape_htmltag(), dol_htmlentities(), dol_mimetype(), dol_nl2br(), dol_print_error(), dol_string_nohtmltag(), dol_textishtml(), dolGetFirstLineOfText(), fetchAllEMailTemplate(), getDolGlobalInt(), getDolGlobalString(), getEMailTemplate(), getHtmlForCc(), getHtmlForTo(), getHtmlForTopic(), getHtmlForWithCcc(), getHtmlForWithErrorsTo(), getMaxFileSizeArray(), GETPOST(), img_mime(), info_admin(), make_substitutions(), Form\selectarray(), and setEventMessages().

Referenced by show_form().

getAvailableSubstitKey()

static FormMail::getAvailableSubstitKey ( $mode = 'formemail', $object = null )

static

Get list of substitution keys available for emails.

This is used for tooltips help. This include the complete_substitutions_array.

Parameters

string	$mode	'formemail', 'formemailwithlines', 'formemailforlines', 'emailing', ...
Object	$object	Object if applicable

Returns

array Array of substitution values for emails.

Definition at line 1606 of file html.formmail.class.php.

getEMailTemplate()

FormMail::getEMailTemplate	(		$dbs,
			$type_template,
			$user,
			$outputlangs,
			$id = 0,
			$active = 1,
			$label = '',
			$defaultfortype = -1 )

Return templates of email with type = $type_template or type = 'all'.

This search into table c_email_templates. Used by the get_form function.

Parameters

DoliDB	$dbs	Database handler
string	$type_template	Get message for model/type=$type_template, type='all' also included.
User	$user	Get templates public + limited to this user
Translate	$outputlangs	Output lang object
int	$id	Id of template to get, or -1 for first found with position 0, or 0 for first found whatever is position (priority order depends on lang provided or not) or -2 for exact match with label (no answer if not found)
int	$active	1=Only active template, 0=Only disabled, -1=All
string	$label	Label of template to get
int	$defaultfortype	1=Only default templates, 0=Only not default, -1=All

Returns

ModelMail|integer One instance of ModelMail or < 0 if error

Definition at line 1313 of file html.formmail.class.php.

Referenced by get_form().

getHtmlForCc()

FormMail::getHtmlForCc

(

)

get html For CC

Returns

string html

Definition at line 1117 of file html.formmail.class.php.

Referenced by get_form().

getHtmlForDeliveryreceipt()

FormMail::getHtmlForDeliveryreceipt

(

)

get Html For Asking for Delivery Receipt

Returns

string html

Definition at line 1227 of file html.formmail.class.php.

getHtmlForTo()

FormMail::getHtmlForTo

(

)

get html For To

Returns

string html

Definition at line 1048 of file html.formmail.class.php.

Referenced by get_form().

getHtmlForTopic()

FormMail::getHtmlForTopic	(		$arraydefaultmessage,
			$helpforsubstitution )

get Html For Topic of message

Parameters

array	$arraydefaultmessage	Array with message template content
string	$helpforsubstitution	Help string for substitution

Returns

string Text for topic

Definition at line 1265 of file html.formmail.class.php.

Referenced by get_form().

getHtmlForWithCcc()

FormMail::getHtmlForWithCcc

(

)

get html For WithCCC

Returns

string html

Definition at line 1148 of file html.formmail.class.php.

Referenced by get_form().

getHtmlForWithErrorsTo()

FormMail::getHtmlForWithErrorsTo

(

)

get Html For WithErrorsTo

Returns

string html

Definition at line 1204 of file html.formmail.class.php.

Referenced by get_form().

isEMailTemplate()

FormMail::isEMailTemplate	(		$type_template,
			$user,
			$outputlangs )

Find if template exists Search into table c_email_templates.

Parameters

string	$type_template	Get message for key module
User	$user	Use template public or limited to this user
Translate	$outputlangs	Output lang object

Returns

int <0 if KO,

Definition at line 1455 of file html.formmail.class.php.

remove_attached_files()

FormMail::remove_attached_files

(

$keytodelete

)

Remove a file from the list of attached files (stored in SECTION array)

Parameters

string

$keytodelete

Key index in file array (0, 1, 2, ...)

Returns

void

Definition at line 283 of file html.formmail.class.php.

setSubstitFromObject()

FormMail::setSubstitFromObject	(		$object,
			$outputlangs )

Set ->substit (and ->substit_line) array from object.

This is call when suggesting the email template into forms before sending email.

Parameters

CommonObject	$object	Object to use
Translate	$outputlangs	Object lang

Returns

void

See also

getCommonSubstitutionArray()

Definition at line 1549 of file html.formmail.class.php.

show_form()

FormMail::show_form	(		$addfileaction = 'addfile',
			$removefileaction = 'removefile' )

Show the form to input an email this->withfile: 0=No attaches files, 1=Show attached files, 2=Can add new attached files this->withmaindocfile.

Parameters

string	$addfileaction	Name of action when posting file attachments
string	$removefileaction	Name of action when removing file attachments

Returns

void

Deprecated

Definition at line 348 of file html.formmail.class.php.

References get_form().

---

The documentation for this class was generated from the following file:

• dolibarr_18.0/htdocs/core/class/html.formmail.class.php