@haxall/haxall
    Preparing search index...

    Class Email

    Email models a top level MIME message.

    See pod doc and examples.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • List of "bcc" email addresses. See MimeUtil.toAddrSpec for address formatting.

      Returns List<string>

    • List of "bcc" email addresses. See MimeUtil.toAddrSpec for address formatting.

      Parameters

      Returns void

    • Body of the email - typically an instance of TextPart or MultiPart.

      Returns EmailPart

    • Body of the email - typically an instance of TextPart or MultiPart.

      Parameters

      Returns void

    • List of "cc" email addresses. See MimeUtil.toAddrSpec for address formatting.

      Returns List<string>

    • List of "cc" email addresses. See MimeUtil.toAddrSpec for address formatting.

      Parameters

      Returns void

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that => 0
      this > that => >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3) => 1
      8.compare(8) => 0
      3 <=> 8 => -1 // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Encode as a MIME message according to RFC 822.

      Parameters

      Returns void

    • Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.

      Parameters

      Returns boolean

    • From email address. See MimeUtil.toAddrSpec for address formatting.

      Returns string

    • From email address. See MimeUtil.toAddrSpec for address formatting.

      Parameters

      • it: string

      Returns void

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • Unique identifier for message (auto-generated).

      Returns string

    • Unique identifier for message (auto-generated).

      Parameters

      • it: string

      Returns void

    • Return the aggregation of to, cc, and bcc.

      Returns List<string>

    • Reply-To email address.

      Returns string

    • Reply-To email address.

      Parameters

      • it: string

      Returns void

    • Subject of the email. This string can be any Unicode and is automatically translated into an encoded word.

      Returns string

    • Subject of the email. This string can be any Unicode and is automatically translated into an encoded word.

      Parameters

      • it: string

      Returns void

    • List of "to" email addresses. See MimeUtil.toAddrSpec for address formatting.

      Returns List<string>

    • List of "to" email addresses. See MimeUtil.toAddrSpec for address formatting.

      Parameters

      Returns void

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Return a string representation of this object.

      Returns string

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x() a.trap("x", null)
      a->x = b a.trap("x", [b])
      a->x(b) a.trap("x", [b])
      a->x(b, c) a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • Validate this email message - throw Err if not configured correctly.

      Returns void

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void

    • Parameters

      • ...args: unknown[]

      Returns Email