Xqsmapi API
メール送受信機能を持った DLL
メソッド
xqsInitialize
Xqsmapi クラスを初期化します。
int WINAPI xqsInitialize(
LPCSTR pop3name,
LPCSTR smtpname,
LPCSTR username,
LPCSTR password,
LPCSTR mailaddr,
LPCSTR fullname )
引数
pop3name POP3サーバ名
smtpname SMTPサーバ名
username POP3 ユーザ名
password POP3 パスワード
mailaddr メールアドレス 例. masuda@sec.co.jp
fullname フルネーム 例. 稀Jr
戻り値
0 以外 成功
0 失敗
解説
xqsmapi クラスの初期化を行います。メールアドレスは、SMTP サーバの ドメイン認証で使っています。メールアドレス、フルネームは、フルネーム<メールアドレス> の形式で From フィールドとして送信されます。
xqsSendMailOne
メールを送信します。
int WINAPI xqsSendMailOne(
LPCSTR pmailfile,
LPCSTR attachfile )
引数
pmailfile 送信メールファイル
attachfile 添付ファイル
戻り値
0 以外 送信成功
0 送信失敗
解説
メールファイルを指定して送信します。
POP_BEFORE_SMTP プロパティを True にした時は、送信時に POP3 サーバ認証を行ってから送信します。
xqsRecvMailAll
すべてのメールを受信します。
int WINAPI xqsRecvMailAll(
LPCSTR plistfile,
LPCSTR pmaildir,
LPCSTR pdupfile,
LPCSTR pmailbox )
引数
plistfile 受信したリストファイル
pmaildir 受信フォルダ名
pdupfile 重複チェックファイル
pmailbox 一括受信ファイル
戻り値
0 受信メール無し
1 以上 受信メール数
-1 以下 エラー発生
解説
すべてのメールを受信します。受信中には経過ダイアログを表示しキャンセルボタンを押下することによって中止が可能です。受信メールはデフォルトで SJIS に変換し、From, Subject, Cc に日本語がある場合はエンコードされます。一括受信ファイルを指定した場合、このファイルに受信したメールを追加していきます。
xqsSendMailDummy
送信テスト用のメソッドです。
int WINAPI xqsSendMailDummy(
LPCSTR pmailfile,
LPCSTR attachfile,
LPCSTR dummyfile )
引数
pmailfile 送信メールファイル
attachfile 添付ファイル
dummyfile SMTP 送信メールファイル
戻り値
0 以外 送信成功
0 送信失敗
解説
メールファイルを指定して送信テストを行います。内部動作は xqsSendMailOne と全く同じです。ただし、実際に SMTP サーバに送信する代わりに dummyfile に送信ファイルを書き出します。
xqsRecvMailDummy
受信テスト用のメソッドです。
int WINAPI xqsRecvMailDummy(
LPCSTR pmailfile,
LPCSTR dummyfile )
引数
pmailfile 受信テスト用のファイル
dummyfile エンコード済みのファイル
戻り値
0 受信メール無し
1 以上 受信メール数
-1 以下 エラー発生
解説
メールファイルを指定して受信テストを行います。内部動作は xqsRecvMailAll と全く同じです。ただし、実際に POP3 サーバから受信する代わりに、受信テスト用ファイルを渡し、エンコードされたファイルを取り出します。主にテスト用に使います。
xqsMailBiff
POP3 サーバの受信チェックをします。
int WINAPI xqsMailBiff(void)
引数
なし
戻り値
0 受信メール無し
1 以上 受信メール数
解説
POP サーバの受信チェックをします。サーバに残っているメールの数を返します。ただし、重複チェックをしていないので、サーバにメールを残す（DELE プロパティ参照）場合でも新着数を返します。
xqsDialogAttach
添付ファイル取り出しのダイアログを開きます。
int WINAPI xqsDialogAttach(LPCSTR pfilename)
引数
pfilename メールファイル
戻り値
1 成功
0 失敗
解説
受信したメールファイル（wmlファイル）を指定して、添付ファイルの取り出し用ダイアログを開きます。ダイアログのリストから、添付ファイル名を指定して保存します。
xqsVersion
Xqsmapi のバージョンを返します。
int WINAPI xqsVersion(
LPSTR lpReturnedString,
int nSize )
引数
lpReturnedString バージョン文字列を受け取るバッファ
nSize バッファサイズ
戻り値
バージョン
解説
xqsmapi dll のバージョン文字列／値を返します。バージョン文字列は "xqsmapi.dll ver.mj.mi.u1" ( mj メジャーバージョン、mi マイナーバージョン、u1 内部的なマイナーバージョン）。戻り値はメージャーバージョン×0x100＋マイナーバージョンになります。
xqsSetValueInt
INT 型プロパティを設定します。
int WINAPI xqsSetValueInt( LPCSTR name, int value )
引数
name プロパティ名
value 設定値
戻り値
設定した値
解説
INT 型プロパティを設定します。プロパティ名を参照してください。
xqsGetValueInt
INT 型プロパティを取得します。
int WINAPI xqsGetValueInt( LPCSTR name )
引数
name プロパティ名
戻り値
設定値
解説
INT 型プロパティを取得します。プロパティ名を参照してください。
xqsSetValueInt
STRING 型プロパティを設定します。
int WINAPI xqsSetValueStr( LPCSTR name, LPCSTR value )
引数
name プロパティ名
value 設定文字列
戻り値
なし
解説
STRING 型プロパティを設定します。プロパティ名を参照してください。
xqsGetValueStr
STRING 型プロパティを取得します。
int WINAPI xqsGetValueStr( LPCSTR name, LPSTR value, int len )
引数
name プロパティ名
value 取得バッファ
len 取得バッファ長さ
戻り値
なし
解説
STRING 型プロパティを取得します。プロパティ名を参照してください。