Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-01-03 17:39:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

Re-extracted class docs.

Browse Source
This commit is contained in:
Relintai 2024-01-11 00:03:31 +01:00
parent 92f1ab9e3e
commit db36151c18
2 changed files with 199 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

153
modules/smtp/doc_classes/EMail.xml
View File

@ -7,7 +7,160 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="add_cc">
<return type="void" />
<argument index="0" name="address" type="String" />
<argument index="1" name="personal" type="String" />
<description>
</description>
</method>
<method name="add_recipient">
<return type="void" />
<argument index="0" name="address" type="String" />
<argument index="1" name="personal" type="String" />
<description>
</description>
</method>
<method name="get_cc_address" qualifiers="const">
<return type="String" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="get_cc_count" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="get_cc_data_string">
<return type="String" />
<description>
</description>
</method>
<method name="get_cc_personal" qualifiers="const">
<return type="String" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="get_ccs">
<return type="Array" />
<description>
</description>
</method>
<method name="get_email_data_string">
<return type="String" />
<argument index="0" name="email_default_sender_name" type="String" />
<argument index="1" name="email_default_sender_email" type="String" />
<description>
</description>
</method>
<method name="get_recipient_address" qualifiers="const">
<return type="String" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="get_recipient_count" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="get_recipient_personal" qualifiers="const">
<return type="String" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="get_recipients">
<return type="Array" />
<description>
</description>
</method>
<method name="get_sender_address" qualifiers="const">
<return type="String" />
<description>
</description>
</method>
<method name="get_to_data_string">
<return type="String" />
<description>
</description>
</method>
<method name="remove_cc">
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="remove_recipient">
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="set_cc_address">
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="val" type="String" />
<description>
</description>
</method>
<method name="set_cc_personal">
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="val" type="String" />
<description>
</description>
</method>
<method name="set_ccs">
<return type="void" />
<argument index="0" name="ccs" type="Array" />
<description>
</description>
</method>
<method name="set_recipient_address">
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="val" type="String" />
<description>
</description>
</method>
<method name="set_recipient_personal">
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="val" type="String" />
<description>
</description>
</method>
<method name="set_recipients">
<return type="void" />
<argument index="0" name="recipients" type="Array" />
<description>
</description>
</method>
<method name="set_sender">
<return type="void" />
<argument index="0" name="address" type="String" />
<argument index="1" name="personal" type="String" />
<description>
</description>
</method>
<method name="set_sender_address">
<return type="void" />
<argument index="0" name="val" type="String" />
<description>
</description>
</method>
</methods> </methods>
<members>
<member name="body" type="String" setter="set_body" getter="get_body" default="&quot;&quot;">
</member>
<member name="sender_personal" type="String" setter="set_sender_personal" getter="get_sender_personal" default="&quot;&quot;">
</member>
<member name="subject" type="String" setter="set_subject" getter="get_subject" default="&quot;&quot;">
</member>
</members>
<constants> <constants>
</constants> </constants>
</class> </class>

46
modules/smtp/doc_classes/SMTPClient.xml
View File

@ -7,7 +7,53 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="send_email">
<return type="void" />
<argument index="0" name="email" type="EMail" />
<description>
</description>
</method>
</methods> </methods>
<members>
<member name="client_id" type="String" setter="set_client_id" getter="get_client_id" default="&quot;smtp.pandemoniumengine.org&quot;">
</member>
<member name="email_default_sender_email" type="String" setter="set_email_default_sender_email" getter="get_email_default_sender_email" default="&quot;&quot;">
</member>
<member name="email_default_sender_name" type="String" setter="set_email_default_sender_name" getter="get_email_default_sender_name" default="&quot;&quot;">
</member>
<member name="host" type="String" setter="set_host" getter="get_host" default="&quot;&quot;">
</member>
<member name="port" type="int" setter="set_port" getter="get_port" default="465">
</member>
<member name="server_auth_method" type="int" setter="set_server_auth_method" getter="get_server_auth_method" enum="SMTPClient.ServerAuthMethod" default="1">
</member>
<member name="server_auth_password" type="String" setter="set_server_auth_password" getter="get_server_auth_password" default="&quot;&quot;">
</member>
<member name="server_auth_username" type="String" setter="set_server_auth_username" getter="get_server_auth_username" default="&quot;&quot;">
</member>
<member name="thread_sleep_usec" type="int" setter="set_thread_sleep_usec" getter="get_thread_sleep_usec" default="10000">
</member>
<member name="tls_method" type="int" setter="set_tls_method" getter="get_tls_method" enum="SMTPClient.TLSMethod" default="2">
</member>
<member name="use_threads" type="bool" setter="set_use_threads" getter="get_use_threads" default="true">
</member>
</members>
<signals>
<signal name="email_sent">
<description>
</description>
</signal>
<signal name="error">
<argument index="0" name="error" type="Dictionary" />
<description>
</description>
</signal>
<signal name="result">
<argument index="0" name="content" type="Dictionary" />
<description>
</description>
</signal>
</signals>
<constants> <constants>
</constants> </constants>
</class> </class>