CodeMorphis   
  Home » SCPs » My Account  |  Cart Contents  |  Checkout   
Products
Introducing Synopsis
Synopsis Demos
Download Synopsis
SCPs
Services
Consulting
Community
FAQ
Forums
Log In
Company
About CodeMorphis
Contact Us
Links
Other
Conditions of Use
Privacy Notice
Synopsis White Paper
Survey
Site Map
Email Client SCP USD $25.00
Available Options:
Format:
File size:537.5k



Contains one (1) component:

Email Client component: allows for downloading as well as sending email. Email is received using the POP3 protocol and email is sent using SMTP.

Product: Synopsis 2.0


Email Client Component

Component Tray Tab: Web


Usage

The Email Client component allows for downloading as well as sending email. Email is received using the POP3 protocol and email is sent using SMTP.

The component can access and attachments and nested attachments save to disk.

A list of messages is maintained by the component and these messages can be downloaded from the POP3 server or retrieved from files or memory. The list of messages can be parsed, data extracted, messages added to UI, etc.

For downloading messages, the Connect and Download services should be called first, in that order. After these two services are called, the other services may be used to access the downloaded messages and attachments. Downloading messages leaves messages on the POP3 server so to remove them, the Mark del or Mark all del services should be called after all processing of messages is complete. If messages are not deleted then they will be downloaded again with a subsequent call to the Download service.

Messages stored in memory or in files can also be added to the message list using the Add mesg and Add mesg (FILE) services, respectively. This allows for the treatment of previously dowloaded messages.

Several services have "message index path" input arguments. These arguments describe the nested path to an attachment. Note that an email message can have attachments that are email messages themselves, which in turn have attachments. A message index path is a string of 0-offset values, each value being the index of a nested email or attachment.

An example of this is "3 1 0 2".

The first index 3 refers to the 4th downloaded message (call this email message A).

The second index 1 refers to the 2nd attachment in the message which must be an email attachment (call this email message B) since there are more indices that follow.

The third index 0 refers to the 1rst attachment in message B which must also be an email attachment (call this email message C) since there are more indices that follow.

The fourth index 2 refers to the 3rd attachment in message C which may be an email attachment or a file.


Properties

Property Details
Active service The component service to invoke.



Services

Service Details
Add mesg Add a raw message to the message list. This is useful for adding a previously downloaded and stored raw email message to the message list for extracting data and fields from the message using the various services of the Email Client component.
Argument Description
Input 0 Raw content Raw message content. This is the complete email message content. A downloaded message whose content was retrieved using the Get mesg service could be passed here.
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Add mesg (FILE) Add raw message(s) file(s) to the message list. This is useful for adding previously downloaded and stored raw email messages to the message list for extracting data and fields from the message using the various services of the Email Client component.
Argument Description
Input 0 File path list List of file paths, one per line, each being a file containing raw message content. This is the complete email message content. A downloaded message whose content was retrieved using the Save mesg service could be passed here.
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Add mesgs to UI Add message field info to a ListView UI component. For each message in the message list, a row is added with the option to provide information from the following email message fields:

  • From
  • To
  • Cc
  • Subject
  • Priority
  • Date Received
Each email message field can be assigned to a column of the ListView. To use this service, the ListView UI component must have it's "View" property set to "Details". It is also assumed that the number of columns in the ListView is large enough to accomodate the message fields being applied. For each of the above fields, an index is specified that corresponds to the ListView column to which assigment should be applied. A field can be dropped by passing a -1 as the] corresponding ListView column index.
Argument Description
Input 0 Windows Form The name of the Windows Form that contains the ListView to fill.
1 ListView UI component The name of the ListView component to fill.
2 Clear If true, then all rows in the ListView are deleted before the message list data is added.
3 From col index The column index of the ListView to which the From field info is to be applied. Pass -1 to skip this field.
4 To col index The column index of the ListView to which the To field info is to be applied. Pass -1 to skip this field.
5 Cc col index The column index of the ListView to which the Cc field info is to be applied. Pass -1 to skip this field.
6 Subject col index The column index of the ListView to which the Subject field info is to be applied. Pass -1 to skip this field.
7 Priority col index The column index of the ListView to which the Priority field info is to be applied. Pass -1 to skip this field.
8 Date Received col index The column index of the ListView to which the Date Received field info is to be applied. Pass -1 to skip this field.
Close Close POP3 connection.
Argument Description
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Connect Connect to POP3 server.
Argument Description
Input 0 Server POP3 server
1 User User name
2 Password Password
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Delete Delete a message from the message list. If the message was downloaded this service also marks the downloaded message for deletion on the POP3 server.
Argument Description
Input 0 Message index Message index (0 offset). This must be a value between 0 and the value returned by the Num mesgs service.
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Delete all Deletes all messages from the message list. If a message was downloaded this service also marks the downloaded message for deletion on the POP3 server.
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Download Download messages. A connection to the POP3 server must first be made by calling the Connect service.
Argument Description
Output 0 Num messages Number of messages downloaded
Get attach Get attachment file name and content.
Argument Description
Input 0 Message index path Message index path (0 offset), e.g. "1 2" or "3 1 0 2".
1 Attachment index Attachment index (0 offset)
Output 0 File name Attachment file name
1 Content Attachment content
Get attach name Get attachment file name.
Argument Description
Input 0 Message index path Message index path (0 offset), e.g. "1 2" or "3 1 0 2".
1 Attachment index Attachment index (0 offset)
Output 0 File name Attachment file name
Get fields Get email message fields.
Argument Description
Input 0 Message index path Message index path (0 offset), e.g. "1" or "3 1 0".
Output 0 From From field
1 To To field
2 Cc Cc field
3 Subject Subject field
4 Priority The priority level of the message. Priority 1 is the highest, priority 3 is normal, priority 5 is the lowest.
5 Date received The date stamp for the received message.
6 Date received GMT The GMT value for the date stamp of the received message that is passed through output data port 5. This is an integer value that represents the GMT time zone, e.g. -5 for GMT-5.
Get header Get message header.
Argument Description
Input 0 Message index path Message index path (0 offset), e.g. "1" or "3 1 0".
Output 0 Header Message header
Get (HTML) Get HTML body of a message.
Argument Description
Input 0 Message index path Message index path (0 offset), e.g. "1" or "3 1 0".
Output 0 HTML Message body (HTML)
Get image Get the details and content of an HTML embedded image in a downloaded email message. An embedded image is referenced directly in a message's HTML content and is not transported as a separate file attachment.
Argument Description
Input 0 Message index Message index (0 offset). This must be a value between 0 and the value returned by the Num mesgs service.
1 Image index Image index (0 offset). This must be a value between 0 and the value returned by the last call to the Download service.
Output 0 File name Embedded HTML image file name. This is the original name of the file that was added to the email message.
1 Content ID Embedded HTML image content ID. This is an automated ID that was added to the sending email program. This ID appears in the HTML message and references the embedded image. The content ID reference in the HTML message may contain the prefix "cid:", therefore if the content ID of the image is

