外观
lib-finMail 库参考
原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793357944/FIN+5.3.1+lib-finMail 中文整理基于 FIN 5.3.1
导读： FIN 电子邮件客户端扩展
以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。
目录（导读）
- lib
- meta
- tags
- funcs
- def
- supertypes
- finMailPing(conn)
概述（中译）
FIN 电子邮件客户端扩展
API 正文（英文）
tags
| finMailBody | Present if the email body is bigger than 1024 chars, it stores to body as Bin |
| finMailConn | Marker tag for finMail connection |
| finMailConnRef | Used on a proxy object to reference its parent finMailConn |
| finMailContent | The first 1024 characters of the email content (body) |
| finMailDEBUG | Marker tag to set the mail connection in debug mode |
| finMailFrom | Comma separated list of From addresses |
| finMailMaxMsgCount | Set the maximum numbers of email records this connector can store |
| finMailNewMessages | Shows the number of unread email |
| finMailPollFreq | Applied to finMailConn to tune the duration between email checks |
| finMailRec | Marker tag for an email message record |
| finMailReplyTo | Comma separated list of Reply To addresses |
| finMailSSL | Marker tag to set the connection to use SSL |
| finMailSentDate | The email Sent date |
| finMailSubject | The email Subject |
| finMailTo | Comma separated list of To addresses |
| finMailTotalMessages | Shows the number of email on the inbox folder |
funcs
| finMailPing | Asynchronously ping an finMail connector Examples |
def
finMailBody
Present if the email body is bigger than 1024 chars, it stores to body as Bin. Missing otherwise
meta
| def | finMailBody |
| is | xstr |
| lib | lib:finMail |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| xstr | Extended string - type name and string value encoding |
def
finMailConn
Marker tag for finMail connection.
meta
| def | finMailConn |
| is | marker |
| lib | lib:finMail |
supertypes
| marker | Marker labels a dict with typing information |
def
finMailConnRef
Used on a proxy object to reference its parent finMailConn
meta
| def | finMailConnRef |
| is | ref |
| lib | lib:finMail |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| ref | Reference to an entity |
def
finMailContent
The first 1024 characters of the email content (body)
meta
| def | finMailContent |
| is | str |
| lib | lib:finMail |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
finMailDEBUG
Marker tag to set the mail connection in debug mode.
meta
| def | finMailDEBUG |
| is | marker |
| lib | lib:finMail |
supertypes
| marker | Marker labels a dict with typing information |
def
finMailFrom
Comma separated list of From addresses
meta
| def | finMailFrom |
| is | str |
| lib | lib:finMail |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
finMailMaxMsgCount
Set the maximum numbers of email records this connector can store
meta
| def | finMailMaxMsgCount |
| is | number |
| lib | lib:finMail |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| number | Integer or floating point numbers annotated with an optional unit |
def
finMailNewMessages
Shows the number of unread email
meta
| def | finMailNewMessages |
| is | number |
| lib | lib:finMail |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| number | Integer or floating point numbers annotated with an optional unit |
def
finMailPollFreq
Applied to finMailConn to tune the duration between email checks. If not configured it defaults to 1min.
meta
| def | finMailPollFreq |
| is | number |
| lib | lib:finMail |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| number | Integer or floating point numbers annotated with an optional unit |
def
finMailRec
Marker tag for an email message record.
meta
| def | finMailRec |
| is | marker |
| lib | lib:finMail |
supertypes
| marker | Marker labels a dict with typing information |
def
finMailReplyTo
Comma separated list of Reply To addresses
meta
| def | finMailReplyTo |
| is | str |
| lib | lib:finMail |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
finMailSSL
Marker tag to set the connection to use SSL.
meta
| def | finMailSSL |
| is | marker |
| lib | lib:finMail |
supertypes
| marker | Marker labels a dict with typing information |
def
finMailSentDate
The email Sent date
meta
| def | finMailSentDate |
| is | dateTime |
| lib | lib:finMail |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| dateTime | ISO 8601 timestamp followed by timezone identifier |
def
finMailSubject
The email Subject
meta
| def | finMailSubject |
| is | str |
| lib | lib:finMail |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
finMailTo
Comma separated list of To addresses
meta
| def | finMailTo |
| is | str |
| lib | lib:finMail |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
finMailTotalMessages
Shows the number of email on the inbox folder
meta
| def | finMailTotalMessages |
| is | number |
| lib | lib:finMail |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| number | Integer or floating point numbers annotated with an optional unit |
def
func:finMailPing
finMailPing(conn)
Asynchronously ping an finMail connector Examples:
read(finMail).finMailPing
finMailPing(finMail)Side effects:
- performs async network IO on background thread
- emailServerName: updated if ping successful
- emailProtocolName: updated if ping successful
meta
| admin | ✓ |
| def | func:finMailPing |
| is | func |
| lib | lib:finMail |
| name | finMailPing |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |