Configuration
Use cases that send e-mails on the server-side require a third-party SMTP server and a corresponding configuration in Fabasoft Folio. Detailed information about the configuration in Fabasoft Folio can be found in the administration help (chapter “SMTP Configuration”).
Send Objects via SMTP (FSCSMTP@1.1001:SendObjects)
This use case is used to send objects in different formats according to the given parameters. The following parameters are defined:
- objects (COOSYSTEM@1.1:OBJECTLIST)
The list of objects which should be sent. When this optional parameter is left empty, the message only contains the value of the body parameter. - ascopy (COOSYSTEM@1.1:BOOLEAN)
Specifies how the e-mail has to be sent. If true, the objects will be sent as copy, which means that the object's content itself is used as e-mail attachment. If false, a hyperlink to the object is generated. This hyperlink is either a plain text or HTML link, depending on the parameter messageformat. Default value: false. - from (COOSYSTEM@1.1:STRING)
This parameter defines the e-mail address which should be displayed in the From field of the e-mail. This value must be a valid e-mail address. If left empty, the current user's e-mail address is used instead. - to (COOSYSTEM@1.1:STRING)
This parameter defines the To field of the e-mail. Specifies the receiver's e-mail address and must not be empty. Multiple e-mail addresses can be specified using semicolon as delimiter. - subject (COOSYSTEM@1.1:STRING)
The e-mail's subject. Must not be empty and is limited to 255 characters. - body
The e-mail's body. The parameter can be passed as one of the following four types:- COOSYSTEM@1.1:STRING
The value is used as HTML body. - COOSYSTEM@1.1:CONTENT
The content is used as HTML body. - COOSYSTEM@1.1:Content
The content is taken from the aggregate's property COOSYSTEM@1.1:contcontent. Additionally if the aggregate's property COOSYSTEM@1.1:contextension equals "mht", the content is considered as preformatted MIME and used as a multipart/mime HTML message. - COOSYSTEM@1.1:OBJECT
The object's content itself is used as the e-mail body.
- COOSYSTEM@1.1:STRING
- importance (FSCSMTP@1.1001:Importance)
Sets the e-mail's importance. The following values are allowed:- SMTP_IMPORTANCE_LOW
- SMTP_IMPORTANCE_NORMAL (default)
- SMTP_IMPORTANCE_HIGH
- cc (COOSYSTEM@1.1:STRING)
The email's Cc: recipients. This optional field must contain valid e-mail addresses. Multiple e-mail addresses can be specified using semicolon as delimiter. - bcc (COOSYSTEM@1.1:STRING)
The email's Bcc: recipient. This optional field must contain valid e-mail addresses. Multiple e-mail addresses can be specified using semicolon as delimiter. - messageformat (COOMAPI@1.1:SendAsFormat)
Specifies how to format the e-mail's body. The following values are defined:- SENDAS_HTML
HTML mail - SENDAS_PLAIN
Plain text mail
- SENDAS_HTML
- copyformat (COOMAPI@1.1:SendAsCopyFormat)
Specifies how to deliver the attached files, in case of the parameter ascopy is set to true. The following values are defined:- SENDASCOPY_ORIGINAL
Original content - SENDASCOPY_PDF
Original content will be converted to PDF
- SENDASCOPY_ORIGINAL
- notused1 (COOSYSTEM@1.1:STRING)
This parameter is not in use. - notused2 (COOSYSTEM@1.1:STRING)
This parameter is not in use. - messageid (COOSYSTEM@1.1:STRING)
This output parameter will contain the internet message ID of the sent e-mail. - multipartrelated (COOSYSTEM@1.1:BOOLEAN)
When this optional parameter is set to true, the e-mail well be sent as a multipart MIME message. Default value: false - baseurl (COOSYSTEM@1.1:STRING)
This parameter is currently not in use. - replyto (COOSYSTEM@1.1:STRING)
When this optional parameter is set, the Reply-To: field well be generated. This field is used by an e-mail client to determine which e-mail address to use when the e-mail is replied. The parameter must contain a valid e-mail address.
Send HTML via SMTP (FSCSMTP@1.1001:SendHTML)
This use case is used to send an e-mail in HTML format. The e-mail body is passed as a parameter.
The following parameters are defined:
- from (COOSYSTEM@1.1:STRING)
The From: field in the e-mail. This value must be a valid e-mail address. If left empty, the current user's e-mail address is used instead. - to (COOSYSTEM@1.1:STRING)
The To: field in the e-mail. Specifies the receiver's e-mail address and must not be empty. Multiple e-mail addresses can be specified using semicolon as delimiter. - subject (COOSYSTEM@1.1:STRING)
The e-mail's subject. Must not be empty and is limited to 255 characters. - htmlbody
The e-mail's body. The parameter can be passed as one of the following three types:- COOSYSTEM@1.1:STRING
The value is used as HTML body. - COOSYSTEM@1.1:CONTENT
The content is used as HTML body. - COOSYSTEM@1.1:Content
The content is taken from the aggregate's property COOSYSTEM@1.1:contcontent. Additionally if the aggregate's property COOSYSTEM@1.1:contextension equals "mht", the content is considered as preformatted MIME and used as a multipart/mime HTML message.
- COOSYSTEM@1.1:STRING
- importance (FSCSMTP@1.1001:Importance)
Sets the e-mail's importance. The following values are allowed:- SMTP_IMPORTANCE_LOW
- SMTP_IMPORTANCE_NORMAL (default)
- SMTP_IMPORTANCE_HIGH
- cc (COOSYSTEM@1.1:STRING)
The email's Cc: recipients. This optional field must contain valid e-mail addresses. Multiple e-mail addresses can be specified using semicolon as delimiter. - bcc (COOSYSTEM@1.1:STRING)
The email's Bcc: recipient. This optional field must contain valid e-mail addresses. Multiple e-mail addresses can be specified using semicolon as delimiter. - sendoptions (FSCSMTP@1.1001:SendOption)
Set a specific send option. No default value. The following values are allowed:- SENDOPTION_REPORT_READ
Request read status reports - SENDOPTION_REPORT_DELIVERY
Request delivery status reports - SENDOPTION_WAIT_UNTILCREATED
Wait until message has been created - SENDOPTION_WAIT_UNTILCLOSED
Wait until message form has been closed
- SENDOPTION_REPORT_READ
- attachfiles (COOSYSTEM@1.1:CONTENTLIST)
Optional parameter with a list of contents which are sent as attachments. - attachnames (COOSYSTEM@1.1:STRINGLIST)
Optional parameter with a list of name strings, which correspond to the given list of contents in the parameter attachfiles. - attachextensions (COOSYSTEM@1.1:STRINGLIST)
Optional parameter with a list of extension strings, which correspond to the given list of names in the parameter attachnames.
Note: The indices of the three parameters: attachfiles, attachnames and attachextensions have to match respectively. - messageid (COOSYSTEM@1.1:STRING)
This output parameter will contain the internet message ID of the sent e-mail. - replyto (COOSYSTEM@1.1:STRING)
When this optional parameter is used, the Reply-To: field is generated. This field is used by an e-mail client to determine which e-mail address to use when the e-mail is replied. The parameter must contain a valid e-mail address.