PureBasic

Explaining the Email FromName, FromAddress, and From Properties

See more Email Object Examples

This example explains the email object's FromName, FromAddress, and From properties. PureBasic

IncludeFile "CkEmail.pb"

Procedure ChilkatExample()

    ; The email's FROM name and address can be set in several ways.
    ; It can include an optional friendly name (which is just a description),
    ; and it must include an address.

    ; For example:
    email1.i = CkEmail::ckCreate()
    If email1.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkEmail::setCkSubject(email1, "test")
    CkEmail::setCkBody(email1, "test")

    CkEmail::setCkFromName(email1, "Joe Sample")
    CkEmail::setCkFromAddress(email1, "joe.sample@example.com")

    ; the From property contains both the FromName and FromAddress
    ; This produces the following output:
    ; From: "Joe Sample" <joe.sample@example.com>
    Debug "From: " + CkEmail::ckFrom(email1)
    Debug "--------------------------------------------------"

    ; Examine the MIME of the email:
    Debug CkEmail::ckGetMime(email1)
    Debug "--------------------------------------------------"

    ; Output is:

    ; 	MIME-Version: 1.0
    ; 	Date: Wed, 16 Nov 2016 12:32:13 -0600
    ; 	Message-ID: <02B461C6D12FA6686C3151A649ED8D5BBFBE0721@CHILKAT13>
    ; 	Content-Type: text/plain
    ; 	Content-Transfer-Encoding: 7bit
    ; 	X-Priority: 3 (Normal)
    ; 	Subject: test
    ; 	From: "Joe Sample" <joe.sample@example.com>
    ; 
    ; 	test

    ; --------------------------------------------
    ; Alternatively, the From property can be set, and this 
    ; implicitly sets the FromName and FromAddress properties.

    email2.i = CkEmail::ckCreate()
    If email2.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkEmail::setCkFrom(email2, "Joe Sample <joe.sample@example.com>")

    Debug "FromName: " + CkEmail::ckFromName(email2)
    Debug "FromAddress: " + CkEmail::ckFromAddress(email2)
    Debug "--------------------------------------------------"

    Debug CkEmail::ckGetMime(email2)


    CkEmail::ckDispose(email1)
    CkEmail::ckDispose(email2)


    ProcedureReturn
EndProcedure