Component Receipt e-mail

Table of Contents

Description
Properties
See also

Description

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

Table 1. System Characteristics

Index	`122`
Short title	`emailreceive`
Types of scenarios	`All of them`
Starter module	`r_script_component_emailreceive`
Mode	Asynchronous
Icon
Branching pattern	Branching, closing

Properties

Table 2. Properties
Specification	Description
Title: `Protocol` Code: `protoMode` Visibility: `no` Default: `POP3`	The protocol used to receive mail. Possible options: `POP3` (`0`) `IMAP` (`1`)
Title: `Server Address` Code: `srvAddr` Visibility: `no` Default: —	Mail server address.
Title: `Server Port` Code: `srvPort` Visibility: `no` Default: —	Mail server port.
Name: `SSL` Code: `srvSSL` Visibility: `no` Default: `None'	Mode switch SSL.
Title: `Login` Code: `srvLogin` Visibility: `no` Default: —	Login for authorization on the mail server.
Title: `Password` Code: `srvPass` Visibility: `no` Default: —	Password for authorization on the mail server.
Title: `Catalog` Code: `folder` Visibility: `yes` Default: INBOX	IMAP directory. Applies only when using the protocol IMAP.
Name: `UidValidity` Code: `uidValidity` Visibility: `yes` Default: 0	Numeric directory identifier IMAP. Available only when using the protocol IMAP. Used when setting up synchronization mode without deleting e-mails from the IMAP directory on the server, together with the fields `uidNext`, `uidValidityVar`, `uidNextVar`. If the transferred value matches the actual value in the IMAP directory on the server, the application of the value in the field is activated `uidNext`. If the value does not match, the first catalog letter in date order is returned. The component additionally returns the actual value of UidValidity in the field `UidValidityVar`.
Name: `UidNext` Code: `uidNext` Visibility: `yes` Default: 0	Specifies the identifier of the email to be returned from the catalog IMAP. Available only when using the protocol IMAP. Used when setting up synchronization mode without deleting e-mails from the IMAP directory on the server, together with the fields `uidNext`, `uidValidityVar`, `uidNextVar`. If no mails with the specified identifier are found, control is returned by the `No mails branch`. Only works if the `uidValidity` value matches the actual value in the IMAP directory on the server. The component additionally returns the actual value of UidValidity in the field `UidValidityVar`.
Title: `Sender to variable` Code: `fromVar` Visibility: `no` Default: —	Variable to store the sender’s name/box. Header `From`.
Title: `Receiver to variable` Code: `toVar` Visibility: `no` Default: —	Variable to store the recipient’s name/box. Header `To`.
Title: `Topic to Variable` Code: `subjectVar` Visibility: `no` Default: —	Variable to save the email subject. Header `Subject`.
Title: `ID of message to variable` Code: `messageidVar` Visibility: `no` Default: —	Variable to store the message identifier.
Title: `Coding` Code: `encodingType` Visibility: `no` Default: `Default'	The encoding from which the body of the received mail is converted. Possible options: `Default` (`default`, `1`) - Auto-define encoding. `No` (`none`, `2`) - No conversion is applied. `utf-8` (`3`) `utf-16` (`4`) `utf-32` (`5`) `cp1251` (`6`) – Code page `windows-1251` (Cyrillic alphabet) `koi8-r` (`7`) `Specify name` (`byname`, `8`) - Specify the encoding name manually.
Title: `Encoding name` Code: `encodingName` Visibility: `yes` Default: `cp1251`	The manually specified encoding name for the email body.
Name: `UidValidityVar` Code: `uidValidityVar` Visibility: `yes` Default: —	Returns the actual UidValidity value of the catalog IMAP. Available only when using the protocol IMAP. Used when setting up synchronization mode without deleting e-mails from the IMAP directory on the server, together with the fields `uidValidity`, `uidNext`, `uidNextVar`.
Name: `UidNextVar` Code: `uidNextVar` Visibility: `yes` Default: —	Returns the identifier of the next mail in the IMAP directory. If the outermost mail is returned, the returned identifier specifies the value of the future mail. Available only when using the protocol IMAP. Used when setting up synchronization mode without deleting e-mails from the IMAP directory on the server, together with the fields `uidValidity`, `uidNext`, `uidValidityVar`, `uidNextVar`.
Name: `Uid` Code: `uid` Visibility: `yes` Default: —	Returns the identifier of the received mail in the catalog IMAP. Available only when using the protocol IMAP.
Title: `Save Titles` Code: `saveHeaders` Visibility: `no` Default: `None'	Switch on the operation of saving headers to a variable.
Title: `Titles to variable` Code: `headersVar` Visibility: `yes` Default: —	Variable to save email headers.
Title: `Save Text` Code: `saveTBody` Visibility: `no` Default: `Yes`	Switch on the operation of saving text to a variable.
Title: `Text to variable` Code: `tbodyVar` Visibility: `yes` Default: ``	Variable to save the email text (MIME part with `Content-Type: text/plain`).
Title: `Save HTML` Code: `saveHBody` Visibility: `no` Default: `Yes`	Turns off the operation of saving the HTML representation of the text to a variable.
Title: `HTML to variable` Code: `hbodyVar` Visibility: `yes` Default: —	Variable to save the HTML representation of the email text (MIME part with a `Content-Type: text/html`).
Title: `Save the First Body` Code: `saveBody1` Visibility: `no` Default: `None',	Turns off the operation of saving text from the first text portion of the MIME content of the email.
Title: `Body(1) to variable` Code: `body1Var` Visibility: `yes` Default: —	Variable to save text from the first encountered text portion of the MIME content of the email (`text/plain`, `text/html`, …).
Title: `Save source text` Code: `saveSource` Visibility: `no` Default: `None'	Switch on the operation of saving the full source text of the e-mail to a variable.
Title: `Source text to variable` Code: `sourceVar` Visibility: `yes` Default: —	Variable to save the original body of the e-mail in format MIME.
Title: `Save attachments` Code: `saveAttachments` Visibility: `no` Default: `None'	Switch on the operation of receiving and saving attachments.
Title: `Catalog with variable attachments` Code: `attachmentsVar` Visibility: `yes` Default: —	Variable to store the path to the directory where the received email attachments are placed.
Title: `Leaving Unread` Code: `keepUnseen` Visibility: `yes` Default: `No'	Unread message sign off/unset switch. Applies only to IMAP.
Title: `Delete from server` Code: `removeFromServer` Visibility: `no` Default: `No'	Switch on the mode of simultaneous deletion of mail from the mail server.
Title: `Transition` Code: `transfer` Visibility: `no` Default: —	The component to which control is passed on successful completion of the operation.
Title: `Transition, Empty` Code: `transferEmpty` Visibility: `no` Default: —	Component to which control is passed if the mailbox is empty.
Title: `Transition, Error` Code: `transferError` Visibility: `no` Default: ``	Component to which control is passed when an error occurs.

Component Receipt e-mail

Description

Properties

See also