project BLF > class Mail
business class
inherited from Business Component
business area System Administration
Description
This business component contains methods to Send Mails
public data items
other data items
- sStream
Stream
- tFcMessages
Contains a list of messages to display on the client side. Records in the table should not be created directly, but by using method SetMessage.
- vcAttachments
Comma separated list of files that need to be attached to the mail. The files should be reachable using the propath (or you can add the full path with them)
- vcAttachmentStore
Array with names of attachments.
- vcBase64Chars
Array with base 64 characters. This is used for the encoding mechanism of a file that is attached in a mail message.
- vcBody
The body of the message
- vcCc
Carbon copy recepients
- vcClientPrincipalObject
- vcCompanyCode
- vcComponentsWithFS
- vcDate
The date the message is sent.
- vcDefaultSender
The default sender for the email to be used if no sender is specified.
- vcDomainCode
The domain code of the domain to which this session is logged in.
- vcDomainLngCode
session value
- vcDraftClass
- vcFcComponentName
Short name of the target business class.
- vcFcDateFormat
Display format for dates to be used in all displayable strings.
- vcFcMaskList
Data item to temporarily store the returned values of a value list method (or any other use).
- vcFcNumericFormat
Display format for decimal values to be used in all displayable strings.
- vcFieldSecurityDisabledFields
- vcFrom
From address
- vcGlobalSessionId
This data item holds the global session token. This is set in CheckLogin on QADFC level and passed with ApplicationLogin in Login. Is also set in ApplicationLogin.
- vcIP
contains the IP adress of the mailservers
- vcLocalisationCode
- vcRecipientsPerDomain
pipe separated list of all recipients in icTo that are from the same domain.
- vcServerName
This variable contains temporarily the name of the srever retrieved with nslookup in method IPAdressGetter
- vcSmtpPort
This contains the port Number of the Smpt Server. This value is also stored in server.ini
- vcSmtpServer
This contains the name of the smpt server. the value of this is stored in server.ini
- vcSubject
message subject
- vcTo
Recipients (can be a pipe separated list)
- vcUserLogin
Current User login ID
- vcUserName
Current user name
- vhCacher
Handle to the technical class
- vhFcComponent
field of t_FC_active_components.
Also a normal data item used for all direct calls from business to business components.
- vhFcPersistence
In a stateless setup, when the server component is started, an instance of the persistence component is started automatically, which will stay active for the complete session.
That way, each Loadstate of any component can use the same instance of the persistence component.
- vhFcStateDataSet
This is the handle to the dynamic dataset that holds all temp-tables defined in the business class making up the state of this business class.
You can add your own temp-table to this dataset to enable you to persist the contents of that temp-table, using the add-buffer() method on vhFcStateDataSet in method DefineState.
- vhFcSuper
Handle to the component at the top of the inheritance tree (the server component), as it is used to run iStartComponent.
- vhSocket
This is a handle to the socket to the main server
- viCurrentDraftInstanceId
when opening a draft instance, this data item contains the original instance ID of the draft
- viExtentCount
Counter for indicating the current extent in vmMessage.
- viFcCount1
Counter variable for general use.
- viFcCount2
Counter variable for general use.
- viFcCount3
Counter variable for general use.
- viFcCount4
Counter variable for general use.
- viFcCount5
Counter variable for general use.
- viFcCurrentInstanceId
instance ID
- viFcIncludeReturn
Return status used by the standard includes. Avoid using this data item !
- viFcMaxInstancesInTransaction
The maximum instances in 1 transaction.
- viFcQueryReturn
Return status used by query calls. Avoid using this data item !
- viFcReturnSuper
General purpose data item that can be used for the return status of any method call.
- viLogger
Logger
- viMessageID
- viPreference
contains the Preference of the mail server
- viRecipients
Number of Recipients in vcRecipientsPerDomain
- viSessionDebugLevel
- viStep
the step counter
- viTimeOffset
Specifies the time offset in minutes between local time and UTC.
This value will be assigned to the session:timezone attribute to be able to control the output of the progress functions today and time.
- viUsrId
Current user identifier
- vlCBFActive
Custom Business Fields
- vlCBFActiveCache
- vlDraftsActive
- vlDraftsActiveCache
- vlEnablePersistentCache
- vlEventPublishingActive
Flag indicates if event publishing is active.
If not, skip all time consuming queries on event publishing.
- vlEventPublishingActiveCache
- vlFcOk
Logical data item for general use.
- vlFcQueryRecordsAvailable
Support query existance calls. Returns true if at least one record has been found.
- vlFcStarted
Used in BC_run.i.
If the component was started in BC_run, it must also be ended in BC_run. If the component was already running before BC_run, it should stay running.
- vlFieldSecurityActive
Indicates whether the field security is active on system level.
- vlFieldSecurityActiveCache
- vlFieldSecurityActiveOnBC
- vlInstanceDataIsLoaded
This flag indicates if the instance data of current instance was loaded from the state database.
This is true when :
- Any instance is opened in stateless mode.
- A draft instance is opened in state-reset mode.
- vlObjectSecurityActive
Flag indicates if row security is in use.
If not, skip all time consuming queries on row security.
- vlObjectSecurityActiveCache
- vlObjectTranslationsActive
Value of system setting "Use Language Specific Object descriptions".
- vlResponded
Response received from mail server ?
- vlSendComplete
True when mail send is completed.
- vlTransactionActive
This flag will be true if current instance started an instance of another business class as a subtransaction, but current instance is not part of a transaction.
In this case, current instance already started a transaction of it's own. Now it must also commit this transaction of it's own.
- vlTransactionMainInstance
Role-based security is mandatory on main instance in transaction (= first instance added) and optional on all others.
- vlTransactionOpen
A special-purpose flag for the transaction class only.
- vlTranslationTracing
- vlUICustomizationActive
user setting = instance dependent
- vlWorkFlowActive
workflow active
- vlWorkFlowActiveCache
- vmAttachmentStore
Memory pointer to different attachments.
- vmBuffer
This memptr contains the send and received messages from the socket.
- vmEmpty
An empty memptr.
- vmMessage
Array of memptr's. This will contain all the different parts of the mail message : the from, to, cc, ..., the body and the attachments .
API methods
public methods
other methods