Medialon MxMs' Help 
  
Name : Medialon eMail
Version : 1.1.1
Available for : Manager V5 (all versions), Showmaster (ST & Pro)
Limitation In :
Device Brand : Medialon
Positrack Compatible : No
Resources type : TCP/IP Network
 
Compatible hardware interfaces - available resource modules (MRC) :
 

 

> Overview | > Installation (MXM) | > Creation (Device) | > Commands (List Of) | > Variables (List Of) | > Support


Overview :

This MXM offers the possibility to manage the sending and the reception of emails in a Manager projects and to manage sending only in Showmaster projects.

The email account ( Hosts, User ID, User password, User name) is created at setup but it can be changed at any time with the command “Change Account”. By this way, one device can manage several accounts.

The sending and receiving (in Manager) can be automated in tasks for scheduled mailings.

> Top


Installation (MXM) :

No special requirement.

> Top


Creation (Device) :

This MXM provides two different setups, depending if it is used in Manager or Showmaster. Commands or Variables marked with '*' are not compatible or have restricted usage with Showmaster.

Manager Setup:

The setup of the device is done through this dialog box :



All these parameters are the default email account for this device.

POP3 Server (for receception):
The name of the server where the emails that the user receive are stocked .

POP3 Port:
The POP3 TCP/IP port used by the server. Keeping this field empty will use the default port (110).

SMTP Server (for transmission):
The name of the server responsible for sending emails .

SMTP Port:
The SMTP TCP/IP port used by the server. Keeping this field empty will use the default port (25).

Directory for saving attachment files :
The full path of the directory where the files attached to the emails will be saved at their reception.

Delete the messages present on the remote server after reading :
If this option is checked, the messages that have been read are automatically deleted. If it is not checked, the messages that have been read will stay on the pop server.

ID :
User ID for login.

Password :
User password for login.

Name :
Real name of the user, as it appears in the header of the email.

Address :
Address of the user for the response.

Showmaster Setup:

The setup of the device is done through this dialog box :



All these parameters are the default email account for this device.

SMTP Server (for transmission):
The name of the server responsible for sending emails .

Port:
The SMTP TCP/IP port used by the server. Keeping this field empty will use the default port (25).

ID :
User ID for login.

Password :
User password for login.

Name :
Real name of the user, as it appears in the header of the email.

Address :
Address of the user for the response.

> Top


Commands (List Of) :

Change account: *

      Description: Change the current account.
      Parameters :
      Reception host [Type : String] : Pop server.
      Sending host [Type : String] : Smtp server.
      User ID [Type : String] : User ID for login.
      Password [Type : String] : User password for login.
      User Name [Type : String] : Real user name.
      User email [Type : String] : Address of the user for the response.
      Automatic deletion [Type : Enum] : Indicates if emails must be remove from the server (On).
      Attachments Folder [Type : String] : Path of the folder for attached documents.

Receive: *
      Description : To login to the pop server and receive the mails if any..
      Parameters : No parameters.
      Usage : After completion, the variable MessagesCount contains the count of messages received and the variable MessagesList contains the list of the subjects of the messages received.

Select message:
*
      Description : To select a received message for reading.
      Parameters :
      Message number [Type : Integer] : The index of the received message to select.
      Usage : When a message is selected, the variables SelectedMessageSize, SelectedMessageFrom, SelectedMessageSubject, SelectedMessageHeader, SelectedMessageBody and SelectedAttachmentsList reflect the content of the message. All these variables can be displayed into graphical displays. The body, which can contain carriage returns can be displayed in the provided editor.

Delete remote messages:
*
      Description : To delete all the messages present in the pop server..
      Parameters : No parameters.
      Usage : This command can be used when the automatic deletion of messages is not checked in the setup.

Send:
      Description : To send the specified message.
      Parameters :
      To [Type : String] : The recipient of the message (*)
      Cc [Type : String] : The carbon copy (secondary recipient of the message)
      Bcc [Type : String] : The blind carbon copy (hidden recipient of the message)
      Subject [Type : String] : The subject of the message.
      Body [Type : String] : The message itself.
      Attachments [Type : String] : The full path of the file to attach, if any.
      Usage : Fields marked with (*) must not be blank. Recipient addresses must be separated by ',' or ';' in the reception list

Skip big messages:
*
      Description : Defines the size of the biggest message to be retreived. If the message size if bigger than the given size then the message is skipped.
      Parameters :
      Max Size(Ko) [Type : Integer] : Size of the biggest message (0 means unlimited).

Open RAS:
*
      Description : To connect to the specified Remote Access Server connection.
      Parameters :
      RAS entry name [Type : String] : Name of the specified connection.
      RAS entry password [Type : String] : Password for this connection.
      Usage : The variable RASEntries is the list of all the possible connections.

Close RAS:
*
      Description : To disconnect from the previously connected Remote Access Server connection.
      Parameters : No parameters.

> Top


Variables (List Of) :

Status:

      Type : Enum.
      Description : Current status of the device.
          Available values
          “Idle"
          "Host resolved"
          "Connected"
          "Deleting messages"
          "Error"

Message:
      Type : String.
      Description : Error message.

BytesTotal:
      Type : Integer.
      Description : Total size of the message.
      Usage : When sending, total size of the message to send. When receiving, total size of the message to receive.

BytesToReceive:
*
      Type : Integer.
      Description : Size of the message remaining to receive.
      Usage : The difference between Bytes total and Bytes to receive can be displayed in a gauge.

MessagesCount:
*
      Type : Integer.
      Description : Count of messages received.

MessagesList: *
      Type : String.
      Description : List of all the subjects of the received messages.

SelectedMessageSize:
*
      Type : Integer.
      Description : Size, in bytes, of the selected message.

SelectedMessageFrom:
*
      Type : String.
      Description : Sender of the selected message.

SelectedMessageSubject:
*
      Type : String.
      Description : Subject of the selected message.

SelectedMessageHeader:
*
      Type : String.
      Description : Header of the selected message.

SelectedMessageBody:
*
      Type : String.
      Description : Body of the selected message.

SelectedAttachmentsList:
*
      Type : String.
      Description : List of attached files of the selected message.
      Usage : The messages are saved into the directory specified at setup.

RASEntriesList:
*
      Type : String
      Description : List of all the possible Remote Access Server connections.

RASStatus:
*
      Type : Enum.
      Description : Current status of the Remote Access Server..
          Available values
          "Disconnected"
          "Not implemented"
          "Dialing"
          "Error"
          "Opening port"
          "Device connection"
          "Authentification"
          "Password expired"
          "Connected"

> Top


Support (Difference with previous versions) :

> Top

V 1.1.0:

  • Added: Support for Showmaster ST & Pro.
  • Fixed: Variables other than String are not supported in command parameters.

V 1.1.1:

  • Bug Fixed: only one mail address can be used in the To/Cc/Bcc parameters of the Send command.