Overview | Index by: file name | procedure name | procedure call | annotation

email.tcl Annotations

Created from source/email.tcl
Defines a procedure for sending (SMTP) and receiving (POP3) emails .

Procedure Summary
popClose { popsock }
          Close an open connection with a POP3
popCount { popsock }
          Return the number of new/unread emails in the
popDelete { popsock index }
          Delete an email from the POP3
popOpen { server port username password }
          Open a connection with a POP3
popRead { popsock }
          Retrieve all new emails via
smtpSend { sender recipients subject body server port {username {}} {password {}} }
          Send an email via

Procedure Detail

popClose

proc popClose { popsock }
Close an open connection with a POP3 Server.
Parameters:
popsock - An open POP3 socket as returned by the popOpen command. @error
Defined in:
email.tcl, line 86

popCount

proc popCount { popsock }
Return the number of new/unread emails in the mailbox.
Parameters:
popsock - An open POP3 socket as returned by the popOpen command.
Returns:
The number of new emails, and the total size of the emails.
Defined in:
email.tcl, line 117

popDelete

proc popDelete { popsock index }
Delete an email from the POP3 inbox.
Parameters:
popsock - An open POP3 socket as returned by the popOpen command.
index - The index of the email to delete. @error
Defined in:
email.tcl, line 95

popOpen

proc popOpen { server port username password }
Open a connection with a POP3 Server.
Parameters:
server - POP3 Server hostname or IP address.
username - Account name.
password - Password.
Returns:
A POP3 socket, that can be used with popRead popCount popDelete commands. @error
Defined in:
email.tcl, line 78

popRead

proc popRead { popsock }
Retrieve all new emails via POP3.
Parameters:
popsock - An open POP3 socket as returned by the popOpen command.
Returns:
The list of new messages. @error
Defined in:
email.tcl, line 104

smtpSend

proc smtpSend { sender recipients subject body server port {username {}} {password {}} }
Send an email via SMTP.
Parameters:
sender - Self-documenting.
recipients - A list. Self-documenting.
subject - Self-documenting.
body - Self-documenting.
server - Self-documenting.
username - Optional. Self-documenting.
password - Optional. Self-documenting.
port - Self-documenting.
Returns:
Nothing on success. Otherwise an error is generated. @error From timeout or protocol error.
Defined in:
email.tcl, line 41

Overview | Index by: file name | procedure name | procedure call | annotation
File generated 2010-03-13 at 22:28.