IRISLIB database
MailMessage Class Reference
Inheritance diagram for MailMessage:
Collaboration diagram for MailMessage:

Public Member Functions

_.Library.String GetLocalDateTime ()
 Return the date/time that the message was retrieved converted to. More...
 
_.Library.String GetUTCDateTime ()
 Return the date/time that the message was retrieved converted to. More...
 
_.Library.Integer GetUTCSeconds ()
 Return the date/time that the message was retrieved converted to. More...
 
def __init__ (self)
 If message is NOT multipart, this indicates whether message to be sent. More...
 
- Public Member Functions inherited from MailMessagePart
 AttachEmail (_.Net.MailMessage mailmsg)
 Attach email message to current message.
 
_.Library.Status AttachFile (_.Library.String Dir, _.Library.String File, _.Library.Boolean isBinary, _.Library.String charset, _.Library.Integer count)
 Attach file to this message as another MIME part. More...
 
_.Net.MailMessagePart AttachNewMessage ()
 Attach message to current message. More...
 
_.Library.Status AttachStream (_.Stream.Object stream, _.Library.String Filename, _.Library.Boolean isBinary, _.Library.String charset, _.Library.Integer count)
 Attach the contents of a stream to this message as another MIME part. More...
 
_.Library.String GetAttribute (_.Library.String header, _.Library.String name)
 
_.Library.String GetFileName ()
 If message is associated with an attached file, get the filename.
 
- Public Member Functions inherited from SwizzleObject
_.Library.Status OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
 This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Static Public Member Functions

_.Library.Integer HToSeconds (_.Library.String h)
 Convert $h format to the number of seconds since 12/31/1840.
 
_.Library.String SecondsToH (_.Library.Integer seconds)
 Convert the specified number of seconds since 12/31/1840 to $h format.
 
- Static Public Member Functions inherited from SerialObject
_.Library.String LogicalToOdbc (_.Library.String val)
 Converts the serial state of this serial object to a delimited string. More...
 
_.Library.String OdbcToLogical (_.Library.String val)
 Converts the value of an incoming delimited string to a serialized state. More...
 

Public Attributes

 Bcc
 Bcc for message, list of names to which message will be sent (SMTP) or was sent (POP3) More...
 
 Cc
 Cc for message, list of names to which message will be sent (SMTP) or was sent (POP3) More...
 
 Date
 The date/time that the message was retrieved as reported by POP3,. More...
 
 From
 Who the message is from. More...
 
 MessageSize
 The total length of the message. More...
 
 ReplyTo
 The Reply-To header field of the message. More...
 
 Sender
 Who actually sent the message. More...
 
 Subject
 Subject of message. More...
 
 To
 To for message, list of names to which message will be sent (SMTP) or was sent (POP3) More...
 
- Public Attributes inherited from MailMessagePart
 BinaryData
 binary data if message is BINARY and is NOT multipart More...
 
 Charset
 Then default is utf-8 on Unicode systems and the system default on 8-bit systems. More...
 
 ContentTransferEncoding
 Content-Transfer-Encoding header. More...
 
 ContentType
 Sets the Content-Type header. More...
 
 Dir
 directory for attachments More...
 
 FileName
 Filename if message is associated with attached file. More...
 
 Headers
 Array of header names and their values. More...
 
 InlineAttachment
 If Filename specified and InlineAttachment property is true, then attachment will have. More...
 
 Is7bit
 
 IsAlternative
 
 IsBase64
 
 IsBinary
 If message is NOT multipart, this indicates whether message has text or binary data. More...
 
 IsHTML
 if message is NOT multipart and is text, this indicates whether message is in HTML format More...
 
 IsMultiPart
 If set, this message part (which may be the entire message) is made up out of parts. More...
 
 MultiPartType
 Type of MultiPart to declare, e.g. More...
 
 Parts
 If IsMultiPart=1 (true), Parts is an array of the parts of a multipart messsage. More...
 
 TextData
 text data if message is NOT binary and is NOT multipart More...
 

Additional Inherited Members

- Static Public Attributes inherited from SerialObject
 ODBCDELIMITER = None
 A serial object is converted to a delimited string containing the. More...
 
 SERIALDELIMITER = None
 This parameter specifies the delimiter character used when created a serialized. More...
 
 VALIDIFNULL = None
 If true, ValidateObject will return $$$OK for instances that are null as determined by IsNull(). More...
 
- Static Public Attributes inherited from SwizzleObject
 DEFAULTCONCURRENCY = None
 DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...
 
 JOURNALSTREAM = None
 If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...
 
 OBJJOURNAL = None
 if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

For information on using this class, see Sending and Receiving Email.

Send an SMTP mail message or receive a MIME message using POP3.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self)

If message is NOT multipart, this indicates whether message to be sent.

will be treated as a 7bit message that does not need encoding. All body text must already be 7bit data and all lines must < 998 bytes in lenght.
When sending the message and IsBase64=1, then Is7bit is ignored. Is7bit is deprecated. Use ContentTransferEncoding.  

The IsAlternative property is only meaningful for multipart messages (IsMultiPart=1).

If IsAlternative=1, then Content-Type: multipart/alternative, otherwise Content-Type: multipart/mixed. IsAlternative is deprecated. Use MultiPartType  

If message is NOT multipart, this indicates whether message to be sent

will be encoded as Base64 or quoted-printable.
When sending the message and Is7bit="", the encoding (IsBase64) defaults to 1 if IsBinary, else to 0. IsBase64 is deprecated. Use ContentTransferEncoding.  

Reimplemented from MailMessagePart.

Member Function Documentation

◆ GetLocalDateTime()

_.Library.String GetLocalDateTime ( )

Return the date/time that the message was retrieved converted to.

local time in $H format. An empty string is returned if the date format is invalid.

◆ GetUTCDateTime()

_.Library.String GetUTCDateTime ( )

Return the date/time that the message was retrieved converted to.

UTC in $H format. An empty string is returned if the date format is invalid.

◆ GetUTCSeconds()

_.Library.Integer GetUTCSeconds ( )

Return the date/time that the message was retrieved converted to.

UTC in seconds since 12/31/1840.
An empty string is returned if the date format is invalid.

Member Data Documentation

◆ Bcc

Bcc

Bcc for message, list of names to which message will be sent (SMTP) or was sent (POP3)

 

◆ Cc

Cc

Cc for message, list of names to which message will be sent (SMTP) or was sent (POP3)

 

◆ Date

Date

The date/time that the message was retrieved as reported by POP3,.

or date/time to be included in the message sent via Net.SMTP. If Date is not specified, then Net.SMTP will set it to the current date and time.  

◆ From

From

Who the message is from.

 

◆ MessageSize

MessageSize

The total length of the message.

The MessageSize property is not set for attached emails.  

◆ ReplyTo

ReplyTo

The Reply-To header field of the message.

 

◆ Sender

Sender

Who actually sent the message.

 

◆ Subject

Subject

Subject of message.

 

◆ To

To

To for message, list of names to which message will be sent (SMTP) or was sent (POP3)