Component Receiving e-mail

:icons:font :hardbreaks: :imagesdir: ../../../assets/images :toc-title: Contents :toc:

Description

Receives an email message from the specified email account (IMAP or POP3).

Table 1. System characteristics

Index

122

Short name

emailreceive

Script types

All

Start module

r_script_component_emailreceive

Mode

Asynchronous

Icon

122

Branching type

Branching, closing

Properties

Table 2. Properties
Specification Description

Name: Protocol

Code: protoMode

Visibility condition: no

Default: POP3

Mail receiving protocol used.

Possible options:

  • POP3 (0)

  • IMAP (1)

Name: Server address Code: srvAddr Visibility condition: no

Default: — 

Mail server address.

Name: Server port

Code: srvPort

Visibility condition: no

Default: — 

Mail server port.

Name: SSL connection

Code: srvSSL

Visibility condition: no

Default: No

SSL mode switch. When this flag is set, the connection will be made to a protected port.

Name: Login

Code: srvLogin

Visibility condition: no Default: — 

Login for authorization on the mail server.

Name: Password

Code: srvPass

Visibility condition: no

Default: — 

Password for authorization on the mail server.

Name: Directory Code: folder Visibility condition: yes

Default: INBOX

IMAP directory. Applies only when using the IMAP protocol.

Name: UidValidity Code: uidValidity

Visibility condition: yes

Default: 0

Numeric IMAP directory identifier.

Available only when using the IMAP protocol. Used when setting up the synchronization mode without deleting messages from the IMAP directory on the server, together with the uidNext, uidValidityVar, uidNextVar fields.

If the transmitted value matches the current value in the IMAP directory, the application of the value in the uidNext field is activated on the server.

If the value does not match, then the first letter from the directory in increasing date order is returned.

The component additionally returns the current UidValidity value in the UidValidityVar field.

Name: UidNext Code: uidNext

Visibility condition: yes Default: 0

Specifies the ID of the letter that should be returned from the IMAP directory.

Available only when using the IMAP protocol.

Used when setting up the synchronization mode without deleting messages from the IMAP directory on the server, together with the uidNext, uidValidityVar, uidNextVar fields.

If a letter with the specified identifier is not found, then control is returned via the No letters branch.

It only works if the uidValidity value matches the current one in the IMAP directory on the server. The component additionally returns the current UidValidity value in the UidValidityVar field.

Name: Sender to variable

Code: fromVar

Visibility condition: no

Default: — 

Variable for storing the sender’s name/mailbox. Title From.

Name: Recipient to variable Code: toVar Visibility condition: no

Default: — 

Variable for saving the recipient’s name/mailbox. Title To.

Name: Subject to variable

Code: subjectVar

Visibility condition: no

Default: — 

Variable for saving the subject of the letter. Title Subject.

Name: Message ID to variable

Code: messageidVar

Visibility condition: no

Default: — 

Variable for storing the message ID.

Name: Encoding

Code: encodingType

Visibility condition: no Default: Default

Encoding from which the body of the received message is converted.

Possible options:

  • Default (default, 1) – Auto-detection of encoding.

  • No (none, 2) – Conversion is not applied.

  • utf-8 (3)

  • utf-16 (4)

  • utf-32 (5)

  • cp1251 (6) – Code page windows-1251 (Cyrillic)

  • koi8-r (7)

  • Specify name (byname, 8) – Specify the name of the encoding manually.

Name: Encoding name

Code: encodingName

Visibility condition: yes

Default: cp1251

Encoding name for the body of the message, specified manually.

Name: UidValidityVar Code: uidValidityVar

Visibility condition: yes Default: — 

Returns the current UidValidity value of the IMAP directory.

Available only when using the IMAP protocol.

Used when setting up the synchronization mode without deleting messages from the IMAP directory on the server, together with the fields uidValidity, uidNext, uidNextVar.

Name: UidNextVar Code: uidNextVar

Visibility condition: yes

Default: — 

Returns the identifier of the next letter in the IMAP directory. If the last letter is returned, then the returned identifier indicates the value of the future letter. Available only when using the IMAP protocol.

Used when setting up the synchronization mode without deleting messages from the IMAP directory on the server, together with the fields uidValidity, uidNext, uidValidityVar, uidNextVar.

Name: Uid Code: uid

Visibility condition: yes

Default: — 

Returns the identifier of the received message in the IMAP directory.

Available only when using the IMAP protocol.

Name: Save headers

Code: saveHeaders

Visibility condition: no

Default: No

Switch on the operation of saving headers to a variable.

Name: Headers to variable

Code: headersVar

Visibility condition: yes Default: — 

Variable for saving message headers.

Name: Save text

Code: saveTBody

Visibility condition: no

Default: Yes

Switch on the operation of saving text to a variable.

Name: Text to variable Code: tbodyVar Visibility condition: yes

Default: ``

Variable for saving the text of the letter (MIME parts with Content-Type: text/plain).

Name: Save HTML

Code: saveHBody

Visibility condition: no

Default: Yes

Toggle the operation of saving the HTML representation of the text into a variable.

Name: HTML to variable

Code: hbodyVar

Visibility condition: yes

Default: — 

Variable for saving the HTML representation of the text of the letter (MIME parts with Content-Type: text/html).

Name: Save first body

Code: saveBody1

Visibility condition: no Default: No

Switch on the operation of saving text from the first text part of the MIME content of the letter.

Name: Body(1) to variable

Code: body1Var

Visibility condition: yes

Default: — 

Variable for saving text from the first encountered text part of the MIME content of the letter (text/plain, text/html, …​).

Name: Keep original text Code: saveSource Visibility condition: no

Default: No

Switch on the operation of saving the full source text of the letter to a variable.

Name: Source text to variable

Code: sourceVar

Visibility condition: yes

Default: — 

Variable for saving the original body of the message in MIME format.

Name: Save attached files

Code: saveAttachments

Visibility condition: no

Default: No

Switch the operation of receiving and saving attachments.

Name: Directory with variable attachments

Code: attachmentsVar

Visibility condition: yes Default: — 

Variable for saving the path to the directory in which the attachments of the received letter are located.

Name: Leave unread

Code: keepUnseen

Visibility condition: yes

Default: No

Switch for removing/setting the unread message flag.

Applies to IMAP only.

Name: Delete from server

Code: removeFromServer

Visibility condition: no

Default: No

Toggle the mode of simultaneous deletion of letters from the mail server.

Name: Transition

Code: transfer

Visibility condition: no Default: — 

The component to which control is transferred upon successful completion of the operation.

Name: Transition, empty

Code: transferEmpty

Visibility condition: no

Default: — 

The component to which control is transferred if the mailbox is empty.

Name: Transition, error Code: transferError Visibility condition: no

Default: ``

The component to which control is transferred upon error.

See also