"002401c85f13$d77f7150$6601a8c0@machine_name"

then actual content ID that appears in the HTML message may be

"cid:002401c85f13$d77f7150$6601a8c0@machine_name".
2 Content The image content, which is a character-encoding of the image file.
Get mesg Get the complete message content. This includes any embedded attachments which are text-encoded.
Argument Description
Input 0 Message index path Message index path (0 offset), e.g. "1" or "3 1 0".
Output 0 Content Raw message content, i.e. the actual text-encoded content of the email message.
Get (plain) Get plain text body of a message.
Argument Description
Input 0 Message index path Message index path (0 offset), e.g. "1" or "3 1 0".
Output 0 Plain text Message body (plain text)
Mark all del Mark all downloaded messages for deletion on the POP3 server.
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Mark del Mark a downloaded message for deletion on the POP3 server.
Argument Description
Input 0 Message index Message index (0 offset). This must be a value between 0 and the value returned by the Num mesgs service.
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Num attach Get the number of attachments.
Argument Description
Input 0 Message index path Message index path (0 offset), e.g. "1" or "3 1 0".
Output 0 Num attachments Number of attachments
Num images Get the number of HTML embedded images in a downloaded email message. An embedded image is referenced directly in a message's HTML content and is not transported as a separate file attachment.
Argument Description
Input 0 Message index Message index (0 offset). This must be a value between 0 and the value returned by the Num mesgs service.
Output 0 Num images The number of HTML embedded images in the given downloaded email message
Num mesgs Get the number of messages downloaded.
Argument Description
Output 0 Num messages Number of messages
Save attach Save attachment to file.
Argument Description
Input 0 Message index path Message index path (0 offset), e.g. "1 2" or "3 1 0 2".
1 Attachment index Attachment index (0 offset)
2 Dir Directory in which to save
3 Allow overwrite If TRUE, allow overwrite of target file if it exists, otherwise if the target file exists then the save operation is aborted.
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Save (HTML) Save the HTML body of a message to file.
Argument Description
Input 0 Message index path Message index path (0 offset), e.g. "1" or "3 1 0".
0 File path Target file path to which the HTML body of the message should be saved.
0 Allow overwrite If TRUE, allow overwrite of target file if it exists, otherwise if the target file exists then the save operation is aborted.
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Save image Save a given HTML embedded image of a downloaded message.
Argument Description
Input 0 Message index Message index (0 offset). This must be a value between 0 and the value returned by the Num mesgs service.
1 Image index Image index (0 offset). To specify a given embedded image, this must be a value between 0 and the value returned by the last call to the Num images service. To save all embedded images in a downloaded message, pass -1.
2 Dir Directory in which to save
3 Content ID name If TRUE, use the content ID tag referenced in the HTML message, otherwise use the original name of the file that was added to the email message.
4 Allow overwrite If TRUE, allow overwrite of target file if it exists, otherwise if the target file exists then the save operation is aborted.
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Save mesg Save the complete message content to file. This includes any embedded attachments which are text-encoded.
Argument Description
Input 0 Message index path Message index path (0 offset), e.g. "1" or "3 1 0".
0 File path Target file path to which the raw message content should be saved.
0 Allow overwrite If TRUE, allow overwrite of target file if it exists, otherwise if the target file exists then the save operation is aborted.
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Save (plain) Save the plain text body of a message to file.
Argument Description
Input 0 Message index path Message index path (0 offset), e.g. "1" or "3 1 0".
0 File path Target file path to which the plain text body of the message should be saved.
0 Allow overwrite If TRUE, allow overwrite of target file if it exists, otherwise if the target file exists then the save operation is aborted.
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Send mail Send e-mail message using SMTP.
Argument Description
Input 0 To To address(es)
1 Cc Cc address(es)
2 Bcc Bcc address(es)
3 From From address
4 Subject Message subject
5 Body Message body
6 Html format Html format (TRUE value) or Text format (FALSE value)
7 Attachments List of attachment files (one per line)
8 SMTP server SMTP server
Output 0 Succeeded Operation succeeded: TRUE or FALSE

Customers who bought this product also purchased

Desktop Event SCP
Currencies
Shopping Cart more
0 items
Notifications more
NotificationsNotify me of updates to Email Client SCP